Trendsic Platform Service

<back to all web services

VisitChecklistRequest

Requires Authentication
The following routes are available for this service:
GET/v1/visit/{AgreementJobID}/checklist
"use strict";
export class VisitChecklistItem {
    /** @param {{VisitChecklistItemID?:number,AgreementJobID?:number,ServiceTaskID?:number,Name?:string,Status?:number,Note?:string,QaResult?:string,AttachmentId?:number,CompletedBy?:string,CompletedAt?:string,SortOrder?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    VisitChecklistItemID;
    /** @type {number} */
    AgreementJobID;
    /** @type {?number} */
    ServiceTaskID;
    /** @type {string} */
    Name;
    /** @type {number} */
    Status;
    /** @type {string} */
    Note;
    /** @type {string} */
    QaResult;
    /** @type {?number} */
    AttachmentId;
    /** @type {string} */
    CompletedBy;
    /** @type {?string} */
    CompletedAt;
    /** @type {number} */
    SortOrder;
}
export class VisitChecklistResponse {
    /** @param {{Items?:VisitChecklistItem[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {VisitChecklistItem[]} */
    Items = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class VisitChecklistRequest {
    /** @param {{AgreementJobID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementJobID;
}

JavaScript VisitChecklistRequest 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/visit/{AgreementJobID}/checklist HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<VisitChecklistResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Items>
    <VisitChecklistItem>
      <AgreementJobID>0</AgreementJobID>
      <AttachmentId>0</AttachmentId>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <CompletedBy>String</CompletedBy>
      <Name>String</Name>
      <Note>String</Note>
      <QaResult>String</QaResult>
      <ServiceTaskID>0</ServiceTaskID>
      <SortOrder>0</SortOrder>
      <Status>0</Status>
      <VisitChecklistItemID>0</VisitChecklistItemID>
    </VisitChecklistItem>
  </Items>
  <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>
</VisitChecklistResponse>