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 .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 /portal/{Token}/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<PortalVisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Photos>
    <CustomerVisitPhoto>
      <AgreementJobID>0</AgreementJobID>
      <DocTitle>String</DocTitle>
      <MimeType>String</MimeType>
      <ProjectLocationAttachmentID>0</ProjectLocationAttachmentID>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
    </CustomerVisitPhoto>
  </Photos>
  <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>
  <Visits>
    <CustomerVisit>
      <AgreementJobID>0</AgreementJobID>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <CrewNotes>String</CrewNotes>
      <ServiceName>String</ServiceName>
      <VisitDate>0001-01-01T00:00:00</VisitDate>
    </CustomerVisit>
  </Visits>
</PortalVisitsResponse>