AIM Web Services

ContractScheduledReturnsRequest

ContractScheduledReturns
Requires active-e Contracts Service.

The following routes are available for this service:
GET	/api/ContractScheduledReturns

**ContractScheduledReturnsRequest** Parameters:
Name	Parameter	Data Type	Required
DateFrom	query	DateTime?	No
DateTo	query	DateTime?	No
DistrictId	query	long?	No
SchoolId	query	long?	No
LocationId	query	long?	No
StatusId	query	long?	No
OptionId	query	long?	No
IncludeReturned	query	bool?	No
LanId	query	string	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**ContractScheduledReturnsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Contracts	form	List<ContractScheduledReturnInfo>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
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

**ContractScheduledReturnInfo** Parameters:
Name	Parameter	Data Type	Required
Acct	form	int	No
Sub	form	int	No
Name	form	string	No
Address	form	string	No
Address2	form	string	No
City	form	string	No
Student	form	string	No
School	form	string	No
District	form	string	No
Item	form	string	No
Employee	form	string	No
ReturnedDate	form	DateTime?	No
ScheduledReturnDate	form	DateTime	No
StockNumber	form	string	No
Serial	form	string	No
ReturnOption	form	string	No
ScheduledReturnedRef	form	string	No
Status	form	string	No
AutoPayHoldDate	form	DateTime?	No
MobileReturnedStatus	form	bool	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.

GET /api/ContractScheduledReturns HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ContractScheduledReturnsResponse 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>
  <Contracts>
    <ContractScheduledReturnInfo>
      <Acct>0</Acct>
      <Address>String</Address>
      <Address2>String</Address2>
      <AutoPayHoldDate>0001-01-01T00:00:00</AutoPayHoldDate>
      <City>String</City>
      <District>String</District>
      <Employee>String</Employee>
      <Item>String</Item>
      <MobileReturnedStatus>false</MobileReturnedStatus>
      <Name>String</Name>
      <ReturnOption>String</ReturnOption>
      <ReturnedDate>0001-01-01T00:00:00</ReturnedDate>
      <ScheduledReturnDate>0001-01-01T00:00:00</ScheduledReturnDate>
      <ScheduledReturnedRef>String</ScheduledReturnedRef>
      <School>String</School>
      <Serial>String</Serial>
      <Status>String</Status>
      <StockNumber>String</StockNumber>
      <Student>String</Student>
      <Sub>0</Sub>
    </ContractScheduledReturnInfo>
  </Contracts>
</ContractScheduledReturnsResponse>

AIM Web Services

ContractScheduledReturnsRequest

ContractScheduledReturns Requires active-e Contracts Service.

HTTP + XML

ContractScheduledReturns
Requires active-e Contracts Service.