Trendsic Platform Service

<back to all web services

BranchApptContactsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/queue/appointments/contacts
BranchApptContactsRequest Parameters:
NameParameterData TypeRequiredDescription
LocationIdqueryGuidNo
QquerystringNo
PhonequerystringNo
EmailquerystringNo
BranchApptContactsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContactsformList<BranchApptContact>No
DuplicateformBranchApptContactNo
BranchApptContact Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
ContactGuidformGuidNo
NameformstringNo
PhoneformstringNo
EmailformstringNo
PastVisitsformintNo
LastVisitLocalformDateTime?No
NextLocalformDateTime?No
PhoneMatchformboolNo
EmailMatchformboolNo

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.

GET /v1/queue/appointments/contacts HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Contacts: 
	[
		{
			ContactId: 0,
			ContactGuid: 00000000000000000000000000000000,
			Name: String,
			Phone: String,
			Email: String,
			PastVisits: 0,
			LastVisitLocal: 0001-01-01,
			NextLocal: 0001-01-01,
			PhoneMatch: False,
			EmailMatch: False
		}
	],
	Duplicate: 
	{
		ContactId: 0,
		ContactGuid: 00000000000000000000000000000000,
		Name: String,
		Phone: String,
		Email: String,
		PastVisits: 0,
		LastVisitLocal: 0001-01-01,
		NextLocal: 0001-01-01,
		PhoneMatch: False,
		EmailMatch: False
	}
}