Home > Aria Crescendo Documentation > Aria Crescendo core api > get_client_item_images_m
get_client_item_images_m
get_client_item_images_m
Table of contents
Returns all images associated with a given inventory item
Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
| client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | |
| auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | |
| item_no | long | 22 | The item number by which to search for images | |
| OR | ||||
| client_sku | string array | 100 | Client SKU of the NSO/Inventory item |
Output Arguments
| Field Name | Field Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| item_images | hash | |||||||
 image_class_name |
string | The category of the image, such as thumbnail or full | ||||||
| image_class_no |
long | The unique ID for the image class | ||||||
| image_class_seq_no |
long | The sequence number of this image within its class | ||||||
| image_url |
string | The actual URL for this image | ||||||
| image_text |
string | The alt text for the image tag displaying the item image | ||||||
| default_ind |
long | Whether or not this image is the default for that item
Allowable values for default_ind
|
||||||
| error_code | long | Aria-assigned error identifier. 0 indicates no error. | ||||||
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
- © Copyright 2023 Aria Developer Central