| GET | /api/GetImage |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerAcct | query | integer | No | If sent, image(s) for this customer will be returned. |
| InventoryPk | query | integer | No | If sent, image(s) for this inventory item will be returned. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| 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 .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.
GET /api/GetImage HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}