AIM Web Services

<back to all web services

GetServiceEstimatesRequest

GetServiceEstimates
Requires active-e Service Tickets Service

The following routes are available for this service:
GET/api/GetServiceEstimates
GetServiceEstimatesRequest Parameters:
NameParameterData TypeRequiredDescription
UseWebFormattingquerybool?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
GetServiceEstimatesResponse Parameters:
NameParameterData TypeRequiredDescription
ServiceEstimatesformList<ServiceEstimate>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ServiceEstimate Parameters:
NameParameterData TypeRequiredDescription
TicketNumberformstringNo
EstimatedAmountformdecimalNo
DateTimeformDateTimeNo
InventoryItemformstringNo
ServiceDescriptionformstringNo
NotesformstringNo

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

<GetServiceEstimatesResponse 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>
  <ServiceEstimates>
    <GetServiceEstimatesResponse.ServiceEstimate>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <EstimatedAmount>0</EstimatedAmount>
      <InventoryItem>String</InventoryItem>
      <Notes>String</Notes>
      <ServiceDescription>String</ServiceDescription>
      <TicketNumber>String</TicketNumber>
    </GetServiceEstimatesResponse.ServiceEstimate>
  </ServiceEstimates>
</GetServiceEstimatesResponse>