CollectionsAPI

PostCollectionRequest

The following routes are available for this service:
POST	/v4/collections

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CollectionsAPI.ServiceModel.V4.Requests
Imports CollectionsAPI.ServiceModel.V4.Responses
Imports CollectionsAPI.Contracts.V4.Responses

Namespace Global

    Namespace CollectionsAPI.Contracts.V4.Responses

        Public Interface IPostCollectionResponseData
            Property Id As String
        End Interface
    End Namespace

    Namespace CollectionsAPI.ServiceModel.V4.Requests

        <DataContract>
        Public Partial Class PostCollectionRequest
            Inherits V4BaseRequest
            Implements IPostCollectionRequest
            <DataMember(Name:="title")>
            Public Overridable Property Title As String Implements IPostCollectionRequest.Title

            <DataMember(Name:="linkIds")>
            Public Overridable Property LinkIds As IEnumerable(Of String) Implements IPostCollectionRequest.LinkIds

            <DataMember(Name:="collectionSettingsId")>
            Public Overridable Property CollectionSettingsId As String Implements IPostCollectionRequest.CollectionSettingsId
        End Class

        <DataContract>
        Public Partial Class V4BaseRequest
        End Class
    End Namespace

    Namespace CollectionsAPI.ServiceModel.V4.Responses

        <DataContract>
        Public Partial Class PostCollectionResponse
            Inherits V4BaseResponse
            Implements IPostCollectionResponse
            <DataMember(Name:="data")>
            Public Overridable Property Data As IPostCollectionResponseData Implements IPostCollectionResponse.Data
        End Class

        <DataContract>
        Public Partial Class V4BaseResponse
            <DataMember(Name:="status")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET PostCollectionRequest 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 /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostCollectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Requests">
  <collectionSettingsId>String</collectionSettingsId>
  <linkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <title>String</title>
</PostCollectionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <status xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </status>
  <data i:nil="true" />
</PostCollectionResponse>