Trendsic Platform Service

<back to all web services

CourierRecurrenceSaveRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/recurrences
PUT,OPTIONS/v1/dispatch/courier/recurrences/{Id}
import 'package:servicestack/servicestack.dart';

class CourierRecurrenceView implements IConvertible
{
    int? CourierRecurrenceID;
    int? CourierProfileId;
    String? ProfileName;
    int? CourierFacilityId;
    int? CustomerContactId;
    String? CustomerName;
    String? CustomerPhone;
    String? Address;
    String? Unit;
    String? City;
    String? Zip;
    String? Zone;
    double? Lat;
    double? Lng;
    int? Weekday;
    String? WindowStart;
    String? WindowEnd;
    String? Cadence;
    String? AnchorDate;
    String? ServiceLevelCode;
    int? UnitsExpected;
    String? Handoff;
    String? Instructions;
    String? PayMode;
    String? AccountCode;
    bool? Paused;
    String? LastMaterializedDate;
    String? NextDate;
    List<String>? SkipDates = [];

    CourierRecurrenceView({this.CourierRecurrenceID,this.CourierProfileId,this.ProfileName,this.CourierFacilityId,this.CustomerContactId,this.CustomerName,this.CustomerPhone,this.Address,this.Unit,this.City,this.Zip,this.Zone,this.Lat,this.Lng,this.Weekday,this.WindowStart,this.WindowEnd,this.Cadence,this.AnchorDate,this.ServiceLevelCode,this.UnitsExpected,this.Handoff,this.Instructions,this.PayMode,this.AccountCode,this.Paused,this.LastMaterializedDate,this.NextDate,this.SkipDates});
    CourierRecurrenceView.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CourierRecurrenceID = json['CourierRecurrenceID'];
        CourierProfileId = json['CourierProfileId'];
        ProfileName = json['ProfileName'];
        CourierFacilityId = json['CourierFacilityId'];
        CustomerContactId = json['CustomerContactId'];
        CustomerName = json['CustomerName'];
        CustomerPhone = json['CustomerPhone'];
        Address = json['Address'];
        Unit = json['Unit'];
        City = json['City'];
        Zip = json['Zip'];
        Zone = json['Zone'];
        Lat = JsonConverters.toDouble(json['Lat']);
        Lng = JsonConverters.toDouble(json['Lng']);
        Weekday = json['Weekday'];
        WindowStart = json['WindowStart'];
        WindowEnd = json['WindowEnd'];
        Cadence = json['Cadence'];
        AnchorDate = json['AnchorDate'];
        ServiceLevelCode = json['ServiceLevelCode'];
        UnitsExpected = json['UnitsExpected'];
        Handoff = json['Handoff'];
        Instructions = json['Instructions'];
        PayMode = json['PayMode'];
        AccountCode = json['AccountCode'];
        Paused = json['Paused'];
        LastMaterializedDate = json['LastMaterializedDate'];
        NextDate = json['NextDate'];
        SkipDates = JsonConverters.fromJson(json['SkipDates'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CourierRecurrenceID': CourierRecurrenceID,
        'CourierProfileId': CourierProfileId,
        'ProfileName': ProfileName,
        'CourierFacilityId': CourierFacilityId,
        'CustomerContactId': CustomerContactId,
        'CustomerName': CustomerName,
        'CustomerPhone': CustomerPhone,
        'Address': Address,
        'Unit': Unit,
        'City': City,
        'Zip': Zip,
        'Zone': Zone,
        'Lat': Lat,
        'Lng': Lng,
        'Weekday': Weekday,
        'WindowStart': WindowStart,
        'WindowEnd': WindowEnd,
        'Cadence': Cadence,
        'AnchorDate': AnchorDate,
        'ServiceLevelCode': ServiceLevelCode,
        'UnitsExpected': UnitsExpected,
        'Handoff': Handoff,
        'Instructions': Instructions,
        'PayMode': PayMode,
        'AccountCode': AccountCode,
        'Paused': Paused,
        'LastMaterializedDate': LastMaterializedDate,
        'NextDate': NextDate,
        'SkipDates': JsonConverters.toJson(SkipDates,'List<String>',context!)
    };

    getTypeName() => "CourierRecurrenceView";
    TypeContext? context = _ctx;
}

class CourierRecurrenceResponse implements IConvertible
{
    List<CourierRecurrenceView>? Recurrences = [];
    String? Message;
    ResponseStatus? ResponseStatus;

