Trendsic Platform Service

<back to all web services

CourierBookPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CourierBookPageRequest
    {
        public String Slug = null;
        public String Profile = null;
        
        public String getSlug() { return Slug; }
        public CourierBookPageRequest setSlug(String value) { this.Slug = value; return this; }
        public String getProfile() { return Profile; }
        public CourierBookPageRequest setProfile(String value) { this.Profile = value; return this; }
    }

    public static class CourierBookPageResponse
    {
        public CourierBookPageView Page = null;
        public ResponseStatus ResponseStatus = null;
        
        public CourierBookPageView getPage() { return Page; }
        public CourierBookPageResponse setPage(CourierBookPageView value) { this.Page = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CourierBookPageResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CourierBookPageView
    {
        public Boolean Available = null;
        public Boolean BookingOn = null;
        public CourierTrackBusiness Business = null;
        public CourierBookProfile Profile = null;
        public ArrayList<CourierBookProfileLink> Profiles = new ArrayList<CourierBookProfileLink>();
        public Boolean CardEnabled = null;
        public String PublishableKey = null;
        public String AppUrl = null;
        public String Today = null;
        public Integer Weekday = null;
        public Integer NowMin = null;
        
        public Boolean isAvailable() { return Available; }
        public CourierBookPageView setAvailable(Boolean value) { this.Available = value; return this; }
        public Boolean isBookingOn() { return BookingOn; }
        public CourierBookPageView setBookingOn(Boolean value) { this.BookingOn = value; return this; }
        public CourierTrackBusiness getBusiness() { return Business; }
        public CourierBookPageView setBusiness(CourierTrackBusiness value) { this.Business = value; return this; }
        public CourierBookProfile getProfile() { return Profile; }
        public CourierBookPageView setProfile(CourierBookProfile value) { this.Profile = value; return this; }
        public ArrayList<CourierBookProfileLink> getProfiles() { return Profiles; }
        public CourierBookPageView setProfiles(ArrayList<CourierBookProfileLink> value) { this.Profiles = value; return this; }
        public Boolean isCardEnabled() { return CardEnabled; }
        public CourierBookPageView setCardEnabled(Boolean value) { this.CardEnabled = value; return this; }
        public String getPublishableKey() { return PublishableKey; }
        public CourierBookPageView setPublishableKey(String value) { this.PublishableKey = value; return this; }
        public String getAppUrl() { return AppUrl; }
        public CourierBookPageView setAppUrl(String value) { this.AppUrl = value; return this; }
        public String getToday() { return Today; }
        public CourierBookPageView setToday(String value) { this.Today = value; return this; }
        public Integer getWeekday() { return Weekday; }
        public CourierBookPageView setWeekday(Integer value) { this.Weekday = value; return this; }
        public Integer getNowMin() { return NowMin; }
        public CourierBookPageView setNowMin(Integer value) { this.NowMin = value; return this; }
    }

    public static class CourierTrackBusiness
    {
        public String Name = null;
        public String Phone = null;
        
        public String getName() { return Name; }
        public CourierTrackBusiness setName(String value) { this.Name = value; return this; }
        public String getPhone() { return Phone; }
        public CourierTrackBusiness setPhone(String value) { this.Phone = value; return this; }
    }

    public static class CourierBookProfile
    {
        public String Code = null;
        public String Name = null;
        public String Shape = null;
        public String Template = null;
        public String UnitOne = null;
        public String UnitMany = null;
        public String UnitOneEs = null;
        public String UnitManyEs = null;
        public String FacilityNoun = null;
        public String FacilityNounEs = null;
        public String FacilityName = null;
        public ArrayList<CourierBookLevel> Levels = new ArrayList<CourierBookLevel>();
        public Boolean Asap = null;
        public Boolean Recurring = null;
        public String PayTiming = null;
        public Boolean FinalAfterCount = null;
        public BigDecimal CancelFee = null;
        public BigDecimal MissedFee = null;
        public Integer MissedWaitMin = null;
        public ArrayList<String> ServiceArea = new ArrayList<String>();
        public ArrayList<String> Zips = new ArrayList<String>();
        public HandoffOptions Handoffs = null;
        
        public String getCode() { return Code; }
        public CourierBookProfile setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public CourierBookProfile setName(String value) { this.Name = value; return this; }
        public String getShape() { return Shape; }
        public CourierBookProfile setShape(String value) { this.Shape = value; return this; }
        public String getTemplate() { return Template; }
        public CourierBookProfile setTemplate(String value) { this.Template = value; return this; }
        public String getUnitOne() { return UnitOne; }
        public CourierBookProfile setUnitOne(String value) { this.UnitOne = value; return this; }
        public String getUnitMany() { return UnitMany; }
        public CourierBookProfile setUnitMany(String value) { this.UnitMany = value; return this; }
        public String getUnitOneEs() { return UnitOneEs; }
        public CourierBookProfile setUnitOneEs(String value) { this.UnitOneEs = value; return this; }
        public String getUnitManyEs() { return UnitManyEs; }
        public CourierBookProfile setUnitManyEs(String value) { this.UnitManyEs = value; return this; }
        public String getFacilityNoun() { return FacilityNoun; }
        public CourierBookProfile setFacilityNoun(String value) { this.FacilityNoun = value; return this; }
        public String getFacilityNounEs() { return FacilityNounEs; }
        public CourierBookProfile setFacilityNounEs(String value) { this.FacilityNounEs = value; return this; }
        public String getFacilityName() { return FacilityName; }
        public CourierBookProfile setFacilityName(String value) { this.FacilityName = value; return this; }
        public ArrayList<CourierBookLevel> getLevels() { return Levels; }
        public CourierBookProfile setLevels(ArrayList<CourierBookLevel> value) { this.Levels = value; return this; }
        public Boolean isAsap() { return Asap; }
        public CourierBookProfile setAsap(Boolean value) { this.Asap = value; return this; }
        public Boolean isRecurring() { return Recurring; }
        public CourierBookProfile setRecurring(Boolean value) { this.Recurring = value; return this; }
        public String getPayTiming() { return PayTiming; }
        public CourierBookProfile setPayTiming(String value) { this.PayTiming = value; return this; }
        public Boolean isFinalAfterCount() { return FinalAfterCount; }
        public CourierBookProfile setFinalAfterCount(Boolean value) { this.FinalAfterCount = value; return this; }
        public BigDecimal getCancelFee() { return CancelFee; }
        public CourierBookProfile setCancelFee(BigDecimal value) { this.CancelFee = value; return this; }
        public BigDecimal getMissedFee() { return MissedFee; }
        public CourierBookProfile setMissedFee(BigDecimal value) { this.MissedFee = value; return this; }
        public Integer getMissedWaitMin() { return MissedWaitMin; }
        public CourierBookProfile setMissedWaitMin(Integer value) { this.MissedWaitMin = value; return this; }
        public ArrayList<String> getServiceArea() { return ServiceArea; }
        public CourierBookProfile setServiceArea(ArrayList<String> value) { this.ServiceArea = value; return this; }
        public ArrayList<String> getZips() { return Zips; }
        public CourierBookProfile setZips(ArrayList<String> value) { this.Zips = value; return this; }
        public HandoffOptions getHandoffs() { return Handoffs; }
        public CourierBookProfile setHandoffs(HandoffOptions value) { this.Handoffs = value; return this; }
    }

    public static class CourierBookLevel
    {
        public String Code = null;
        public String Name = null;
        public String Ready = null;
        public Integer WithinMin = null;
        public String InBy = null;
        public BigDecimal Surcharge = null;
        public ArrayList<Integer> Days = new ArrayList<Integer>();
        public Integer DeadlineMin = null;
        
        public String getCode() { return Code; }
        public CourierBookLevel setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public CourierBookLevel setName(String value) { this.Name = value; return this; }
        public String getReady() { return Ready; }
        public CourierBookLevel setReady(String value) { this.Ready = value; return this; }
        public Integer getWithinMin() { return WithinMin; }
        public CourierBookLevel setWithinMin(Integer value) { this.WithinMin = value; return this; }
        public String getInBy() { return InBy; }
        public CourierBookLevel setInBy(String value) { this.InBy = value; return this; }
        public BigDecimal getSurcharge() { return Surcharge; }
        public CourierBookLevel setSurcharge(BigDecimal value) { this.Surcharge = value; return this; }
        public ArrayList<Integer> getDays() { return Days; }
        public CourierBookLevel setDays(ArrayList<Integer> value) { this.Days = value; return this; }
        public Integer getDeadlineMin() { return DeadlineMin; }
        public CourierBookLevel setDeadlineMin(Integer value) { this.DeadlineMin = value; return this; }
    }

    public static class HandoffOptions
    {
        public Boolean Hand = null;
        public Boolean Porch = null;
        public Boolean Desk = null;
        public Boolean SigRequired = null;
        public Boolean IdRequired = null;
        public Boolean CodeRequired = null;
        
        public Boolean isHand() { return Hand; }
        public HandoffOptions setHand(Boolean value) { this.Hand = value; return this; }
        public Boolean isPorch() { return Porch; }
        public HandoffOptions setPorch(Boolean value) { this.Porch = value; return this; }
        public Boolean isDesk() { return Desk; }
        public HandoffOptions setDesk(Boolean value) { this.Desk = value; return this; }
        public Boolean isSigRequired() { return SigRequired; }
        public HandoffOptions setSigRequired(Boolean value) { this.SigRequired = value; return this; }
        public Boolean isIdRequired() { return IdRequired; }
        public HandoffOptions setIdRequired(Boolean value) { this.IdRequired = value; return this; }
        public Boolean isCodeRequired() { return CodeRequired; }
        public HandoffOptions setCodeRequired(Boolean value) { this.CodeRequired = value; return this; }
    }

    public static class CourierBookProfileLink
    {
        public String Code = null;
        public String Name = null;
        public String Shape = null;
        
        public String getCode() { return Code; }
        public CourierBookProfileLink setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public CourierBookProfileLink setName(String value) { this.Name = value; return this; }
        public String getShape() { return Shape; }
        public CourierBookProfileLink setShape(String value) { this.Shape = value; return this; }
    }

}

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