HostedSuite

<back to all web services

MyContactsRequest

Retrieves list of contacts associated with specified contact

The following routes are available for this service:
POST/api/contacts/my-contacts
MyContactsRequest Parameters:
NameParameterData TypeRequiredDescription
ContactIdbodystringNoThe ID of the contact whose associates you want to retrieve
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contacts/my-contacts HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactId: String,
	CustomerName: String,
	UserName: String,
	Password: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Id: String,
		DateLastModified: String,
		ClientName: String,
		ClientId: String,
		CenterId: String,
		CenterName: String,
		FirstName: String,
		LastName: String,
		Alert: String,
		Name: String,
		Status: String,
		Location: String,
		LongDistanceCode: String,
		CallInstructions: String,
		Information: String,
		MoreInformation: String,
		Title: String,
		UserName: String,
		UserGroupId: String,
		LoginMustChangePasswordAtNextLogin: False,
		GreetingOverride: String,
		Keywords: 
		[
			String
		],
		Address: 
		{
			Street1: String,
			Street2: String,
			City: String,
			State: String,
			PostalCode: String,
			Country: String
		},
		PhoneNumbers: 
		[
			{
				Id: String,
				Name: String,
				Number: String,
				DialingRuleId: String,
				Mobile: False,
				TransferTypes: Both
			}
		],
		EmailAddresses: 
		[
			{
				Id: String,
				Address: String,
				Name: String,
				IncludeInNotifications: False,
				Type: To
			}
		],
		CustomFields: 
		[
			{
				Name: String,
				Value: String
			}
		],
		Links: 
		[
			{
				Id: String,
				Name: String,
				Url: String
			}
		],
		Categories: 
		[
			{
				Id: String,
				Name: String
			}
		],
		ThirdPartyAccountId: String,
		SortPositionInConsole: 0,
		HideInConsole: False
	}
]