Trendsic Platform Service

<back to all web services

PickupsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/logistics/pickups
import 'package:servicestack/servicestack.dart';

class RecordsPickupDto implements IConvertible
{
    int? PickupId;
    String? PickupKey;
    String? VendorName;
    String? VendorCert;
    String? Status;
    String? WfLabel;
    String? RunLabel;
    String? ManifestJson;
    String? QuoteJson;
    String? WindowLabel;
    String? VendorCertRef;
    String? LogJson;

    RecordsPickupDto({this.PickupId,this.PickupKey,this.VendorName,this.VendorCert,this.Status,this.WfLabel,this.RunLabel,this.ManifestJson,this.QuoteJson,this.WindowLabel,this.VendorCertRef,this.LogJson});
    RecordsPickupDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PickupId = json['PickupId'];
        PickupKey = json['PickupKey'];
        VendorName = json['VendorName'];
        VendorCert = json['VendorCert'];
        Status = json['Status'];
        WfLabel = json['WfLabel'];
        RunLabel = json['RunLabel'];
        ManifestJson = json['ManifestJson'];
        QuoteJson = json['QuoteJson'];
        WindowLabel = json['WindowLabel'];
        VendorCertRef = json['VendorCertRef'];
        LogJson = json['LogJson'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PickupId': PickupId,
        'PickupKey': PickupKey,
        'VendorName': VendorName,
        'VendorCert': VendorCert,
        'Status': Status,
        'WfLabel': WfLabel,
        'RunLabel': RunLabel,
        'ManifestJson': ManifestJson,
        'QuoteJson': QuoteJson,
        'WindowLabel': WindowLabel,
        'VendorCertRef': VendorCertRef,
        'LogJson': LogJson
    };

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

class PickupsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<RecordsPickupDto>? Pickups = [];

    PickupsResponse({this.ResponseStatus,this.Pickups});
    PickupsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class PickupsRequest implements IConvertible
{
    PickupsRequest();
    PickupsRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PickupsRequest";
    TypeContext? context = _ctx;
}

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

Dart PickupsRequest 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/records/logistics/pickups HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Pickups: 
	[
		{
			PickupId: 0,
			PickupKey: String,
			VendorName: String,
			VendorCert: String,
			Status: String,
			WfLabel: String,
			RunLabel: String,
			ManifestJson: String,
			QuoteJson: String,
			WindowLabel: String,
			VendorCertRef: String,
			LogJson: String
		}
	]
}