Trendsic Platform Service

<back to all web services

CourierRecurrencesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/recurrences
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 CourierRecurrencesRequest implements IConvertible
{
    int? ProfileId;

    CourierRecurrencesRequest({this.ProfileId});
    CourierRecurrencesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ProfileId = json['ProfileId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ProfileId': ProfileId
    };

    getTypeName() => "CourierRecurrencesRequest";
    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>[]),
    'CourierRecurrencesRequest': TypeInfo(TypeOf.Class, create:() => CourierRecurrencesRequest()),
});

Dart CourierRecurrencesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/dispatch/courier/recurrences HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Recurrences: 
	[
		{
			CourierRecurrenceID: 0,
			CourierProfileId: 0,
			ProfileName: String,
			CourierFacilityId: 0,
			CustomerContactId: 0,
			CustomerName: String,
			CustomerPhone: String,
			Address: String,
			Unit: String,
			City: String,
			Zip: String,
			Zone: String,
			Lat: 0,
			Lng: 0,
			Weekday: 0,
			WindowStart: String,
			WindowEnd: String,
			Cadence: String,
			AnchorDate: String,
			ServiceLevelCode: String,
			UnitsExpected: 0,
			Handoff: String,
			Instructions: String,
			PayMode: String,
			AccountCode: String,
			Paused: False,
			LastMaterializedDate: String,
			NextDate: String,
			SkipDates: 
			[
				String
			]
		}
	],
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}