| GET,OPTIONS | /v1/dispatch/courier/vans |
|---|
import Foundation
import ServiceStack
public class CourierVansRequest : Codable
{
required public init(){}
}
public class CourierOfficeResponse : Codable
{
public var office:CourierOfficeView
public var available:Bool
public var responseStatus:ResponseStatus
required public init(){}
}
public class CourierOfficeView : Codable
{
public var serverUtc:Date
public var vans:[CourierOfficeVan] = []
public var held:[CourierHeldView] = []
public var vehicles:[CourierVehicleOption] = []
public var profiles:[CourierProfileOption] = []
public var drivers:[CourierDriverOption] = []
public var desk:[CourierDeskRow] = []
public var goCount:Int
public var heldCount:Int
public var readyToOffer:Int
public var intakeMin:Int?
public var facilityNoun:String
required public init(){}
}
public class CourierOfficeVan : Codable
{
public var driverContactId:Int
public var driverCode:String
public var name:String
public var online:Bool
public var zone:String
public var vehicleUnit:String
public var facilityName:String
public var state:String
public var leaveByUtc:Date?
public var leaveByText:String
public var slackMin:Int?
public var inVan:Int
public var committed:Int
public var cap:Double?
public var capUnit:String
public var unitMany:String
public var criticalCode:String
public var driveMin:Int
public var sendNote:String
public var aboard:[CourierVanChip] = []
public var queued:[CourierVanChip] = []
required public init(){}
}
public class CourierVanChip : Codable
{
public var code:String
public var courierStep:String
public var levelCode:String
public var levelName:String
public var units:Int
public var area:String
public var dueUtc:Date?
public var dueText:String
public var movable:Bool
public var noMoveWhy:String
public var targets:[CourierMoveTarget] = []
required public init(){}
}
public class CourierMoveTarget : Codable
{
public var driverContactId:Int
public var name:String
public var ok:Bool
public var why:String
public var leaveByText:String
required public init(){}
}
public class CourierHeldView : Codable
{
public var code:String
public var area:String
public var units:Int
public var unitMany:String
public var miles:Double?
public var levelCode:String
public var levelName:String
public var dueText:String
public var heldReason:String
public var heldMin:Int?
public var why:[String] = []
public var bestDriverContactId:Int?
public var bestName:String
public var bestLeaveByText:String
required public init(){}
}
public class CourierVehicleOption : Codable
{
public var courierProfileId:Int
public var equipmentID:Int
public var unitNumber:String
public var vehicleType:String
public var capacityUnit:String
public var capacityLimit:Double?
public var isRefrigerated:Bool
public var status:String
required public init(){}
}
public class CourierProfileOption : Codable
{
public var courierProfileID:Int
public var name:String
public var routeShape:String
public var enabled:Bool
public var unitOne:String
public var unitMany:String
public var facilityNoun:String
public var facilities:[CourierFacilityOption] = []
required public init(){}
}
public class CourierFacilityOption : Codable
{
public var courierFacilityID:Int
public var code:String
public var name:String
public var address:String
public var intakeMin:Int
required public init(){}
}
public class CourierDriverOption : Codable
{
public var contactId:Int
public var code:String
public var name:String
public var online:Bool
public var zone:String
public var vehicleUnit:String
public var equipmentID:Int?
public var sentToFacility:Bool
required public init(){}
}
public class CourierDeskRow : Codable
{
public var code:String
public var courierProfileId:Int
public var facilityName:String
public var levelCode:String
public var levelName:String
public var dueUtc:Date?
public var dueText:String
public var units:Int
public var unitsFound:Int?
public var unitMany:String
public var fare:Double?
public var finalPrice:Double?
public var tipAmount:Double?
public var payMode:String
public var captureMode:String
public var customerName:String
public var area:String
public var intakeUtc:Date?
public var intakeMinAgo:Int?
public var damageNote:String
public var finalPriceAfterCount:Bool
public var needsPrice:Bool
public var itemCount:Int
public var missingCount:Int
public var photoCount:Int
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/dispatch/courier/vans HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CourierOfficeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Available>false</Available>
<Office>
<Desk>
<CourierDeskRow>
<Area>String</Area>
<CaptureMode>String</CaptureMode>
<Code>String</Code>
<CourierProfileId>0</CourierProfileId>
<CustomerName>String</CustomerName>
<DamageNote>String</DamageNote>
<DueText>String</DueText>
<DueUtc>0001-01-01T00:00:00</DueUtc>
<FacilityName>String</FacilityName>
<Fare>0</Fare>
<FinalPrice>0</FinalPrice>
<FinalPriceAfterCount>false</FinalPriceAfterCount>
<IntakeMinAgo>0</IntakeMinAgo>
<IntakeUtc>0001-01-01T00:00:00</IntakeUtc>
<ItemCount>0</ItemCount>
<LevelCode>String</LevelCode>
<LevelName>String</LevelName>
<MissingCount>0</MissingCount>
<NeedsPrice>false</NeedsPrice>
<PayMode>String</PayMode>
<PhotoCount>0</PhotoCount>
<TipAmount>0</TipAmount>
<UnitMany>String</UnitMany>
<Units>0</Units>
<UnitsFound>0</UnitsFound>
</CourierDeskRow>
</Desk>
<Drivers>
<CourierDriverOption>
<Code>String</Code>
<ContactId>0</ContactId>
<EquipmentID>0</EquipmentID>
<Name>String</Name>
<Online>false</Online>
<SentToFacility>false</SentToFacility>
<VehicleUnit>String</VehicleUnit>
<Zone>String</Zone>
</CourierDriverOption>
</Drivers>
<FacilityNoun>String</FacilityNoun>
<GoCount>0</GoCount>
<Held>
<CourierHeldView>
<Area>String</Area>
<BestDriverContactId>0</BestDriverContactId>
<BestLeaveByText>String</BestLeaveByText>
<BestName>String</BestName>
<Code>String</Code>
<DueText>String</DueText>
<HeldMin>0</HeldMin>
<HeldReason>String</HeldReason>
<LevelCode>String</LevelCode>
<LevelName>String</LevelName>
<Miles>0</Miles>
<UnitMany>String</UnitMany>
<Units>0</Units>
<Why xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</Why>
</CourierHeldView>
</Held>
<HeldCount>0</HeldCount>
<IntakeMin>0</IntakeMin>
<Profiles>
<CourierProfileOption>
<CourierProfileID>0</CourierProfileID>
<Enabled>false</Enabled>
<Facilities>
<CourierFacilityOption>
<Address>String</Address>
<Code>String</Code>
<CourierFacilityID>0</CourierFacilityID>
<IntakeMin>0</IntakeMin>
<Name>String</Name>
</CourierFacilityOption>
</Facilities>
<FacilityNoun>String</FacilityNoun>
<Name>String</Name>
<RouteShape>String</RouteShape>
<UnitMany>String</UnitMany>
<UnitOne>String</UnitOne>
</CourierProfileOption>
</Profiles>
<ReadyToOffer>0</ReadyToOffer>
<ServerUtc>0001-01-01T00:00:00</ServerUtc>
<Vans>
<CourierOfficeVan>
<Aboard>
<CourierVanChip>
<Area>String</Area>
<Code>String</Code>
<CourierStep>String</CourierStep>
<DueText>String</DueText>
<DueUtc>0001-01-01T00:00:00</DueUtc>
<LevelCode>String</LevelCode>
<LevelName>String</LevelName>
<Movable>false</Movable>
<NoMoveWhy>String</NoMoveWhy>
<Targets>
<CourierMoveTarget>
<DriverContactId>0</DriverContactId>
<LeaveByText>String</LeaveByText>
<Name>String</Name>
<Ok>false</Ok>
<Why>String</Why>
</CourierMoveTarget>
</Targets>
<Units>0</Units>
</CourierVanChip>
</Aboard>
<Cap>0</Cap>
<CapUnit>String</CapUnit>
<Committed>0</Committed>
<CriticalCode>String</CriticalCode>
<DriveMin>0</DriveMin>
<DriverCode>String</DriverCode>
<DriverContactId>0</DriverContactId>
<FacilityName>String</FacilityName>
<InVan>0</InVan>
<LeaveByText>String</LeaveByText>
<LeaveByUtc>0001-01-01T00:00:00</LeaveByUtc>
<Name>String</Name>
<Online>false</Online>
<Queued>
<CourierVanChip>
<Area>String</Area>
<Code>String</Code>
<CourierStep>String</CourierStep>
<DueText>String</DueText>
<DueUtc>0001-01-01T00:00:00</DueUtc>
<LevelCode>String</LevelCode>
<LevelName>String</LevelName>
<Movable>false</Movable>
<NoMoveWhy>String</NoMoveWhy>
<Targets>
<CourierMoveTarget>
<DriverContactId>0</DriverContactId>
<LeaveByText>String</LeaveByText>
<Name>String</Name>
<Ok>false</Ok>
<Why>String</Why>
</CourierMoveTarget>
</Targets>
<Units>0</Units>
</CourierVanChip>
</Queued>
<SendNote>String</SendNote>
<SlackMin>0</SlackMin>
<State>String</State>
<UnitMany>String</UnitMany>
<VehicleUnit>String</VehicleUnit>
<Zone>String</Zone>
</CourierOfficeVan>
</Vans>
<Vehicles>
<CourierVehicleOption>
<CapacityLimit>0</CapacityLimit>
<CapacityUnit>String</CapacityUnit>
<CourierProfileId>0</CourierProfileId>
<EquipmentID>0</EquipmentID>
<IsRefrigerated>false</IsRefrigerated>
<Status>String</Status>
<UnitNumber>String</UnitNumber>
<VehicleType>String</VehicleType>
</CourierVehicleOption>
</Vehicles>
</Office>
<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>
</CourierOfficeResponse>