AIM Web Services

<back to all web services

ContractStatusListingRequest

ContractStatusListing
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/ContractStatusListing
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
ContractStatusListingResponse Parameters:
NameParameterData TypeRequiredDescription
ContractStatusesformList<ContractStatusInfo>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ContractStatusInfo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DescriptionformstringNo
WebDescriptionformstringNo

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/ContractStatusListing HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ContractStatusListingResponse 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>
  <ContractStatuses>
    <ContractStatusListingResponse.ContractStatusInfo>
      <Description>String</Description>
      <Id>0</Id>
      <WebDescription>String</WebDescription>
    </ContractStatusListingResponse.ContractStatusInfo>
  </ContractStatuses>
</ContractStatusListingResponse>