Trendsic Platform Service

<back to all web services

CourierAvailabilityRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/profiles/{Id}/availability
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CourierAvailabilityRequest
    {
        public Integer Id = null;
        public String Date = null;
        public String Zip = null;
        
        public Integer getId() { return Id; }
        public CourierAvailabilityRequest setId(Integer value) { this.Id = value; return this; }
        public String getDate() { return Date; }
        public CourierAvailabilityRequest setDate(String value) { this.Date = value; return this; }
        public String getZip() { return Zip; }
        public CourierAvailabilityRequest setZip(String value) { this.Zip = value; return this; }
    }

    public static class CourierAvailabilityResponse
    {
        public Availability Availability = null;
        public String Date = null;
        public ResponseStatus ResponseStatus = null;
        
        public Availability getAvailability() { return Availability; }
        public CourierAvailabilityResponse setAvailability(Availability value) { this.Availability = value; return this; }
        public String getDate() { return Date; }
        public CourierAvailabilityResponse setDate(String value) { this.Date = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CourierAvailabilityResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class Availability
    {
        public Boolean InArea = null;
        public Boolean ZipChecked = null;
        public Boolean Closed = null;
        public ArrayList<Window> Windows = new ArrayList<Window>();
        
        public Boolean isInArea() { return InArea; }
        public Availability setInArea(Boolean value) { this.InArea = value; return this; }
        public Boolean isZipChecked() { return ZipChecked; }
        public Availability setZipChecked(Boolean value) { this.ZipChecked = value; return this; }
        public Boolean isClosed() { return Closed; }
        public Availability setClosed(Boolean value) { this.Closed = value; return this; }
        public ArrayList<Window> getWindows() { return Windows; }
        public Availability setWindows(ArrayList<Window> value) { this.Windows = value; return this; }
    }

    public static class Window
    {
        public String Id = null;
        public Integer DayIx = null;
        public Integer StartMin = null;
        public Integer EndMin = null;
        public String Label = null;
        public Boolean Asap = null;
        public ArrayList<LevelOffer> Levels = new ArrayList<LevelOffer>();
        
        public String getId() { return Id; }
        public Window setId(String value) { this.Id = value; return this; }
        public Integer getDayIx() { return DayIx; }
        public Window setDayIx(Integer value) { this.DayIx = value; return this; }
        public Integer getStartMin() { return StartMin; }
        public Window setStartMin(Integer value) { this.StartMin = value; return this; }
        public Integer getEndMin() { return EndMin; }
        public Window setEndMin(Integer value) { this.EndMin = value; return this; }
        public String getLabel() { return Label; }
        public Window setLabel(String value) { this.Label = value; return this; }
        public Boolean isAsap() { return Asap; }
        public Window setAsap(Boolean value) { this.Asap = value; return this; }
        public ArrayList<LevelOffer> getLevels() { return Levels; }
        public Window setLevels(ArrayList<LevelOffer> value) { this.Levels = value; return this; }
    }

    public static class LevelOffer
    {
        public String Code = null;
        public String Name = null;
        public Boolean Ok = null;
        public String Why = null;
        public String Promise = null;
        public BigDecimal Surcharge = null;
        
        public String getCode() { return Code; }
        public LevelOffer setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public LevelOffer setName(String value) { this.Name = value; return this; }
        public Boolean isOk() { return Ok; }
        public LevelOffer setOk(Boolean value) { this.Ok = value; return this; }
        public String getWhy() { return Why; }
        public LevelOffer setWhy(String value) { this.Why = value; return this; }
        public String getPromise() { return Promise; }
        public LevelOffer setPromise(String value) { this.Promise = value; return this; }
        public BigDecimal getSurcharge() { return Surcharge; }
        public LevelOffer setSurcharge(BigDecimal value) { this.Surcharge = value; return this; }
    }

}

Java CourierAvailabilityRequest 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/dispatch/courier/profiles/{Id}/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Availability>
    <Closed>false</Closed>
    <InArea>false</InArea>
    <Windows>
      <CourierEngine.Window>
        <Asap>false</Asap>
        <DayIx>0</DayIx>
        <EndMin>0</EndMin>
        <Id>String</Id>
        <Label>String</Label>
        <Levels>
          <CourierEngine.LevelOffer>
            <Code>String</Code>
            <Name>String</Name>
            <Ok>false</Ok>
            <Promise>String</Promise>
            <Surcharge>0</Surcharge>
            <Why>String</Why>
          </CourierEngine.LevelOffer>
        </Levels>
        <StartMin>0</StartMin>
      </CourierEngine.Window>
    </Windows>
    <ZipChecked>false</ZipChecked>
  </Availability>
  <Date>String</Date>
  <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>
</CourierAvailabilityResponse>