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
import 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    String? ApiKey;

    /**
    * The OAuthToken token return by AeServices30
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    String? OAuthToken;

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    String? DeviceId;

    /**
    * An identifier for your integration
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    String? AppId;

    BaseRequest({this.ApiKey,this.OAuthToken,this.DeviceId,this.AppId});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        OAuthToken = json['OAuthToken'];
        DeviceId = json['DeviceId'];
        AppId = json['AppId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'OAuthToken': OAuthToken,
        'DeviceId': DeviceId,
        'AppId': AppId
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseSecureRequest extends BaseRequest implements IConvertible
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    String? Token;

    BaseSecureRequest({this.Token});
    BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Token = json['Token'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Token': Token
    });

    getTypeName() => "BaseSecureRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    String? Login;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    String? ErrorCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    String? ErrorDisplayText;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    String? ErrorMessage;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    String? DomainName;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    String? IpAddress;

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

    getTypeName() => "BaseResponseResult";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

    BaseResponse({this.Status});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class ServiceEstimate implements IConvertible
{
    // @DataMember
    String? TicketNumber;

    // @DataMember
    double? EstimatedAmount;

    // @DataMember
    DateTime? DateTime;

    // @DataMember
    String? InventoryItem;

    // @DataMember
    String? ServiceDescription;

    // @DataMember
    String? Notes;

    ServiceEstimate({this.TicketNumber,this.EstimatedAmount,this.DateTime,this.InventoryItem,this.ServiceDescription,this.Notes});
    ServiceEstimate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TicketNumber = json['TicketNumber'];
        EstimatedAmount = JsonConverters.toDouble(json['EstimatedAmount']);
        DateTime = JsonConverters.fromJson(json['DateTime'],'DateTime',context!);
        InventoryItem = json['InventoryItem'];
        ServiceDescription = json['ServiceDescription'];
        Notes = json['Notes'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TicketNumber': TicketNumber,
        'EstimatedAmount': EstimatedAmount,
        'DateTime': JsonConverters.toJson(DateTime,'DateTime',context!),
        'InventoryItem': InventoryItem,
        'ServiceDescription': ServiceDescription,
        'Notes': Notes
    };

    getTypeName() => "ServiceEstimate";
    TypeContext? context = _ctx;
}

// @DataContract
class GetServiceEstimatesResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<ServiceEstimate>? ServiceEstimates;

    GetServiceEstimatesResponse({this.ServiceEstimates});
    GetServiceEstimatesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ServiceEstimates = JsonConverters.fromJson(json['ServiceEstimates'],'List<ServiceEstimate>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ServiceEstimates': JsonConverters.toJson(ServiceEstimates,'List<ServiceEstimate>',context!)
    });

    getTypeName() => "GetServiceEstimatesResponse";
    TypeContext? context = _ctx;
}

/**
* GetServiceEstimatesRequires active-e Service Tickets Service
*/
// @DataContract
class GetServiceEstimatesRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    bool? UseWebFormatting;

    GetServiceEstimatesRequest({this.UseWebFormatting});
    GetServiceEstimatesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        UseWebFormatting = json['UseWebFormatting'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'UseWebFormatting': UseWebFormatting
    });

    getTypeName() => "GetServiceEstimatesRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'ServiceEstimate': TypeInfo(TypeOf.Class, create:() => ServiceEstimate()),
    'GetServiceEstimatesResponse': TypeInfo(TypeOf.Class, create:() => GetServiceEstimatesResponse()),
    'List<ServiceEstimate>': TypeInfo(TypeOf.Class, create:() => <ServiceEstimate>[]),
    'GetServiceEstimatesRequest': TypeInfo(TypeOf.Class, create:() => GetServiceEstimatesRequest()),
});

Dart 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>