Trendsic Platform Service

<back to all web services

DispatchPickupPageRequest

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

public class dtos
{

    public static class DispatchPickupPageRequest
    {
        public String SchedulerUrl = null;
        
        public String getSchedulerUrl() { return SchedulerUrl; }
        public DispatchPickupPageRequest setSchedulerUrl(String value) { this.SchedulerUrl = value; return this; }
    }

    public static class DispatchPickupPageResponse
    {
        public String CompanyName = null;
        public ArrayList<DispatchZoneView> Zones = new ArrayList<DispatchZoneView>();
        public ArrayList<DispatchNeedView> Needs = new ArrayList<DispatchNeedView>();
        public Boolean CardEnabled = null;
        public String PublishableKey = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getCompanyName() { return CompanyName; }
        public DispatchPickupPageResponse setCompanyName(String value) { this.CompanyName = value; return this; }
        public ArrayList<DispatchZoneView> getZones() { return Zones; }
        public DispatchPickupPageResponse setZones(ArrayList<DispatchZoneView> value) { this.Zones = value; return this; }
        public ArrayList<DispatchNeedView> getNeeds() { return Needs; }
        public DispatchPickupPageResponse setNeeds(ArrayList<DispatchNeedView> value) { this.Needs = value; return this; }
        public Boolean isCardEnabled() { return CardEnabled; }
        public DispatchPickupPageResponse setCardEnabled(Boolean value) { this.CardEnabled = value; return this; }
        public String getPublishableKey() { return PublishableKey; }
        public DispatchPickupPageResponse setPublishableKey(String value) { this.PublishableKey = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DispatchPickupPageResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class DispatchZoneView
    {
        public String Zone = null;
        public BigDecimal Base = null;
        public BigDecimal PerBag = null;
        public BigDecimal PremiumUpliftPct = null;
        public Integer Drivers = null;
        public Integer IdleDrivers = null;
        
        public String getZone() { return Zone; }
        public DispatchZoneView setZone(String value) { this.Zone = value; return this; }
        public BigDecimal getBase() { return Base; }
        public DispatchZoneView setBase(BigDecimal value) { this.Base = value; return this; }
        public BigDecimal getPerBag() { return PerBag; }
        public DispatchZoneView setPerBag(BigDecimal value) { this.PerBag = value; return this; }
        public BigDecimal getPremiumUpliftPct() { return PremiumUpliftPct; }
        public DispatchZoneView setPremiumUpliftPct(BigDecimal value) { this.PremiumUpliftPct = value; return this; }
        public Integer getDrivers() { return Drivers; }
        public DispatchZoneView setDrivers(Integer value) { this.Drivers = value; return this; }
        public Integer getIdleDrivers() { return IdleDrivers; }
        public DispatchZoneView setIdleDrivers(Integer value) { this.IdleDrivers = value; return this; }
    }

    public static class DispatchNeedView
    {
        public String Id = null;
        public String Label = null;
        public String Sub = null;
        
        public String getId() { return Id; }
        public DispatchNeedView setId(String value) { this.Id = value; return this; }
        public String getLabel() { return Label; }
        public DispatchNeedView setLabel(String value) { this.Label = value; return this; }
        public String getSub() { return Sub; }
        public DispatchNeedView setSub(String value) { this.Sub = value; return this; }
    }

}

Java DispatchPickupPageRequest 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/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchPickupPageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CardEnabled>false</CardEnabled>
  <CompanyName>String</CompanyName>
  <Needs>
    <DispatchNeedView>
      <Id>String</Id>
      <Label>String</Label>
      <Sub>String</Sub>
    </DispatchNeedView>
  </Needs>
  <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>
  <Zones>
    <DispatchZoneView>
      <Base>0</Base>
      <Drivers>0</Drivers>
      <IdleDrivers>0</IdleDrivers>
      <PerBag>0</PerBag>
      <PremiumUpliftPct>0</PremiumUpliftPct>
      <Zone>String</Zone>
    </DispatchZoneView>
  </Zones>
</DispatchPickupPageResponse>