Trendsic Platform Service

<back to all web services

VisitChecklistRequest

Requires Authentication
The following routes are available for this service:
GET/v1/visit/{AgreementJobID}/checklist
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type VisitChecklistItem() = 
        member val VisitChecklistItemID:Int32 = new Int32() with get,set
        member val AgreementJobID:Int32 = new Int32() with get,set
        member val ServiceTaskID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Name:String = null with get,set
        member val Status:Int32 = new Int32() with get,set
        member val Note:String = null with get,set
        member val QaResult:String = null with get,set
        member val AttachmentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CompletedBy:String = null with get,set
        member val CompletedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SortOrder:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type VisitChecklistResponse() = 
        member val Items:ResizeArray<VisitChecklistItem> = new ResizeArray<VisitChecklistItem>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type VisitChecklistRequest() = 
        member val AgreementJobID:Int32 = new Int32() with get,set

F# 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>