Trendsic Platform Service

<back to all web services

VisitBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/board
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 VisitCard() = 
        member val VisitKey:String = null with get,set
        member val JobID:Int32 = new Int32() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val ProjectUID:String = null with get,set
        member val AgreementJobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ScheduledDate:String = null with get,set
        member val CustomerName:String = null with get,set
        member val JobName:String = null with get,set
        member val LocationName:String = null with get,set
        member val City:String = null with get,set
        member val Zip:String = null with get,set
        member val Lat:Nullable<Double> = new Nullable<Double>() with get,set
        member val Lng:Nullable<Double> = new Nullable<Double>() with get,set
        member val CrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CrewName:String = null with get,set
        member val SortOrder:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val DurationMinutes:Int32 = new Int32() with get,set
        member val EtaWindow:String = null with get,set
        member val IsCommercial:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CrewColumn() = 
        member val CrewID:Int32 = new Int32() with get,set
        member val CrewName:String = null with get,set
        member val CrewColor:String = null with get,set
        member val MemberCount:Int32 = new Int32() with get,set
        member val Visits:ResizeArray<VisitCard> = new ResizeArray<VisitCard>() with get,set
        member val DriveMiles:Double = new Double() with get,set
        member val DriveMinutes:Int32 = new Int32() with get,set
        member val OnSiteMinutes:Int32 = new Int32() with get,set
        member val BillablePct:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BoardReadiness() = 
        member val TotalVisits:Int32 = new Int32() with get,set
        member val Assigned:Int32 = new Int32() with get,set
        member val Unassigned:Int32 = new Int32() with get,set
        member val Conflicts:Int32 = new Int32() with get,set
        member val AssignedPct:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type VisitBoardResponse() = 
        member val Date:String = null with get,set
        member val Crews:ResizeArray<CrewColumn> = new ResizeArray<CrewColumn>() with get,set
        member val Unassigned:ResizeArray<VisitCard> = new ResizeArray<VisitCard>() with get,set
        member val Readiness:BoardReadiness = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type VisitBoardRequest() = 
        member val Date:String = null with get,set

F# VisitBoardRequest 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/visits/board HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<VisitBoardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Crews>
    <CrewColumn>
      <BillablePct>0</BillablePct>
      <CrewColor>String</CrewColor>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
      <DriveMiles>0</DriveMiles>
      <DriveMinutes>0</DriveMinutes>
      <MemberCount>0</MemberCount>
      <OnSiteMinutes>0</OnSiteMinutes>
      <Visits>
        <VisitCard>
          <AgreementJobID>0</AgreementJobID>
          <City>String</City>
          <CrewID>0</CrewID>
          <CrewName>String</CrewName>
          <CustomerName>String</CustomerName>
          <DurationMinutes>0</DurationMinutes>
          <EtaWindow>String</EtaWindow>
          <IsCommercial>false</IsCommercial>
          <JobID>0</JobID>
          <JobName>String</JobName>
          <Lat>0</Lat>
          <Lng>0</Lng>
          <LocationName>String</LocationName>
          <ProjectID>0</ProjectID>
          <ProjectUID>String</ProjectUID>
          <ScheduledDate>String</ScheduledDate>
          <SortOrder>0</SortOrder>
          <Status>String</Status>
          <VisitKey>String</VisitKey>
          <Zip>String</Zip>
        </VisitCard>
      </Visits>
    </CrewColumn>
  </Crews>
  <Date>String</Date>
  <Readiness>
    <Assigned>0</Assigned>
    <AssignedPct>0</AssignedPct>
    <Conflicts>0</Conflicts>
    <TotalVisits>0</TotalVisits>
    <Unassigned>0</Unassigned>
  </Readiness>
  <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>
  <Unassigned>
    <VisitCard>
      <AgreementJobID>0</AgreementJobID>
      <City>String</City>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
      <CustomerName>String</CustomerName>
      <DurationMinutes>0</DurationMinutes>
      <EtaWindow>String</EtaWindow>
      <IsCommercial>false</IsCommercial>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <Lat>0</Lat>
      <Lng>0</Lng>
      <LocationName>String</LocationName>
      <ProjectID>0</ProjectID>
      <ProjectUID>String</ProjectUID>
      <ScheduledDate>String</ScheduledDate>
      <SortOrder>0</SortOrder>
      <Status>String</Status>
      <VisitKey>String</VisitKey>
      <Zip>String</Zip>
    </VisitCard>
  </Unassigned>
</VisitBoardResponse>