| POST, GET | /api/InventoryImage |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Item | body | string | No | |
| ItemPk | body | long? | No | |
| ItemType | query | string | No | Model, SKU, or Serial. Defaults to Model. |
| NewImages | query | List<NewImageInfo> | No | Images (in Base64) to add to the Item. Only for POST. |
| UriImagePksToDelete | query | List<long> | No | URI Image PKs to remove from the Item. Only for POST. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FileName | form | string | No | |
| Description | form | string | No | |
| Base64Image | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Images | form | List<ImageInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Url | form | string | No | |
| ImageStream | form | string | No | |
| ImageSize | form | string | No | |
| ErrorMessage | form | string | No | |
| UriPk | form | long? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/InventoryImage HTTP/1.1
Host: active-ewebservice.biz
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Item":"String","ItemPk":0,"ItemType":"String","NewImages":[{"FileName":"String","Description":"String","Base64Image":"String"}],"UriImagePksToDelete":[0],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Images":[{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}