    CourierRecurrenceResponse({this.Recurrences,this.Message,this.ResponseStatus});
    CourierRecurrenceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Recurrences = JsonConverters.fromJson(json['Recurrences'],'List<CourierRecurrenceView>',context!);
        Message = json['Message'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Recurrences': JsonConverters.toJson(Recurrences,'List<CourierRecurrenceView>',context!),
        'Message': Message,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "CourierRecurrenceResponse";
    TypeContext? context = _ctx;
}

class CourierRecurrenceSaveRequest implements IConvertible
{
    int? Id;
    CourierRecurrenceView? Recurrence;

    CourierRecurrenceSaveRequest({this.Id,this.Recurrence});
    CourierRecurrenceSaveRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Recurrence = JsonConverters.fromJson(json['Recurrence'],'CourierRecurrenceView',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Recurrence': JsonConverters.toJson(Recurrence,'CourierRecurrenceView',context!)
    };

    getTypeName() => "CourierRecurrenceSaveRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'CourierRecurrenceView': TypeInfo(TypeOf.Class, create:() => CourierRecurrenceView()),
    'CourierRecurrenceResponse': TypeInfo(TypeOf.Class, create:() => CourierRecurrenceResponse()),
    'List<CourierRecurrenceView>': TypeInfo(TypeOf.Class, create:() => <CourierRecurrenceView>[]),
    'CourierRecurrenceSaveRequest': TypeInfo(TypeOf.Class, create:() => CourierRecurrenceSaveRequest()),
});

Dart CourierRecurrenceSaveRequest 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.

POST /v1/dispatch/courier/recurrences HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierRecurrenceSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>0</Id>
  <Recurrence>
    <AccountCode>String</AccountCode>
    <Address>String</Address>
    <AnchorDate>String</AnchorDate>
    <Cadence>String</Cadence>
    <City>String</City>
    <CourierFacilityId>0</CourierFacilityId>
    <CourierProfileId>0</CourierProfileId>
    <CourierRecurrenceID>0</CourierRecurrenceID>
    <CustomerContactId>0</CustomerContactId>
    <CustomerName>String</CustomerName>
    <CustomerPhone>String</CustomerPhone>
    <Handoff>String</Handoff>
    <Instructions>String</Instructions>
    <LastMaterializedDate>String</LastMaterializedDate>
    <Lat>0</Lat>
    <Lng>0</Lng>
    <NextDate>String</NextDate>
    <Paused>false</Paused>
    <PayMode>String</PayMode>
    <ProfileName>String</ProfileName>
    <ServiceLevelCode>String</ServiceLevelCode>
    <SkipDates xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </SkipDates>
    <Unit>String</Unit>
    <UnitsExpected>0</UnitsExpected>
    <Weekday>0</Weekday>
    <WindowEnd>String</WindowEnd>
    <WindowStart>String</WindowStart>
    <Zip>String</Zip>
    <Zone>String</Zone>
  </Recurrence>
</CourierRecurrenceSaveRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierRecurrenceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Message>String</Message>
  <Recurrences>
    <CourierRecurrenceView>
      <AccountCode>String</AccountCode>
      <Address>String</Address>
      <AnchorDate>String</AnchorDate>
      <Cadence>String</Cadence>
      <City>String</City>
      <CourierFacilityId>0</CourierFacilityId>
      <CourierProfileId>0</CourierProfileId>
      <CourierRecurrenceID>0</CourierRecurrenceID>
      <CustomerContactId>0</CustomerContactId>
      <CustomerName>String</CustomerName>
      <CustomerPhone>String</CustomerPhone>
      <Handoff>String</Handoff>
      <Instructions>String</Instructions>
      <LastMaterializedDate>String</LastMaterializedDate>
      <Lat>0</Lat>
      <Lng>0</Lng>
      <NextDate>String</NextDate>
      <Paused>false</Paused>
      <PayMode>String</PayMode>
      <ProfileName>String</ProfileName>
      <ServiceLevelCode>String</ServiceLevelCode>
      <SkipDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </SkipDates>
      <Unit>String</Unit>
      <UnitsExpected>0</UnitsExpected>
      <Weekday>0</Weekday>
      <WindowEnd>String</WindowEnd>
      <WindowStart>String</WindowStart>
      <Zip>String</Zip>
      <Zone>String</Zone>
    </CourierRecurrenceView>
  </Recurrences>
  <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>
</CourierRecurrenceResponse>