Booklinker.API

PostLinkCreationRequest

The following routes are available for this service:
POST	/v1/links
POST	/v1/complete-link-creation-requests


// @DataContract
export class PostLinkCreationRequestBase
{
    // @DataMember(Name="url")
    // @ApiMember(IsRequired=true)
    public url: string;

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

    // @DataMember(Name="parameterKeyValues")
    public parameterKeyValues: { [index:string]: string; };

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

// @DataContract
export class ProductMetadata extends ProductMetadata
{

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

// @DataContract
export class PostLinkCreationResponse
{
    // @DataMember(Name="success")
    public success: boolean;

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

    // @DataMember(Name="destinations")
    public destinations: ProductMetadata[];

    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

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

export class PostLinkCreationRequest extends PostLinkCreationRequestBase
{
    // @DataMember(Name="code")
    public code: string;

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

// @DataContract
export class ProductMetadata
{
    // @DataMember(Name="title")
    public title: string;

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

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

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

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

    // @DataMember(Name="productImages")
    public productImages: { [index:string]: string; };

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

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

POST /v1/links HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	code: String,
	url: String,
	domain: String,
	parameterKeyValues: 
	{
		String: String
	}
}

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

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