Client_Initiations

<back to all web services

ContainerDeleteRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/deleteContainer
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 ContainerDeleteRequest extends DocumentRequestBase implements IConvertible
{
    ContainerDeleteRequest();
    ContainerDeleteRequest.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() => "ContainerDeleteRequest";
    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 ContainerDeleteResponse extends ResponseBase implements IConvertible
{
    ContainerDeleteResponse();
    ContainerDeleteResponse.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() => "ContainerDeleteResponse";
    TypeContext? context = _ctx;
}

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

Dart ContainerDeleteRequest 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 /documents/deleteContainer HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContainerDeleteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <ExternalId>String</ExternalId>
</ContainerDeleteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContainerDeleteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <IsSuccess>false</IsSuccess>
  <Message>String</Message>
</ContainerDeleteResponse>