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
"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 ActiveEmployeeInfo {
    /** @param {{EmployeeName?:string,TimeIn?:string,Location?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    EmployeeName;
    /** @type {string} */
    TimeIn;
    /** @type {string} */
    Location;
}
export class ActiveEmployeesResponse extends BaseResponse {
    /** @param {{Employees?:ActiveEmployeeInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ActiveEmployeeInfo[]} */
    Employees;
}
export class ActiveEmployeesRequest extends BaseSecureRequest {
    /** @param {{Mode?:string,LocationId?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Can be CLOCKED_IN to return all clocked in employees or LOGGED_IN to return all logged in employees */
    Mode;
    /**
     * @type {?number}
     * @description Location to return employees for. Optional; only applicable to CLOCKED_IN mode. */
    LocationId;
}

JavaScript ActiveEmployeesRequest 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/ActiveEmployees HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ActiveEmployeesResponse 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>
  <Employees>
    <ActiveEmployeeInfo>
      <EmployeeName>String</EmployeeName>
      <Location>String</Location>
      <TimeIn>0001-01-01T00:00:00</TimeIn>
    </ActiveEmployeeInfo>
  </Employees>
</ActiveEmployeesResponse>