AIM Web Services

<back to all web services

ContractDefaultListingRequest

ContractDefaultListing
Requires active-e Contracts Service.

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

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

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

<ContractDefaultListingResponse 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>
  <ContractDefaults>
    <ContractDefaultListingResponse.ContractDefaultInfo>
      <Description>String</Description>
      <FullType>String</FullType>
      <Id>0</Id>
      <RdfType>String</RdfType>
      <WebDescription>String</WebDescription>
    </ContractDefaultListingResponse.ContractDefaultInfo>
  </ContractDefaults>
</ContractDefaultListingResponse>