Client_Initiations

<back to all web services

ContainerItemsRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/containerItems
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Client_Initiations.ServiceModel.ClientUpload

Namespace Global

    Namespace Client_Initiations.ServiceModel.ClientUpload

        Public Partial Class ContainerItemsRequest
            Inherits DocumentRequestBase
        End Class

        Public Partial Class ContainerItemsResponse
            Inherits ResponseBase
            Public Sub New()
                ContainerItems = New List(Of String)
            End Sub

            Public Overridable Property ContainerItems As List(Of String)
        End Class

        Public Partial Class DocumentRequestBase
            '''<Summary>
            '''ExternalID
            '''</Summary>
            <ApiMember(Description:="ExternalID", ExcludeInSchema:=true, IsRequired:=true, ParameterType:="path")>
            Public Overridable Property ExternalId As String
        End Class

        Public Partial Class ResponseBase
            Public Overridable Property Message As String
            Public Overridable Property IsSuccess As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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-pen.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}