Trendsic Platform Service

<back to all web services

CourierProfileResetRequest

namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CourierProfileSummary() = 
        member val CourierProfileID:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val BusinessName:String = null with get,set
        member val RouteShape:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val TemplateFrom:String = null with get,set
        member val Drivers:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CourierTemplateOption() = 
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Detail:String = null with get,set
        member val RouteShape:String = null with get,set

    [<AllowNullLiteral>]
    type CourierPay() = 
        member val WorkerClass:String = null with get,set
        member val PerPickup:Decimal = new Decimal() with get,set
        member val PerStop:Decimal = new Decimal() with get,set
        member val PerMissed:Decimal = new Decimal() with get,set
        member val PerCancel:Decimal = new Decimal() with get,set
        member val WaitAfterMin:Int32 = new Int32() with get,set
        member val WaitPerMin:Decimal = new Decimal() with get,set
        member val MileageOn:Boolean = new Boolean() with get,set
        member val PerMile:Decimal = new Decimal() with get,set
        member val MinPerJob:Decimal = new Decimal() with get,set
        member val TipsPct:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type CourierDispatch() = 
        member val PingSecs:Int32 = new Int32() with get,set
        member val RadiusMi:Decimal = new Decimal() with get,set
        member val DeclinePenalty:Boolean = new Boolean() with get,set
        member val NextRule:String = null with get,set
        member val GoMin:Int32 = new Int32() with get,set
        member val LastMin:Int32 = new Int32() with get,set
        member val NearFull:Int32 = new Int32() with get,set
        member val MarginMin:Int32 = new Int32() with get,set
        member val TrafficSource:String = null with get,set

    [<AllowNullLiteral>]
    type CourierMissed() = 
        member val WaitMin:Int32 = new Int32() with get,set
        member val Fee:Decimal = new Decimal() with get,set
        member val CancelFee:Decimal = new Decimal() with get,set
        member val AutoRebook:Boolean = new Boolean() with get,set
        member val RequireContact:Boolean = new Boolean() with get,set
        member val RequirePhoto:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierPrivacy() = 
        member val ThreadHrs:Int32 = new Int32() with get,set
        member val PhotoDays:Int32 = new Int32() with get,set
        member val LockNames:String = null with get,set
        member val HideAddr:Boolean = new Boolean() with get,set
        member val LiveEta:Boolean = new Boolean() with get,set
        member val Tipping:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierPricing() = 
        member val Base:Decimal = new Decimal() with get,set
        member val PerUnit:Decimal = new Decimal() with get,set
        member val PerMile:Decimal = new Decimal() with get,set
        member val MinOrder:Decimal = new Decimal() with get,set
        member val TaxPct:Decimal = new Decimal() with get,set
        member val FinalAfterCount:Boolean = new Boolean() with get,set
        member val ServiceArea:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val WindowMin:Int32 = new Int32() with get,set
        member val Surcharges:Dictionary<String, Decimal> = new Dictionary<String, Decimal>() with get,set

    [<AllowNullLiteral>]
    type CourierBooking() = 
        member val On:Boolean = new Boolean() with get,set
        member val Slug:String = null with get,set
        member val Asap:Boolean = new Boolean() with get,set
        member val MinLeadMin:Int32 = new Int32() with get,set
        member val Open:String = null with get,set
        member val Close:String = null with get,set
        member val DriveBufferMin:Int32 = new Int32() with get,set
        member val Zips:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Recurring:Boolean = new Boolean() with get,set
        member val PayTiming:String = null with get,set

    [<AllowNullLiteral>]
    type CourierLevelView() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val InBy:String = null with get,set
        member val WithinMin:Int32 = new Int32() with get,set
        member val Ready:String = null with get,set
        member val Days:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val IsOn:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierFacilityView() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Address:String = null with get,set
        member val IntakeMin:Int32 = new Int32() with get,set
        member val Levels:ResizeArray<CourierLevelView> = new ResizeArray<CourierLevelView>() with get,set
        member val Holidays:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type CourierVehicleView() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val UnitNumber:String = null with get,set
        member val Name:String = null with get,set
        member val Unit:String = null with get,set
        member val Cap:Decimal = new Decimal() with get,set
        member val Cold:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierProfileContext() = 
        member val Drivers:Int32 = new Int32() with get,set
        member val ProfileCount:Int32 = new Int32() with get,set
        member val PayPlanId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ZoneMode:String = null with get,set
        member val ZoneName:String = null with get,set
        member val ZoneCount:Int32 = new Int32() with get,set
        member val HasBookingPage:Boolean = new Boolean() with get,set
        member val HasRateConfig:Boolean = new Boolean() with get,set
        member val VehicleFacts:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type CourierProfileView() = 
        member val CourierProfileID:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val BusinessName:String = null with get,set
        member val RouteShape:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val TemplateFrom:String = null with get,set
        member val UnitOne:String = null with get,set
        member val UnitMany:String = null with get,set
        member val FacilityNoun:String = null with get,set
        member val UnitOneEs:String = null with get,set
        member val UnitManyEs:String = null with get,set
        member val FacilityNounEs:String = null with get,set
        member val TagMode:String = null with get,set
        member val TagFormats:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Pay:CourierPay = null with get,set
        member val Dispatch:CourierDispatch = null with get,set
        member val Missed:CourierMissed = null with get,set
        member val Privacy:CourierPrivacy = null with get,set
        member val Pricing:CourierPricing = null with get,set
        member val Booking:CourierBooking = null with get,set
        member val Facilities:ResizeArray<CourierFacilityView> = new ResizeArray<CourierFacilityView>() with get,set
        member val Vehicles:ResizeArray<CourierVehicleView> = new ResizeArray<CourierVehicleView>() with get,set
        member val Proof:Dictionary<String, Dictionary<String,String>> = new Dictionary<String, Dictionary<String,String>>() with get,set
        member val Context:CourierProfileContext = null with get,set

    [<AllowNullLiteral>]
    type CourierIssue() = 
        member val Key:String = null with get,set
        member val Section:String = null with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type CourierChange() = 
        member val Key:String = null with get,set
        member val Section:String = null with get,set
        member val Label:String = null with get,set
        member val From:String = null with get,set
        member val To:String = null with get,set

    [<AllowNullLiteral>]
    type CourierPreviewLine() = 
        member val K:String = null with get,set
        member val V:String = null with get,set
        member val Dot:String = null with get,set

    [<AllowNullLiteral>]
    type CourierPreview() = 
        member val DeadlineTitle:String = null with get,set
        member val DeadlineLead:String = null with get,set
        member val RoomW:String = null with get,set
        member val LastW:String = null with get,set
        member val GoW:String = null with get,set
        member val Zones:ResizeArray<CourierPreviewLine> = new ResizeArray<CourierPreviewLine>() with get,set
        member val PaySub:String = null with get,set
        member val PayRows:ResizeArray<CourierPreviewLine> = new ResizeArray<CourierPreviewLine>() with get,set
        member val PayTotal:String = null with get,set
        member val ProofRows:ResizeArray<CourierPreviewLine> = new ResizeArray<CourierPreviewLine>() with get,set
        member val Ping:String = null with get,set

    [<AllowNullLiteral>]
    type CourierFleetVehicle() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val UnitNumber:String = null with get,set
        member val Name:String = null with get,set
        member val VehicleType:String = null with get,set
        member val Unit:String = null with get,set
        member val Cap:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Cold:Boolean = new Boolean() with get,set
        member val Status:String = null with get,set
        member val Assigned:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierResponse() = 
        member val Profiles:ResizeArray<CourierProfileSummary> = new ResizeArray<CourierProfileSummary>() with get,set
        member val Templates:ResizeArray<CourierTemplateOption> = new ResizeArray<CourierTemplateOption>() with get,set
        member val Profile:CourierProfileView = null with get,set
        member val Issues:ResizeArray<CourierIssue> = new ResizeArray<CourierIssue>() with get,set
        member val Changes:ResizeArray<CourierChange> = new ResizeArray<CourierChange>() with get,set
        member val Preview:CourierPreview = null with get,set
        member val Fleet:ResizeArray<CourierFleetVehicle> = new ResizeArray<CourierFleetVehicle>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierProfileResetRequest() = 
        member val Id:Int32 = new Int32() with get,set
        member val DryRun:Boolean = new Boolean() with get,set

F# CourierProfileResetRequest DTOs

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>