AIM Web Services

<back to all web services

ServiceTableRequest

ServiceTable
Requires active-e Service Tickets Service

The following routes are available for this service:
GET/api/ServiceTable
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
ServiceTableResponse Parameters:
NameParameterData TypeRequiredDescription
ServiceTableformList<ServiceTableEntry>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ServiceTableEntry Parameters:
NameParameterData TypeRequiredDescription
PkformlongNo
DescformstringNo
CatDescformstringNo
SubDescformstringNo
RateformdecimalNo
TimeformdecimalNo
DefaultTechformstringNo

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/ServiceTable HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ServiceTableResponse 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>
  <ServiceTable>
    <ServiceTableResponse.ServiceTableEntry>
      <CatDesc>String</CatDesc>
      <DefaultTech>String</DefaultTech>
      <Desc>String</Desc>
      <Pk>0</Pk>
      <Rate>0</Rate>
      <SubDesc>String</SubDesc>
      <Time>0</Time>
    </ServiceTableResponse.ServiceTableEntry>
  </ServiceTable>
</ServiceTableResponse>