| GET | /v1/shortlink/metadata |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AliasDomain | query | string | No | |
| AliasCode | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BaseCode | form | string | No | |
| Domain | form | string | No | |
| Code | form | string | No | |
| ProductMetadata | form | ProductMetadata | No | |
| Destinations | form | List<Destination> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| Author | form | string | No | |
| Url | form | Uri | No | |
| Description | form | string | No | |
| Retailer | form | string | No | |
| ProductImages | form | IDictionary<string, Uri> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsSuggestion | form | bool | No | |
| IsAutoSuggestion | form | bool | No | |
| DestinationUrl | form | string | No | |
| ReplacementButton | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}