All Verbs | /service/RasterizePdf |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Key | query | string | No | |
BucketName | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Pages | form | List<ProductCatalogPage> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CatalogId | form | string | No | |
SectionId | form | string | No | |
PageNum | form | int | No | |
Position | form | int | No | |
RepCustom | form | bool | No | |
MediaId | form | string | No | |
ModifiedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
Label | form | string | No | |
Attributes | form | ProductCatalogPageAttributes | No | |
Url | form | string | No | |
Overview | form | string | No | |
Description | form | string | No | |
Width | form | double? | No | |
Height | form | double? | No | |
Type | form | string | No | |
PageCount | form | int? | No | |
Layout | form | string | No | |
Hotspots | form | List<ProductCatalogHotspot> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Euid | form | Guid? | No | |
Label | form | string | No | |
Description | form | string | No | |
Overview | form | string | No | |
Realm | form | string | No | |
Url | form | string | No | |
ContentType | form | string | No | |
Height | form | double? | No | |
Width | form | double? | No | |
RefId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
PageId | form | string | No | |
Action | form | HotspotActions | No | |
ProductId | form | string | No | |
MediaId | form | string | No | |
YouTubeId | form | string | No | |
ExternalResource | form | string | No | |
LinkedSectionId | form | string | No | |
LinkedCatalogId | form | string | No | |
LinkedPageId | form | string | No | |
Meta | form | Dictionary<string, string> | No | |
ProductIds | form | IEnumerable<string> | No | |
OriginalWidth | form | int | No | |
OriginalHeight | form | int | No | |
Left | form | int | No | |
Top | form | int | No | |
Right | form | int | No | |
Bottom | form | int | No | |
Width | form | int | No | |
Height | form | int | No | |
Generated | form | bool | No | |
RepCustom | form | bool | No | |
Position | form | int | No | |
ModifiedOn | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/RasterizePdf HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
key: String,
bucketName: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { pages: [ { id: String, catalogId: String, sectionId: String, pageNum: 0, position: 0, repCustom: False, mediaId: String, modifiedOn: 0001-01-01, lastModifiedOn: 0001-01-01, label: String, attributes: { id: 0, euid: 00000000-0000-0000-0000-000000000000, label: String, description: String, overview: String, realm: String, url: String, contentType: String, height: 0, width: 0, refId: String }, url: String, overview: String, description: String, width: 0, height: 0, type: String, pageCount: 0, layout: String, hotspots: [ { id: String, pageId: String, action: None, productId: String, meta: { String: String }, originalWidth: 0, originalHeight: 0, left: 0, top: 0, right: 0, bottom: 0, width: 0, height: 0, generated: False, repCustom: False, position: 0, modifiedOn: 0001-01-01 } ] } ] }