Booklinker.API

<back to all web services

GetShortLinkMetadataRequest

The following routes are available for this service:
GET/v1/shortlink/metadata

// @DataContract
export class ProductMetadata extends ProductMetadata
{

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

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

    // @DataMember(Name="isAutoSuggestion")
    public isAutoSuggestion: boolean;

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

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

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

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

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

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

    // @DataMember(Name="productMetadata")
    public productMetadata: ProductMetadata;

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

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

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

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

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

    public constructor(init?: Partial<GetShortLinkMetadataRequest>) { (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 GetShortLinkMetadataRequest DTOs

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

HTTP + CSV

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

GET /v1/shortlink/metadata HTTP/1.1 
Host: api.booklinker.com 
Accept: text/csv

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

{"baseCode":"String","domain":"String","code":"String","productMetadata":{"title":"String","author":"String","description":"String","retailer":"String"},"destinations":[{"isSuggestion":false,"isAutoSuggestion":false,"destinationUrl":"String","replacementButton":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}