Trendsic Platform Service

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/public/pickup/{SchedulerUrl}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPickupBookResponse:
    code: Optional[str] = None
    fare: Decimal = decimal.Decimal(0)
    zone: Optional[str] = None
    bags: int = 0
    pay_mode: Optional[str] = None
    pay_line: Optional[str] = None
    track_url: Optional[str] = None
    book_token: Optional[str] = None
    client_secret: Optional[str] = None
    publishable_key: Optional[str] = None
    delivery: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPickupBookRequest:
    scheduler_url: Optional[str] = None
    address: Optional[str] = None
    unit: Optional[str] = None
    city: Optional[str] = None
    zip: Optional[str] = None
    zone: Optional[str] = None
    bags: int = 0
    needs: List[str] = field(default_factory=list)
    note: Optional[str] = None
    customer_name: Optional[str] = None
    customer_phone: Optional[str] = None
    pay_mode: Optional[str] = None
    account_code: Optional[str] = None
    turnstile_token: Optional[str] = None

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