| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/queue/appointments/contacts |
|---|
"use strict";
export class BranchApptContact {
/** @param {{ContactId?:number,ContactGuid?:string,Name?:string,Phone?:string,Email?:string,PastVisits?:number,LastVisitLocal?:string,NextLocal?:string,PhoneMatch?:boolean,EmailMatch?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactId;
/** @type {string} */
ContactGuid;
/** @type {string} */
Name;
/** @type {string} */
Phone;
/** @type {string} */
Email;
/** @type {number} */
PastVisits;
/** @type {?string} */
LastVisitLocal;
/** @type {?string} */
NextLocal;
/** @type {boolean} */
PhoneMatch;
/** @type {boolean} */
EmailMatch;
}
export class BranchApptContactsResponse {
/** @param {{ResponseStatus?:ResponseStatus,Contacts?:BranchApptContact[],Duplicate?:BranchApptContact}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {BranchApptContact[]} */
Contacts = [];
/** @type {BranchApptContact} */
Duplicate;
}
export class BranchApptContactsRequest {
/** @param {{LocationId?:string,Q?:string,Phone?:string,Email?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
LocationId;
/** @type {string} */
Q;
/** @type {string} */
Phone;
/** @type {string} */
Email;
}
JavaScript BranchApptContactsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BranchApptContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Contacts>
<BranchApptContact>
<ContactGuid>00000000-0000-0000-0000-000000000000</ContactGuid>
<ContactId>0</ContactId>
<Email>String</Email>
<EmailMatch>false</EmailMatch>
<LastVisitLocal>0001-01-01T00:00:00</LastVisitLocal>
<Name>String</Name>
<NextLocal>0001-01-01T00:00:00</NextLocal>
<PastVisits>0</PastVisits>
<Phone>String</Phone>
<PhoneMatch>false</PhoneMatch>
</BranchApptContact>
</Contacts>
<Duplicate>
<ContactGuid>00000000-0000-0000-0000-000000000000</ContactGuid>
<ContactId>0</ContactId>
<Email>String</Email>
<EmailMatch>false</EmailMatch>
<LastVisitLocal>0001-01-01T00:00:00</LastVisitLocal>
<Name>String</Name>
<NextLocal>0001-01-01T00:00:00</NextLocal>
<PastVisits>0</PastVisits>
<Phone>String</Phone>
<PhoneMatch>false</PhoneMatch>
</Duplicate>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</BranchApptContactsResponse>