Trendsic Platform Service

<back to all web services

RoutePlanPropertyBookRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/routeplan/propertybook
"use strict";
export class RoutePlanPropertyRow {
    /** @param {{AgreementID?:number,Name?:string,Zip?:string,Area?:string,DurationMin?:number,Frequency?:string,ServiceType?:string,Acreage?:string,Dow?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Area;
    /** @type {number} */
    DurationMin;
    /** @type {string} */
    Frequency;
    /** @type {string} */
    ServiceType;
    /** @type {string} */
    Acreage;
    /** @type {number} */
    Dow;
}
export class RoutePlanPropertyBookResponse {
    /** @param {{Rows?:RoutePlanPropertyRow[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RoutePlanPropertyRow[]} */
    Rows = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class RoutePlanPropertyBookRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript RoutePlanPropertyBookRequest 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/routeplan/propertybook HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RoutePlanPropertyBookResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Rows>
    <RoutePlanPropertyRow>
      <Acreage>String</Acreage>
      <AgreementID>0</AgreementID>
      <Area>String</Area>
      <Dow>0</Dow>
      <DurationMin>0</DurationMin>
      <Frequency>String</Frequency>
      <Name>String</Name>
      <ServiceType>String</ServiceType>
      <Zip>String</Zip>
    </RoutePlanPropertyRow>
  </Rows>
</RoutePlanPropertyBookResponse>