Trendsic Platform Service

<back to all web services

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DispatchPickupBookRequest
            Public Overridable Property SchedulerUrl As String
            Public Overridable Property Address As String
            Public Overridable Property Unit As String
            Public Overridable Property City As String
            Public Overridable Property Zip As String
            Public Overridable Property Zone As String
            Public Overridable Property Bags As Integer
            Public Overridable Property Needs As List(Of String) = New List(Of String)
            Public Overridable Property Note As String
            Public Overridable Property CustomerName As String
            Public Overridable Property CustomerPhone As String
            Public Overridable Property PayMode As String
            Public Overridable Property AccountCode As String
            Public Overridable Property TurnstileToken As String
        End Class

        Public Partial Class DispatchPickupBookResponse
            Public Overridable Property Code As String
            Public Overridable Property Fare As Decimal
            Public Overridable Property Zone As String
            Public Overridable Property Bags As Integer
            Public Overridable Property PayMode As String
            Public Overridable Property PayLine As String
            Public Overridable Property TrackUrl As String
            Public Overridable Property BookToken As String
            Public Overridable Property ClientSecret As String
            Public Overridable Property PublishableKey As String
            Public Overridable Property Delivery As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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>