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

export class BranchApptContact
{
    public ContactId: number;
    public ContactGuid: string;
    public Name: string;
    public Phone: string;
    public Email: string;
    public PastVisits: number;
    public LastVisitLocal?: string;
    public NextLocal?: string;
    public PhoneMatch: boolean;
    public EmailMatch: boolean;

    public constructor(init?: Partial<BranchApptContact>) { (Object as any).assign(this, init); }
}

export class BranchApptContactsResponse
{
    public ResponseStatus: ResponseStatus;
    public Contacts: BranchApptContact[] = [];
    public Duplicate: BranchApptContact;

    public constructor(init?: Partial<BranchApptContactsResponse>) { (Object as any).assign(this, init); }
}

export class BranchApptContactsRequest
{
    public LocationId: string;
    public Q: string;
    public Phone: string;
    public Email: string;

    public constructor(init?: Partial<BranchApptContactsRequest>) { (Object as any).assign(this, init); }
}

TypeScript BranchApptContactsRequest DTOs

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

HTTP + 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>