Trendsic Platform Service

CourierBookPageRequest

The following routes are available for this service:
GET,OPTIONS	/v1/book/{Slug}


export class CourierTrackBusiness
{
    public Name: string;
    public Phone: string;

    public constructor(init?: Partial<CourierTrackBusiness>) { (Object as any).assign(this, init); }
}

export class CourierBookLevel
{
    public Code: string;
    public Name: string;
    public Ready: string;
    public WithinMin: number;
    public InBy: string;
    public Surcharge: number;
    public Days: number[] = [];
    public DeadlineMin?: number;

    public constructor(init?: Partial<CourierBookLevel>) { (Object as any).assign(this, init); }
}

export class HandoffOptions
{
    public Hand: boolean;
    public Porch: boolean;
    public Desk: boolean;
    public SigRequired: boolean;
    public IdRequired: boolean;
    public CodeRequired: boolean;

    public constructor(init?: Partial<HandoffOptions>) { (Object as any).assign(this, init); }
}

export class CourierBookProfile
{
    public Code: string;
    public Name: string;
    public Shape: string;
    public Template: string;
    public UnitOne: string;
    public UnitMany: string;
    public UnitOneEs: string;
    public UnitManyEs: string;
    public FacilityNoun: string;
    public FacilityNounEs: string;
    public FacilityName: string;
    public Levels: CourierBookLevel[] = [];
    public Asap: boolean;
    public Recurring: boolean;
    public PayTiming: string;
    public FinalAfterCount: boolean;
    public CancelFee: number;
    public MissedFee: number;
    public MissedWaitMin: number;
    public ServiceArea: string[] = [];
    public Zips: string[] = [];
    public Handoffs: HandoffOptions;

    public constructor(init?: Partial<CourierBookProfile>) { (Object as any).assign(this, init); }
}

export class CourierBookProfileLink
{
    public Code: string;
    public Name: string;
    public Shape: string;

    public constructor(init?: Partial<CourierBookProfileLink>) { (Object as any).assign(this, init); }
}

export class CourierBookPageView
{
    public Available: boolean;
    public BookingOn: boolean;
    public Business: CourierTrackBusiness;
    public Profile: CourierBookProfile;
    public Profiles: CourierBookProfileLink[] = [];
    public CardEnabled: boolean;
    public PublishableKey: string;
    public AppUrl: string;
    public Today: string;
    public Weekday: number;
    public NowMin: number;

    public constructor(init?: Partial<CourierBookPageView>) { (Object as any).assign(this, init); }
}

export class CourierBookPageResponse
{
    public Page: CourierBookPageView;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CourierBookPageResponse>) { (Object as any).assign(this, init); }
}

export class CourierBookPageRequest
{
    public Slug: string;
    public Profile: string;

    public constructor(init?: Partial<CourierBookPageRequest>) { (Object as any).assign(this, init); }
}

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