| POST,OPTIONS | /v1/dispatch/courier/profiles/{Id}/reset |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class CourierBooking
{
public virtual bool On { get; set; }
public virtual string Slug { get; set; }
public virtual bool Asap { get; set; }
public virtual int MinLeadMin { get; set; }
public virtual string Open { get; set; }
public virtual string Close { get; set; }
public virtual int DriveBufferMin { get; set; }
public virtual List<string> Zips { get; set; } = [];
public virtual bool Recurring { get; set; }
public virtual string PayTiming { get; set; }
}
public partial class CourierChange
{
public virtual string Key { get; set; }
public virtual string Section { get; set; }
public virtual string Label { get; set; }
public virtual string From { get; set; }
public virtual string To { get; set; }
}
public partial class CourierDispatch
{
public virtual int PingSecs { get; set; }
public virtual decimal RadiusMi { get; set; }
public virtual bool DeclinePenalty { get; set; }
public virtual string NextRule { get; set; }
public virtual int GoMin { get; set; }
public virtual int LastMin { get; set; }
public virtual int NearFull { get; set; }
public virtual int MarginMin { get; set; }
public virtual string TrafficSource { get; set; }
}
public partial class CourierFacilityView
{
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string Address { get; set; }
public virtual int IntakeMin { get; set; }
public virtual List<CourierLevelView> Levels { get; set; } = [];
public virtual List<string> Holidays { get; set; } = [];
}
public partial class CourierFleetVehicle
{
public virtual int EquipmentID { get; set; }
public virtual string UnitNumber { get; set; }
public virtual string Name { get; set; }
public virtual string VehicleType { get; set; }
public virtual string Unit { get; set; }
public virtual decimal? Cap { get; set; }
public virtual bool Cold { get; set; }
public virtual string Status { get; set; }
public virtual bool Assigned { get; set; }
}
public partial class CourierIssue
{
public virtual string Key { get; set; }
public virtual string Section { get; set; }
public virtual string Message { get; set; }
}
public partial class CourierLevelView
{
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string InBy { get; set; }
public virtual int WithinMin { get; set; }
public virtual string Ready { get; set; }
public virtual List<int> Days { get; set; } = [];
public virtual bool IsOn { get; set; }
}
public partial class CourierMissed
{
public virtual int WaitMin { get; set; }
public virtual decimal Fee { get; set; }
public virtual decimal CancelFee { get; set; }
public virtual bool AutoRebook { get; set; }
public virtual bool RequireContact { get; set; }
public virtual bool RequirePhoto { get; set; }
}
public partial class CourierPay
{
public virtual string WorkerClass { get; set; }
public virtual decimal PerPickup { get; set; }
public virtual decimal PerStop { get; set; }
public virtual decimal PerMissed { get; set; }
public virtual decimal PerCancel { get; set; }
public virtual int WaitAfterMin { get; set; }
public virtual decimal WaitPerMin { get; set; }
public virtual bool MileageOn { get; set; }
public virtual decimal PerMile { get; set; }
public virtual decimal MinPerJob { get; set; }
public virtual decimal TipsPct { get; set; }
}
public partial class CourierPreview
{
public virtual string DeadlineTitle { get; set; }
public virtual string DeadlineLead { get; set; }
public virtual string RoomW { get; set; }
public virtual string LastW { get; set; }
public virtual string GoW { get; set; }
public virtual List<CourierPreviewLine> Zones { get; set; } = [];
public virtual string PaySub { get; set; }
public virtual List<CourierPreviewLine> PayRows { get; set; } = [];
public virtual string PayTotal { get; set; }
public virtual List<CourierPreviewLine> ProofRows { get; set; } = [];
public virtual string Ping { get; set; }
}
public partial class CourierPreviewLine
{
public virtual string K { get; set; }
public virtual string V { get; set; }
public virtual string Dot { get; set; }
}
public partial class CourierPricing
{
public virtual decimal Base { get; set; }
public virtual decimal PerUnit { get; set; }
public virtual decimal PerMile { get; set; }
public virtual decimal MinOrder { get; set; }
public virtual decimal TaxPct { get; set; }
public virtual bool FinalAfterCount { get; set; }
public virtual List<string> ServiceArea { get; set; } = [];
public virtual int WindowMin { get; set; }
public virtual Dictionary<string, decimal> Surcharges { get; set; } = new();
}
public partial class CourierPrivacy
{
public virtual int ThreadHrs { get; set; }
public virtual int PhotoDays { get; set; }
public virtual string LockNames { get; set; }
public virtual bool HideAddr { get; set; }
public virtual bool LiveEta { get; set; }
public virtual bool Tipping { get; set; }
}
public partial class CourierProfileContext
{
public virtual int Drivers { get; set; }
public virtual int ProfileCount { get; set; }
public virtual int? PayPlanId { get; set; }
public virtual string ZoneMode { get; set; }
public virtual string ZoneName { get; set; }
public virtual int ZoneCount { get; set; }
public virtual bool HasBookingPage { get; set; }
public virtual bool HasRateConfig { get; set; }
public virtual Dictionary<string, string> VehicleFacts { get; set; } = new();
}
public partial class CourierProfileResetRequest
{
public virtual int Id { get; set; }
public virtual bool DryRun { get; set; }
}
public partial class CourierProfileSummary
{
public virtual int CourierProfileID { get; set; }
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string BusinessName { get; set; }
public virtual string RouteShape { get; set; }
public virtual bool Enabled { get; set; }
public virtual string TemplateFrom { get; set; }
public virtual int Drivers { get; set; }
}
public partial class CourierProfileView
{
public virtual int CourierProfileID { get; set; }
public virtual string Code { get; set; }
public virtual string Name { get; set; }
public virtual string BusinessName { get; set; }
public virtual string RouteShape { get; set; }
public virtual bool Enabled { get; set; }
public virtual string TemplateFrom { get; set; }
public virtual string UnitOne { get; set; }
public virtual string UnitMany { get; set; }
public virtual string FacilityNoun { get; set; }
public virtual string UnitOneEs { get; set; }
public virtual string UnitManyEs { get; set; }
public virtual string FacilityNounEs { get; set; }
public virtual string TagMode { get; set; }
public virtual List<string> TagFormats { get; set; } = [];
public virtual CourierPay Pay { get; set; }
public virtual CourierDispatch Dispatch { get; set; }
public virtual CourierMissed Missed { get; set; }
public virtual CourierPrivacy Privacy { get; set; }
public virtual CourierPricing Pricing { get; set; }
public virtual CourierBooking Booking { get; set; }
public virtual List<CourierFacilityView> Facilities { get; set; } = [];
public virtual List<CourierVehicleView> Vehicles { get; set; } = [];
public virtual Dictionary<string, Dictionary<String,String>> Proof { get; set; } = new();
public virtual CourierProfileContext Context { get; set; }
}
public partial class CourierResponse
{
public virtual List<CourierProfileSummary> Profiles { get; set; } = [];
public virtual List<CourierTemplateOption> Templates { get; set; } = [];
public virtual CourierProfileView Profile { get; set; }
public virtual List<CourierIssue> Issues { get; set; } = [];
public virtual List<CourierChange> Changes { get; set; } = [];
public virtual CourierPreview Preview { get; set; }
public virtual List<CourierFleetVehicle> Fleet { get; set; } = [];
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class CourierTemplateOption
{
public virtual string Key { get; set; }
public virtual string Label { get; set; }
public virtual string Detail { get; set; }
public virtual string RouteShape { get; set; }
}
public partial class CourierVehicleView
{
public virtual int EquipmentID { get; set; }
public virtual string UnitNumber { get; set; }
public virtual string Name { get; set; }
public virtual string Unit { get; set; }
public virtual decimal Cap { get; set; }
public virtual bool Cold { get; set; }
}
}
C# CourierProfileResetRequest DTOs
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.
POST /v1/dispatch/courier/profiles/{Id}/reset HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CourierProfileResetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<DryRun>false</DryRun>
<Id>0</Id>
</CourierProfileResetRequest>
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>