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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class ServiceEstimate {
    /** @param {{TicketNumber?:string,EstimatedAmount?:number,DateTime?:string,InventoryItem?:string,ServiceDescription?:string,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TicketNumber;
    /** @type {number} */
    EstimatedAmount;
    /** @type {string} */
    DateTime;
    /** @type {string} */
    InventoryItem;
    /** @type {string} */
    ServiceDescription;
    /** @type {string} */
    Notes;
}
export class GetServiceEstimatesResponse extends BaseResponse {
    /** @param {{ServiceEstimates?:ServiceEstimate[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ServiceEstimate[]} */
    ServiceEstimates;
}
export class GetServiceEstimatesRequest extends BaseSecureRequest {
    /** @param {{UseWebFormatting?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?boolean} */
    UseWebFormatting;
}

JavaScript GetServiceEstimatesRequest DTOs

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>