Client_Initiations

<back to all web services

ContainerItemsRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/containerItems
import 'package:servicestack/servicestack.dart';

abstract class DocumentRequestBase
{
    /**
    * ExternalID
    */
    // @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    String? ExternalId;

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

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

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

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

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

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "ContainerItemsRequest";
    TypeContext? context = _ctx;
}

abstract class ResponseBase
{
    String? Message;
    bool? IsSuccess;

    ResponseBase({this.Message,this.IsSuccess});
    ResponseBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class ContainerItemsResponse extends ResponseBase implements IConvertible
{
    List<String>? ContainerItems;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ContainerItems': JsonConverters.toJson(ContainerItems,'List<String>',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'initiation.sirva.com', types: <String, TypeInfo> {
    'DocumentRequestBase': TypeInfo(TypeOf.AbstractClass),
    'ContainerItemsRequest': TypeInfo(TypeOf.Class, create:() => ContainerItemsRequest()),
    'ResponseBase': TypeInfo(TypeOf.AbstractClass),
    'ContainerItemsResponse': TypeInfo(TypeOf.Class, create:() => ContainerItemsResponse()),
});

Dart ContainerItemsRequest DTOs

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

HTTP + CSV

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

POST /documents/containerItems HTTP/1.1 
Host: initiation.sirva.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ExternalId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ContainerItems":["String"],"Message":"String","IsSuccess":false}