Client_Initiations

<back to all web services

ContainerItemsRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/containerItems
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentRequestBase:
    # @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    external_id: Optional[str] = None
    """
    ExternalID
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContainerItemsRequest(DocumentRequestBase):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseBase:
    message: Optional[str] = None
    is_success: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContainerItemsResponse(ResponseBase):
    container_items: Optional[List[str]] = None

Python ContainerItemsRequest 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/containerItems HTTP/1.1 
Host: initiation-test.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ContainerItemsResponse 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>
  <ContainerItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContainerItems>
</ContainerItemsResponse>