Booklinker.API

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v2/collections
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 PostCollectionRequest
            Inherits V2BaseRequest
            Implements IPostCollectionRequest
            <DataMember(Name:="aliasDomain")>
            Public Overridable Property AliasDomain As String

            <DataMember(Name:="aliasCode")>
            Public Overridable Property AliasCode As String

            <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 V2BaseRequest
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses

        <DataContract>
        Public Partial Class PostCollectionResponse
            Inherits V2BaseResponse
            Implements IPostCollectionResponse
        End Class

        <DataContract>
        Public Partial Class V2BaseResponse
            <DataMember(Name:="responseStatus")>
            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 .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"aliasDomain":"String","aliasCode":"String","title":"String","collectionSettingsId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}