Booklinker.API

<back to all web services

GetImageRequest

Requires Authentication
The following routes are available for this service:
GET/v2/images/{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 GetImageResponse extends V2BaseResponse implements IGetImageResponse
{

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

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

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

TypeScript GetImageRequest 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/images/{Id} HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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