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}

// @DataContract
export class V2BaseRequest
{

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

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

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

// @DataContract
export class PutCollectionResponse extends V2BaseResponse
{

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

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

    // @DataMember(Name="title")
    public title: string;

    // @DataMember(Name="linkIds")
    public linkIds: string[];

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

TypeScript PutCollectionRequest 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.

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

{"id":"String","title":"String","linkIds":["String"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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