AIM Web Services

<back to all web services

ReturnLoanersRequest

ReturnLoaners
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

The following routes are available for this service:
GET/api/ReturnLoaners
ReturnLoanersRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerAccountqueryintNo
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
ReturnLoanersResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<LoanerItem>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
LoanerItem Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DateformDateTimeNo
RefNumberformstringNo
QuantityformdecimalNo
ItemformstringNo
DescriptionformstringNo
PriceformdecimalNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ReturnLoaners HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Items":[{"Id":0,"RefNumber":"String","Quantity":0,"Item":"String","Description":"String","Price":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}