| All Verbs | /service/DetectTextProductCatalog |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BlockType | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Label | form | string | No | |
| Type | form | string | No | |
| Cover | form | string | No | |
| Position | form | int | No | |
| HideB2B | form | bool | No | |
| RepCustom | form | bool | No | |
| CreatedBy | form | string | No | |
| CreatedOn | form | DateTime | No | |
| ModifiedOn | form | DateTime | No | |
| ExpiresOn | form | DateTime | No | |
| PublishOn | form | DateTime | No | |
| Active | form | bool | No | |
| VendorId | form | string | No | |
| Sections | form | List<ProductCatalogSection> | No | |
| Tags | form | Dictionary<string, HashSet<String>> | No | |
| Attributes | form | ProductCatalogAttributes | No | |
| Layout | form | string | No | |
| Width | form | double? | No | |
| Height | form | double? | No | |
| FirstPageBlank | form | bool? | No | |
| ArtboardWidth | form | int | No | |
| ArtboardHeight | form | int | No | |
| ArtboardPageCount | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | K | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| CatalogId | form | string | No | |
| Label | form | string | No | |
| Cover | form | string | No | |
| Position | form | int | No | |
| StartPageNum | form | int? | No | |
| EndPageNum | form | int? | No | |
| PageCount | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Layout | form | string | No | |
| OffsetPage | form | string | No | |
| Height | form | double? | No | |
| Width | form | double? | No | |
| FirstPageBlank | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Catalog | form | ProductCatalog | No | |
| Hotspots | form | List<ProductCatalogHotspot> | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/DetectTextProductCatalog HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"blockType":"String","id":"String","label":"String","type":"String","cover":"String","position":0,"hideB2B":false,"repCustom":false,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","modifiedOn":"0001-01-01T00:00:00.0000000Z","expiresOn":"0001-01-01T00:00:00.0000000Z","publishOn":"0001-01-01T00:00:00.0000000Z","active":false,"vendorId":"String","sections":[{"id":"String","catalogId":"String","label":"String","cover":"String","position":0,"startPageNum":0,"endPageNum":0,"pageCount":0}],"tags":{"String":["String"]},"attributes":{"layout":"String","offsetPage":"String","height":0,"width":0,"firstPageBlank":false},"layout":"String","width":0,"height":0,"firstPageBlank":false,"artboardWidth":0,"artboardHeight":0,"artboardPageCount":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"catalog":{"id":"String","label":"String","type":"String","cover":"String","position":0,"hideB2B":false,"repCustom":false,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","modifiedOn":"0001-01-01T00:00:00.0000000Z","expiresOn":"0001-01-01T00:00:00.0000000Z","publishOn":"0001-01-01T00:00:00.0000000Z","active":false,"vendorId":"String","sections":[{"id":"String","catalogId":"String","label":"String","cover":"String","position":0,"startPageNum":0,"endPageNum":0,"pageCount":0}],"tags":{"String":["String"]},"attributes":{"layout":"String","offsetPage":"String","height":0,"width":0,"firstPageBlank":false},"layout":"String","width":0,"height":0,"firstPageBlank":false,"artboardWidth":0,"artboardHeight":0,"artboardPageCount":0},"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-01T00:00:00.0000000Z"}]}