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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}}