AIM Web Services

<back to all web services

ActiveEmployeesRequest

ActiveEmployees
Requires active-e Service.

The following routes are available for this service:
GET/api/ActiveEmployees
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;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    String? OAuthToken;

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

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

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

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

// @DataContract
class BaseSecureRequest extends BaseRequest implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    String? Token;

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

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

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

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

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

    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 ActiveEmployeeInfo implements IConvertible
{
    // @DataMember
    String? EmployeeName;

    // @DataMember
    DateTime? TimeIn;

    // @DataMember
    String? Location;

    ActiveEmployeeInfo({this.EmployeeName,this.TimeIn,this.Location});
    ActiveEmployeeInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'EmployeeName': EmployeeName,
        'TimeIn': JsonConverters.toJson(TimeIn,'DateTime',context!),
        'Location': Location
    };

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

// @DataContract
class ActiveEmployeesResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<ActiveEmployeeInfo>? Employees;

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

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

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

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

/**
* ActiveEmployeesRequires active-e Service.
*/
// @DataContract
class ActiveEmployeesRequest extends BaseSecureRequest implements IConvertible
{
    /**
    * Can be CLOCKED_IN to return all clocked in employees or LOGGED_IN to return all logged in employees
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Can be CLOCKED_IN to return all clocked in employees or LOGGED_IN to return all logged in employees", Name="Mode")
    String? Mode;

    /**
    * Location to return employees for. Optional; only applicable to CLOCKED_IN mode.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Location to return employees for. Optional; only applicable to CLOCKED_IN mode.", Name="LocationId")
    int? LocationId;

    ActiveEmployeesRequest({this.Mode,this.LocationId});
    ActiveEmployeesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

    getTypeName() => "ActiveEmployeesRequest";
    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()),
    'ActiveEmployeeInfo': TypeInfo(TypeOf.Class, create:() => ActiveEmployeeInfo()),
    'ActiveEmployeesResponse': TypeInfo(TypeOf.Class, create:() => ActiveEmployeesResponse()),
    'List<ActiveEmployeeInfo>': TypeInfo(TypeOf.Class, create:() => <ActiveEmployeeInfo>[]),
    'ActiveEmployeesRequest': TypeInfo(TypeOf.Class, create:() => ActiveEmployeesRequest()),
});

Dart ActiveEmployeesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ActiveEmployees HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Employees":[{"EmployeeName":"String","Location":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}