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 .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","NextLocal":"0001-01-01T00:00:00.0000000","PhoneMatch":false,"EmailMatch":false}],"Duplicate":{"ContactId":0,"ContactGuid":"00000000000000000000000000000000","Name":"String","Phone":"String","Email":"String","PastVisits":0,"LastVisitLocal":"0001-01-01T00:00:00.0000000","NextLocal":"0001-01-01T00:00:00.0000000","PhoneMatch":false,"EmailMatch":false}}