AIM Web Services

<back to all web services

InventoryImageRequest

InventoryImage
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/InventoryImage
InventoryImageRequest Parameters:
NameParameterData TypeRequiredDescription
ItembodystringNo
ItemPkbodylong?No
ItemTypequerystringNoModel, SKU, or Serial. Defaults to Model.
NewImagesqueryList<NewImageInfo>NoImages (in Base64) to add to the Item. Only for POST.
UriImagePksToDeletequeryList<long>NoURI Image PKs to remove from the Item. Only for POST.
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
NewImageInfo Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
DescriptionformstringNo
Base64ImageformstringNo
InventoryImageResponse Parameters:
NameParameterData TypeRequiredDescription
ImagesformList<ImageInfo>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ImageInfo Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
ImageStreamformstringNo
ImageSizeformstringNo
ErrorMessageformstringNo
UriPkformlong?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<InventoryImageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Item>String</Item>
  <ItemPk>0</ItemPk>
  <ItemType>String</ItemType>
  <NewImages>
    <InventoryImageRequest.NewImageInfo>
      <Base64Image>String</Base64Image>
      <Description>String</Description>
      <FileName>String</FileName>
    </InventoryImageRequest.NewImageInfo>
  </NewImages>
  <UriImagePksToDelete xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </UriImagePksToDelete>
</InventoryImageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InventoryImageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Images>
    <ImageInfo>
      <ErrorMessage>String</ErrorMessage>
      <ImageSize>String</ImageSize>
      <ImageStream>String</ImageStream>
      <UriPk>0</UriPk>
      <Url>String</Url>
    </ImageInfo>
  </Images>
</InventoryImageResponse>