Trendsic Platform Service

<back to all web services

CourierProfilesRequest

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


open class CourierProfilesRequest
{
}

open class CourierResponse
{
    open var Profiles:ArrayList<CourierProfileSummary> = ArrayList<CourierProfileSummary>()
    open var Templates:ArrayList<CourierTemplateOption> = ArrayList<CourierTemplateOption>()
    open var Profile:CourierProfileView? = null
    open var Issues:ArrayList<CourierIssue> = ArrayList<CourierIssue>()
    open var Changes:ArrayList<CourierChange> = ArrayList<CourierChange>()
    open var Preview:CourierPreview? = null
    open var Fleet:ArrayList<CourierFleetVehicle> = ArrayList<CourierFleetVehicle>()
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierProfileSummary
{
    open var CourierProfileID:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var BusinessName:String? = null
    open var RouteShape:String? = null
    open var Enabled:Boolean? = null
    open var TemplateFrom:String? = null
    open var Drivers:Int? = null
}

open class CourierTemplateOption
{
    open var Key:String? = null
    open var Label:String? = null
    open var Detail:String? = null
    open var RouteShape:String? = null
}

open class CourierProfileView
{
    open var CourierProfileID:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var BusinessName:String? = null
    open var RouteShape:String? = null
    open var Enabled:Boolean? = null
    open var TemplateFrom:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var FacilityNoun:String? = null
    open var UnitOneEs:String? = null
    open var UnitManyEs:String? = null
    open var FacilityNounEs:String? = null
    open var TagMode:String? = null
    open var TagFormats:ArrayList<String> = ArrayList<String>()
    open var Pay:CourierPay? = null
    open var Dispatch:CourierDispatch? = null
    open var Missed:CourierMissed? = null
    open var Privacy:CourierPrivacy? = null
    open var Pricing:CourierPricing? = null
    open var Booking:CourierBooking? = null
    open var Facilities:ArrayList<CourierFacilityView> = ArrayList<CourierFacilityView>()
    open var Vehicles:ArrayList<CourierVehicleView> = ArrayList<CourierVehicleView>()
    open var Proof:HashMap<String,HashMap<String,String>> = HashMap<String,HashMap<String,String>>()
    open var Context:CourierProfileContext? = null
}

open class CourierPay
{
    open var WorkerClass:String? = null
    open var PerPickup:BigDecimal? = null
    open var PerStop:BigDecimal? = null
    open var PerMissed:BigDecimal? = null
    open var PerCancel:BigDecimal? = null
    open var WaitAfterMin:Int? = null
    open var WaitPerMin:BigDecimal? = null
    open var MileageOn:Boolean? = null
    open var PerMile:BigDecimal? = null
    open var MinPerJob:BigDecimal? = null
    open var TipsPct:BigDecimal? = null
}

open class CourierDispatch
{
    open var PingSecs:Int? = null
    open var RadiusMi:BigDecimal? = null
    open var DeclinePenalty:Boolean? = null
    open var NextRule:String? = null
    open var GoMin:Int? = null
    open var LastMin:Int? = null
    open var NearFull:Int? = null
    open var MarginMin:Int? = null
    open var TrafficSource:String? = null
}

open class CourierMissed
{
    open var WaitMin:Int? = null
    open var Fee:BigDecimal? = null
    open var CancelFee:BigDecimal? = null
    open var AutoRebook:Boolean? = null
    open var RequireContact:Boolean? = null
    open var RequirePhoto:Boolean? = null
}

open class CourierPrivacy
{
    open var ThreadHrs:Int? = null
    open var PhotoDays:Int? = null
    open var LockNames:String? = null
    open var HideAddr:Boolean? = null
    open var LiveEta:Boolean? = null
    open var Tipping:Boolean? = null
}

open class CourierPricing
{
    open var Base:BigDecimal? = null
    open var PerUnit:BigDecimal? = null
    open var PerMile:BigDecimal? = null
    open var MinOrder:BigDecimal? = null
    open var TaxPct:BigDecimal? = null
    open var FinalAfterCount:Boolean? = null
    open var ServiceArea:ArrayList<String> = ArrayList<String>()
    open var WindowMin:Int? = null
    open var Surcharges:HashMap<String,BigDecimal> = HashMap<String,BigDecimal>()
}

open class CourierBooking
{
    open var On:Boolean? = null
    open var Slug:String? = null
    open var Asap:Boolean? = null
    open var MinLeadMin:Int? = null
    open var Open:String? = null
    open var Close:String? = null
    open var DriveBufferMin:Int? = null
    open var Zips:ArrayList<String> = ArrayList<String>()
    open var Recurring:Boolean? = null
    open var PayTiming:String? = null
}

open class CourierFacilityView
{
    open var Code:String? = null
    open var Name:String? = null
    open var Address:String? = null
    open var IntakeMin:Int? = null
    open var Levels:ArrayList<CourierLevelView> = ArrayList<CourierLevelView>()
    open var Holidays:ArrayList<String> = ArrayList<String>()
}

open class CourierLevelView
{
    open var Code:String? = null
    open var Name:String? = null
    open var InBy:String? = null
    open var WithinMin:Int? = null
    open var Ready:String? = null
    open var Days:ArrayList<Int> = ArrayList<Int>()
    open var IsOn:Boolean? = null
}

open class CourierVehicleView
{
    open var EquipmentID:Int? = null
    open var UnitNumber:String? = null
    open var Name:String? = null
    open var Unit:String? = null
    open var Cap:BigDecimal? = null
    open var Cold:Boolean? = null
}

open class CourierProfileContext
{
    open var Drivers:Int? = null
    open var ProfileCount:Int? = null
    open var PayPlanId:Int? = null
    open var ZoneMode:String? = null
    open var ZoneName:String? = null
    open var ZoneCount:Int? = null
    open var HasBookingPage:Boolean? = null
    open var HasRateConfig:Boolean? = null
    open var VehicleFacts:HashMap<String,String> = HashMap<String,String>()
}

open class CourierIssue
{
    open var Key:String? = null
    open var Section:String? = null
    open var Message:String? = null
}

open class CourierChange
{
    open var Key:String? = null
    open var Section:String? = null
    open var Label:String? = null
    open var From:String? = null
    open var To:String? = null
}

open class CourierPreview
{
    open var DeadlineTitle:String? = null
    open var DeadlineLead:String? = null
    open var RoomW:String? = null
    open var LastW:String? = null
    open var GoW:String? = null
    open var Zones:ArrayList<CourierPreviewLine> = ArrayList<CourierPreviewLine>()
    open var PaySub:String? = null
    open var PayRows:ArrayList<CourierPreviewLine> = ArrayList<CourierPreviewLine>()
    open var PayTotal:String? = null
    open var ProofRows:ArrayList<CourierPreviewLine> = ArrayList<CourierPreviewLine>()
    open var Ping:String? = null
}

open class CourierPreviewLine
{
    open var K:String? = null
    open var V:String? = null
    open var Dot:String? = null
}

open class CourierFleetVehicle
{
    open var EquipmentID:Int? = null
    open var UnitNumber:String? = null
    open var Name:String? = null
    open var VehicleType:String? = null
    open var Unit:String? = null
    open var Cap:BigDecimal? = null
    open var Cold:Boolean? = null
    open var Status:String? = null
    open var Assigned:Boolean? = null
}

Kotlin CourierProfilesRequest 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 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Changes>
    <CourierChange>
      <From>String</From>
      <Key>String</Key>
      <Label>String</Label>
      <Section>String</Section>
      <To>String</To>
    </CourierChange>
  </Changes>
  <Fleet>
    <CourierFleetVehicle>
      <Assigned>false</Assigned>
      <Cap>0</Cap>
      <Cold>false</Cold>
      <EquipmentID>0</EquipmentID>
      <Name>String</Name>
      <Status>String</Status>
      <Unit>String</Unit>
      <UnitNumber>String</UnitNumber>
      <VehicleType>String</VehicleType>
    </CourierFleetVehicle>
  </Fleet>
  <Issues>
    <CourierIssue>
      <Key>String</Key>
      <Message>String</Message>
      <Section>String</Section>
    </CourierIssue>
  </Issues>
  <Preview>
    <DeadlineLead>String</DeadlineLead>
    <DeadlineTitle>String</DeadlineTitle>
    <GoW>String</GoW>
    <LastW>String</LastW>
    <PayRows>
      <CourierPreviewLine>
        <Dot>String</Dot>
        <K>String</K>
        <V>String</V>
      </CourierPreviewLine>
    </PayRows>
    <PaySub>String</PaySub>
    <PayTotal>String</PayTotal>
    <Ping>String</Ping>
    <ProofRows>
      <CourierPreviewLine>
        <Dot>String</Dot>
        <K>String</K>
        <V>String</V>
      </CourierPreviewLine>
    </ProofRows>
    <RoomW>String</RoomW>
    <Zones>
      <CourierPreviewLine>
        <Dot>String</Dot>
        <K>String</K>
        <V>String</V>
      </CourierPreviewLine>
    </Zones>
  </Preview>
  <Profile>
    <Booking>
      <Asap>false</Asap>
      <Close>String</Close>
      <DriveBufferMin>0</DriveBufferMin>
      <MinLeadMin>0</MinLeadMin>
      <On>false</On>
      <Open>String</Open>
      <PayTiming>String</PayTiming>
      <Recurring>false</Recurring>
      <Slug>String</Slug>
      <Zips xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Zips>
    </Booking>
    <BusinessName>String</BusinessName>
    <Code>String</Code>
    <Context>
      <Drivers>0</Drivers>
      <HasBookingPage>false</HasBookingPage>
      <HasRateConfig>false</HasRateConfig>
      <PayPlanId>0</PayPlanId>
      <ProfileCount>0</ProfileCount>
      <VehicleFacts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </VehicleFacts>
      <ZoneCount>0</ZoneCount>
      <ZoneMode>String</ZoneMode>
      <ZoneName>String</ZoneName>
    </Context>
    <CourierProfileID>0</CourierProfileID>
    <Dispatch>
      <DeclinePenalty>false</DeclinePenalty>
      <GoMin>0</GoMin>
      <LastMin>0</LastMin>
      <MarginMin>0</MarginMin>
      <NearFull>0</NearFull>
      <NextRule>String</NextRule>
      <PingSecs>0</PingSecs>
      <RadiusMi>0</RadiusMi>
      <TrafficSource>String</TrafficSource>
    </Dispatch>
    <Enabled>false</Enabled>
    <Facilities>
      <CourierFacilityView>
        <Address>String</Address>
        <Code>String</Code>
        <Holidays xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Holidays>
        <IntakeMin>0</IntakeMin>
        <Levels>
          <CourierLevelView>
            <Code>String</Code>
            <Days xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </Days>
            <InBy>String</InBy>
            <IsOn>false</IsOn>
            <Name>String</Name>
            <Ready>String</Ready>
            <WithinMin>0</WithinMin>
          </CourierLevelView>
        </Levels>
        <Name>String</Name>
      </CourierFacilityView>
    </Facilities>
    <FacilityNoun>String</FacilityNoun>
    <FacilityNounEs>String</FacilityNounEs>
    <Missed>
      <AutoRebook>false</AutoRebook>
      <CancelFee>0</CancelFee>
      <Fee>0</Fee>
      <RequireContact>false</RequireContact>
      <RequirePhoto>false</RequirePhoto>
      <WaitMin>0</WaitMin>
    </Missed>
    <Name>String</Name>
    <Pay>
      <MileageOn>false</MileageOn>
      <MinPerJob>0</MinPerJob>
      <PerCancel>0</PerCancel>
      <PerMile>0</PerMile>
      <PerMissed>0</PerMissed>
      <PerPickup>0</PerPickup>
      <PerStop>0</PerStop>
      <TipsPct>0</TipsPct>
      <WaitAfterMin>0</WaitAfterMin>
      <WaitPerMin>0</WaitPerMin>
      <WorkerClass>String</WorkerClass>
    </Pay>
    <Pricing>
      <Base>0</Base>
      <FinalAfterCount>false</FinalAfterCount>
      <MinOrder>0</MinOrder>
      <PerMile>0</PerMile>
      <PerUnit>0</PerUnit>
      <ServiceArea xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </ServiceArea>
      <Surcharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringdecimal>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfstringdecimal>
      </Surcharges>
      <TaxPct>0</TaxPct>
      <WindowMin>0</WindowMin>
    </Pricing>
    <Privacy>
      <HideAddr>false</HideAddr>
      <LiveEta>false</LiveEta>
      <LockNames>String</LockNames>
      <PhotoDays>0</PhotoDays>
      <ThreadHrs>0</ThreadHrs>
      <Tipping>false</Tipping>
    </Privacy>
    <Proof xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>
          <d3p1:KeyValueOfstringstring>
            <d3p1:Key>String</d3p1:Key>
            <d3p1:Value>String</d3p1:Value>
          </d3p1:KeyValueOfstringstring>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
    </Proof>
    <RouteShape>String</RouteShape>
    <TagFormats xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </TagFormats>
    <TagMode>String</TagMode>
    <TemplateFrom>String</TemplateFrom>
    <UnitMany>String</UnitMany>
    <UnitManyEs>String</UnitManyEs>
    <UnitOne>String</UnitOne>
    <UnitOneEs>String</UnitOneEs>
    <Vehicles>
      <CourierVehicleView>
        <Cap>0</Cap>
        <Cold>false</Cold>
        <EquipmentID>0</EquipmentID>
        <Name>String</Name>
        <Unit>String</Unit>
        <UnitNumber>String</UnitNumber>
      </CourierVehicleView>
    </Vehicles>
  </Profile>
  <Profiles>
    <CourierProfileSummary>
      <BusinessName>String</BusinessName>
      <Code>String</Code>
      <CourierProfileID>0</CourierProfileID>
      <Drivers>0</Drivers>
      <Enabled>false</Enabled>
      <Name>String</Name>
      <RouteShape>String</RouteShape>
      <TemplateFrom>String</TemplateFrom>
    </CourierProfileSummary>
  </Profiles>
  <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>
  <Templates>
    <CourierTemplateOption>
      <Detail>String</Detail>
      <Key>String</Key>
      <Label>String</Label>
      <RouteShape>String</RouteShape>
    </CourierTemplateOption>
  </Templates>
</CourierResponse>