Trendsic Platform Service

<back to all web services

PortalVisitsRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/visits
"use strict";
export class CustomerVisit {
    /** @param {{AgreementJobID?:number,VisitDate?:string,CompletedAt?:string,ServiceName?:string,CrewNotes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementJobID;
    /** @type {?string} */
    VisitDate;
    /** @type {?string} */
    CompletedAt;
    /** @type {string} */
    ServiceName;
    /** @type {string} */
    CrewNotes;
}
export class CustomerVisitPhoto {
    /** @param {{ProjectLocationAttachmentID?:number,AgreementJobID?:number,DocTitle?:string,MimeType?:string,UploadDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectLocationAttachmentID;
    /** @type {?number} */
    AgreementJobID;
    /** @type {string} */
    DocTitle;
    /** @type {string} */
    MimeType;
    /** @type {?string} */
    UploadDate;
}
export class PortalVisitsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Visits?:CustomerVisit[],Photos?:CustomerVisitPhoto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CustomerVisit[]} */
    Visits = [];
    /** @type {CustomerVisitPhoto[]} */
    Photos = [];
}
export class PortalVisitsRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

JavaScript PortalVisitsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /portal/{Token}/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Visits":[{"AgreementJobID":0,"VisitDate":"0001-01-01T00:00:00.0000000","CompletedAt":"0001-01-01T00:00:00.0000000","ServiceName":"String","CrewNotes":"String"}],"Photos":[{"ProjectLocationAttachmentID":0,"AgreementJobID":0,"DocTitle":"String","MimeType":"String","UploadDate":"0001-01-01T00:00:00.0000000"}]}