Trendsic Platform Service

VisitBoardRequest

The following routes are available for this service:
GET,OPTIONS	/v1/visits/board


export class VisitCard
{
    public VisitKey: string;
    public JobID: number;
    public ProjectID: number;
    public ProjectUID: string;
    public AgreementJobID?: number;
    public ScheduledDate: string;
    public CustomerName: string;
    public JobName: string;
    public LocationName: string;
    public City: string;
    public Zip: string;
    public Lat?: number;
    public Lng?: number;
    public CrewID?: number;
    public CrewName: string;
    public SortOrder: number;
    public Status: string;
    public DurationMinutes: number;
    public EtaWindow: string;
    public IsCommercial: boolean;

    public constructor(init?: Partial<VisitCard>) { (Object as any).assign(this, init); }
}

export class CrewColumn
{
    public CrewID: number;
    public CrewName: string;
    public CrewColor: string;
    public MemberCount: number;
    public Visits: VisitCard[] = [];
    public DriveMiles: number;
    public DriveMinutes: number;
    public OnSiteMinutes: number;
    public BillablePct: number;

    public constructor(init?: Partial<CrewColumn>) { (Object as any).assign(this, init); }
}

export class BoardReadiness
{
    public TotalVisits: number;
    public Assigned: number;
    public Unassigned: number;
    public Conflicts: number;
    public AssignedPct: number;

    public constructor(init?: Partial<BoardReadiness>) { (Object as any).assign(this, init); }
}

export class VisitBoardResponse
{
    public Date: string;
    public Crews: CrewColumn[] = [];
    public Unassigned: VisitCard[] = [];
    public Readiness: BoardReadiness;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<VisitBoardResponse>) { (Object as any).assign(this, init); }
}

export class VisitBoardRequest
{
    public Date: string;

    public constructor(init?: Partial<VisitBoardRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>