Booklinker.API

<back to all web services

PutCollectionRequest

Requires Authentication
The following routes are available for this service:
PUT/v2/collections
PUT/v2/collections/{Id}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Booklinker.API.ServiceModel.V2.Requests
Imports Booklinker.API.ServiceModel.V2.Responses

Namespace Global

    Namespace Booklinker.API.ServiceModel.V2.Requests

        <DataContract>
        Public Partial Class PutCollectionRequest
            Inherits V2BaseRequest
            <DataMember(Name:="id")>
            Public Overridable Property Id As String

            <DataMember(Name:="title")>
            Public Overridable Property Title As String

            <DataMember(Name:="linkIds")>
            Public Overridable Property LinkIds As List(Of String)
        End Class

        <DataContract>
        Public Partial Class V2BaseRequest
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses

        <DataContract>
        Public Partial Class PutCollectionResponse
            Inherits V2BaseResponse
        End Class

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

VB.NET PutCollectionRequest 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.

PUT /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutCollectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Requests">
  <id>String</id>
  <linkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </linkIds>
  <title>String</title>
</PutCollectionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PutCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
  <responseStatus 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>
  </responseStatus>
</PutCollectionResponse>