Trendsic Platform Service

<back to all web services

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
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 DispatchPickupBookResponse() = 
        member val Code:String = null with get,set
        member val Fare:Decimal = new Decimal() with get,set
        member val Zone:String = null with get,set
        member val Bags:Int32 = new Int32() with get,set
        member val PayMode:String = null with get,set
        member val PayLine:String = null with get,set
        member val TrackUrl:String = null with get,set
        member val BookToken:String = null with get,set
        member val ClientSecret:String = null with get,set
        member val PublishableKey:String = null with get,set
        member val Delivery:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchPickupBookRequest() = 
        member val SchedulerUrl:String = null with get,set
        member val Address:String = null with get,set
        member val Unit:String = null with get,set
        member val City:String = null with get,set
        member val Zip:String = null with get,set
        member val Zone:String = null with get,set
        member val Bags:Int32 = new Int32() with get,set
        member val Needs:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Note:String = null with get,set
        member val CustomerName:String = null with get,set
        member val CustomerPhone:String = null with get,set
        member val PayMode:String = null with get,set
        member val AccountCode:String = null with get,set
        member val TurnstileToken:String = null with get,set

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

POST /v1/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchPickupBookRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AccountCode>String</AccountCode>
  <Address>String</Address>
  <Bags>0</Bags>
  <City>String</City>
  <CustomerName>String</CustomerName>
  <CustomerPhone>String</CustomerPhone>
  <Needs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Needs>
  <Note>String</Note>
  <PayMode>String</PayMode>
  <SchedulerUrl>String</SchedulerUrl>
  <TurnstileToken>String</TurnstileToken>
  <Unit>String</Unit>
  <Zip>String</Zip>
  <Zone>String</Zone>
</DispatchPickupBookRequest>

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

<DispatchPickupBookResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Bags>0</Bags>
  <BookToken>String</BookToken>
  <ClientSecret>String</ClientSecret>
  <Code>String</Code>
  <Delivery>String</Delivery>
  <Fare>0</Fare>
  <PayLine>String</PayLine>
  <PayMode>String</PayMode>
  <PublishableKey>String</PublishableKey>
  <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>
  <TrackUrl>String</TrackUrl>
  <Zone>String</Zone>
</DispatchPickupBookResponse>