AIM Web Services

<back to all web services

ActiveEmployeesRequest

ActiveEmployees
Requires active-e Service.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class ActiveEmployeeInfo
    {
        [DataMember]
        public virtual string EmployeeName { get; set; }

        [DataMember]
        public virtual DateTime TimeIn { get; set; }

        [DataMember]
        public virtual string Location { get; set; }
    }

    ///<summary>
    ///ActiveEmployeesRequires active-e Service.
    ///</summary>
    [DataContract]
    public partial class ActiveEmployeesRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///Can be CLOCKED_IN to return all clocked in employees or LOGGED_IN to return all logged in employees
        ///</summary>
        [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")]
        public virtual string Mode { get; set; }

        ///<summary>
        ///Location to return employees for. Optional; only applicable to CLOCKED_IN mode.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Location to return employees for. Optional; only applicable to CLOCKED_IN mode.", Name="LocationId")]
        public virtual long? LocationId { get; set; }
    }

    [DataContract]
    public partial class ActiveEmployeesResponse
        : BaseResponse
    {
        public ActiveEmployeesResponse()
        {
            Employees = new List<ActiveEmployeeInfo>{};
        }

        [DataMember]
        public virtual List<ActiveEmployeeInfo> Employees { get; set; }
    }

    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

}

C# ActiveEmployeesRequest DTOs

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"}}