Booklinker.API

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v2/collections

// @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 PostCollectionResponse extends V2BaseResponse implements IPostCollectionResponse
{

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

// @DataContract
export class PostCollectionRequest extends V2BaseRequest implements IPostCollectionRequest
{
    // @DataMember(Name="aliasDomain")
    public aliasDomain: string;

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

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

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

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

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

TypeScript PostCollectionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

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