Booklinker.API

GetCollectionRequest

The following routes are available for this service:
GET	/v2/collections
GET	/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 UserCollection implements IUserCollection
{
    // @DataMember(Name="type")
    public type: string;

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

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

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

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

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

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

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

// @DataContract
export class GetCollectionResponse extends V2BaseResponse
{
    // @DataMember(Name="data")
    public data: UserCollection;

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

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

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

TypeScript GetCollectionRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv

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

{
	data: 
	{
		type: collection,
		id: String,
		baseCode: String,
		url: String,
		title: String,
		collectionSettingsId: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}