Trendsic Platform Service

<back to all web services

CourierBookPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}
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 CourierBookLevel
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Ready As String
            Public Overridable Property WithinMin As Integer
            Public Overridable Property InBy As String
            Public Overridable Property Surcharge As Decimal
            Public Overridable Property Days As List(Of Integer) = New List(Of Integer)
            Public Overridable Property DeadlineMin As Integer?
        End Class

        Public Partial Class CourierBookPageRequest
            Public Overridable Property Slug As String
            Public Overridable Property Profile As String
        End Class

        Public Partial Class CourierBookPageResponse
            Public Overridable Property Page As CourierBookPageView
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class CourierBookPageView
            Public Overridable Property Available As Boolean
            Public Overridable Property BookingOn As Boolean
            Public Overridable Property Business As CourierTrackBusiness
            Public Overridable Property Profile As CourierBookProfile
            Public Overridable Property Profiles As List(Of CourierBookProfileLink) = New List(Of CourierBookProfileLink)
            Public Overridable Property CardEnabled As Boolean
            Public Overridable Property PublishableKey As String
            Public Overridable Property AppUrl As String
            Public Overridable Property Today As String
            Public Overridable Property Weekday As Integer
            Public Overridable Property NowMin As Integer
        End Class

        Public Partial Class CourierBookProfile
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Shape As String
            Public Overridable Property Template As String
            Public Overridable Property UnitOne As String
            Public Overridable Property UnitMany As String
            Public Overridable Property UnitOneEs As String
            Public Overridable Property UnitManyEs As String
            Public Overridable Property FacilityNoun As String
            Public Overridable Property FacilityNounEs As String
            Public Overridable Property FacilityName As String
            Public Overridable Property Levels As List(Of CourierBookLevel) = New List(Of CourierBookLevel)
            Public Overridable Property Asap As Boolean
            Public Overridable Property Recurring As Boolean
            Public Overridable Property PayTiming As String
            Public Overridable Property FinalAfterCount As Boolean
            Public Overridable Property CancelFee As Decimal
            Public Overridable Property MissedFee As Decimal
            Public Overridable Property MissedWaitMin As Integer
            Public Overridable Property ServiceArea As List(Of String) = New List(Of String)
            Public Overridable Property Zips As List(Of String) = New List(Of String)
            Public Overridable Property Handoffs As HandoffOptions
        End Class

        Public Partial Class CourierBookProfileLink
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Shape As String
        End Class

        Public Partial Class CourierTrackBusiness
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
        End Class
    End Namespace
End Namespace

VB.NET CourierBookPageRequest 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/book/{Slug} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierBookPageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Page>
    <AppUrl>String</AppUrl>
    <Available>false</Available>
    <BookingOn>false</BookingOn>
    <Business>
      <Name>String</Name>
      <Phone>String</Phone>
    </Business>
    <CardEnabled>false</CardEnabled>
    <NowMin>0</NowMin>
    <Profile>
      <Asap>false</Asap>
      <CancelFee>0</CancelFee>
      <Code>String</Code>
      <FacilityName>String</FacilityName>
      <FacilityNoun>String</FacilityNoun>
      <FacilityNounEs>String</FacilityNounEs>
      <FinalAfterCount>false</FinalAfterCount>
      <Handoffs>
        <CodeRequired>false</CodeRequired>
        <Desk>false</Desk>
        <Hand>false</Hand>
        <IdRequired>false</IdRequired>
        <Porch>false</Porch>
        <SigRequired>false</SigRequired>
      </Handoffs>
      <Levels>
        <CourierBookLevel>
          <Code>String</Code>
          <Days xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </Days>
          <DeadlineMin>0</DeadlineMin>
          <InBy>String</InBy>
          <Name>String</Name>
          <Ready>String</Ready>
          <Surcharge>0</Surcharge>
          <WithinMin>0</WithinMin>
        </CourierBookLevel>
      </Levels>
      <MissedFee>0</MissedFee>
      <MissedWaitMin>0</MissedWaitMin>
      <Name>String</Name>
      <PayTiming>String</PayTiming>
      <Recurring>false</Recurring>
      <ServiceArea xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </ServiceArea>
      <Shape>String</Shape>
      <Template>String</Template>
      <UnitMany>String</UnitMany>
      <UnitManyEs>String</UnitManyEs>
      <UnitOne>String</UnitOne>
      <UnitOneEs>String</UnitOneEs>
      <Zips xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Zips>
    </Profile>
    <Profiles>
      <CourierBookProfileLink>
        <Code>String</Code>
        <Name>String</Name>
        <Shape>String</Shape>
      </CourierBookProfileLink>
    </Profiles>
    <PublishableKey>String</PublishableKey>
    <Today>String</Today>
    <Weekday>0</Weekday>
  </Page>
  <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>
</CourierBookPageResponse>