Booklinker.API

<back to all web services

GetCollectionSettingsRequest

Requires Authentication 
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 GetCollectionSettingsRequest
            Inherits V2BaseResponse
            <DataMember(Name:="id")>
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Booklinker.API.ServiceModel.V2.Responses

        <DataContract>
        Public Partial Class GetCollectionsResponse
            Inherits V2PaginatedBaseResponse
            Implements IGetCollectionsResponse
        End Class

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

        <DataContract>
        Public Partial Class V2PageObject
            <DataMember(Name:="offset")>
            Public Overridable Property Offset As Integer

            <DataMember(Name:="limit")>
            Public Overridable Property Limit As Integer

            <DataMember(Name:="totalRecords")>
            Public Overridable Property TotalRecords As Integer
        End Class

        <DataContract>
        Public Partial Class V2PaginatedBaseResponse
            Inherits V2BaseResponse
            <DataMember(Name:="page")>
            Public Overridable Property Page As V2PageObject
        End Class
    End Namespace
End Namespace

VB.NET GetCollectionSettingsRequest 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 /csv/reply/GetCollectionSettingsRequest HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"page":{"offset":0,"limit":0,"totalRecords":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}