Click or drag to resize

ServiceRouterGetUserLogins Method

Returns a GetUserLoginOut response with a result model List<UserLoginModel>

Namespace: AppOne.Services.V2
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141
Syntax
public GetUserLoginOut GetUserLogins(
	GetUserLoginIn input
)

Parameters

input  GetUserLoginIn
A new GetUserLoginIn object

Return Value

GetUserLoginOut
A GetUserLoginOut object
Remarks
Use this method to get a results list of UserLoginModel

Caution note  Caution
Due to the amount of data present in some accounts, this request is limited to returning seven days of data at a time (in our largest accounts this is equivalent to roughly 4,000 records. Submitting a request for more than 7 days will throw an error message indicating that a shorter date range is necessary.


Note  Note
System Generated Records are excluded from the results returned.

DataAction Names

NameDescriptionValues Example
SELECT-ALLReturns all user groups in system regardless of any state.[ignored]
SELECT-BY-EMPIDReturns All User Logins in the specified range that match a specified set of Emp Identifiers"EE1","EE2","3"
SELECT-BY-USERIDReturns All User Logins in the specified range that match a specified set of UserID's1,2,3,4
SELECT-BY-IPReturns All User Logins in the specified range that match a specified set of IP Addresses"1.1.1.1","1.1.1.2"
SELECT-BY-USERLOGINIDReturns All User Logins in the specified range that match a specified set of UserInfoLoginDetail ID's105010,105011

Sort Options (Optional)

NameDescription
DateTimeUTC(DEFAULT) All records are returned sorted by the DateTimeUTC value
IPAll records are returned sorted by the DateTimeUTC value and then the IP address
UserInfoLoginDetailIDAll records are returned sorted by the DateTimeUTC value and then the UserInfoLoginDetailID
EmpIdentifierAll records are returned sorted by the DateTimeUTC value and then the Emp Identifier (Alphabetical/Ascending)
FirstNameAll records are returned sorted by the DateTimeUTC value and then the Employee First Name (Alphabetical/Ascending)
LastNameAll records are returned sorted by the DateTimeUTC value and then the Employee Last Name (Alphabetical/Ascending)
SourceTypeAll records are returned sorted by the DateTimeUTC value and then the Source Type of the login
UserTypeAll records are returned sorted by the DateTimeUTC value and then the User Type
Example
JSON Request
{
    "AuthToken":"...",
    "Start":"\/Date(1553090478000)\/",
    "End":"\/Date(1553522478000)\/",
    "SortOption":null,
    "DataAction":{
        "Name":"SELECT-ALL",
        "Values":[""]
    }
}
JSON Response
{
    "Report": {
        "APIVersion": "2.0",
        "ProcessTime": "0.1088528",
        "RequestTime": "/Date(1554394336834+0000)/",
        "ResponseTime": "/Date(1554394336931+0000)/",
        "Results": 9
    },
    "Errors": null,
    "Results": [
        {
            "DateTimeServer": "03/21/2019 14:17:49",
            "DateTimeUTC": "03/21/2019 14:17:49",
            "DateTimeUser": "03/21/2019 10:17:49",
            "EmpIdentifier": "EE2",
            "FirstName": "James",
            "LastName": "Doe",
            "MiddleName": "",
            "Source": "Site",
            "UserID": 1,
            "UserIP": "10.0.1.2",
            "UserInfoLoginDetailID": 14909,
            "UserTimeZone": "Eastern Standard Time",
            "UserType": "Employee"
        }
}
See Also