Booklinker.API

<back to all web services

DeleteCollectionRequest

Requires Authentication
The following routes are available for this service:
DELETE/v2/collections
DELETE/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 DeleteCollectionResponse extends V2BaseResponse
{

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

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

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

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

DELETE /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
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"}}}