Booklinker.API

<back to all web services

GetCollectionSettingsRequest

Requires Authentication 

// @DataContract
export class V2BaseResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<V2BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V2PageObject
{
    // @DataMember(Name="offset")
    public offset: number;

    // @DataMember(Name="limit")
    public limit: number;

    // @DataMember(Name="totalRecords")
    public totalRecords: number;

    public constructor(init?: Partial<V2PageObject>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V2PaginatedBaseResponse extends V2BaseResponse
{
    // @DataMember(Name="page")
    public page: V2PageObject;

    public constructor(init?: Partial<V2PaginatedBaseResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetCollectionsResponse extends V2PaginatedBaseResponse implements IGetCollectionsResponse
{

    public constructor(init?: Partial<GetCollectionsResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetCollectionSettingsRequest extends V2BaseResponse
{
    // @DataMember(Name="id")
    public id: string;

    public constructor(init?: Partial<GetCollectionSettingsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}}}