GET v1/Employees/LoginStatus

Get the current logged in user's login status.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

User's login status

ActionResultDTOOfApiUserDTO

Name	Type	Additional information
Result	ApiUserDTO	None.
CreatedBy	string	None.
EntityID	integer	None.
RowSource	string	None.
PolicyID	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
InfoMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "UserId": 1,
    "UserName": "sample string 2",
    "UserDisplayName": "sample string 3",
    "DefaultLocation": {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "IsDefault": true,
      "QQID": "sample string 4",
      "Alias": "sample string 5",
      "StreetAddressLine1": "sample string 6",
      "StreetAddressLine2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zip": "sample string 10",
      "PhoneNumber": "sample string 11",
      "Fax": "sample string 12",
      "DefaultEmailAccountId": 1,
      "EmailAddress": "sample string 13",
      "DefaultEmployeeId": 1,
      "ContactFirstName": "sample string 14",
      "ContactLastName": "sample string 15",
      "MainClientId": 16,
      "DefaultStateCode": "sample string 17",
      "BusinessFEIN": "sample string 18"
    },
    "Permissions": [
      {
        "Category": 1,
        "CategoryName": "sample string 2",
        "View": true,
        "Add": true,
        "Edit": true,
        "Delete": true,
        "Execute": true
      },
      {
        "Category": 1,
        "CategoryName": "sample string 2",
        "View": true,
        "Add": true,
        "Edit": true,
        "Delete": true,
        "Execute": true
      }
    ],
    "UserLevel": "sample string 4",
    "DataEntryViewMode": "sample string 5",
    "OfficeTimeClockStatuses": [
      {
        "IsPayable": true,
        "OfficeTimeClockStatusId": 2,
        "StatusDescription": "sample string 3",
        "StatusName": "sample string 4"
      },
      {
        "IsPayable": true,
        "OfficeTimeClockStatusId": 2,
        "StatusDescription": "sample string 3",
        "StatusName": "sample string 4"
      }
    ],
    "UserFullName": "sample string 6"
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:

<ActionResultOfApiUserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result>
    <DataEntryViewMode>sample string 5</DataEntryViewMode>
    <DefaultLocation xmlns:d3p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Locations">
      <d3p1:Alias>sample string 5</d3p1:Alias>
      <d3p1:BusinessFEIN>sample string 18</d3p1:BusinessFEIN>
      <d3p1:City>sample string 8</d3p1:City>
      <d3p1:ContactFirstName>sample string 14</d3p1:ContactFirstName>
      <d3p1:ContactLastName>sample string 15</d3p1:ContactLastName>
      <d3p1:DefaultEmailAccountId>1</d3p1:DefaultEmailAccountId>
      <d3p1:DefaultEmployeeId>1</d3p1:DefaultEmployeeId>
      <d3p1:DefaultStateCode>sample string 17</d3p1:DefaultStateCode>
      <d3p1:EmailAddress>sample string 13</d3p1:EmailAddress>
      <d3p1:Fax>sample string 12</d3p1:Fax>
      <d3p1:IsDefault>true</d3p1:IsDefault>
      <d3p1:LocationID>1</d3p1:LocationID>
      <d3p1:LocationName>sample string 2</d3p1:LocationName>
      <d3p1:MainClientId>16</d3p1:MainClientId>
      <d3p1:PhoneNumber>sample string 11</d3p1:PhoneNumber>
      <d3p1:QQID>sample string 4</d3p1:QQID>
      <d3p1:State>sample string 9</d3p1:State>
      <d3p1:StreetAddressLine1>sample string 6</d3p1:StreetAddressLine1>
      <d3p1:StreetAddressLine2>sample string 7</d3p1:StreetAddressLine2>
      <d3p1:Zip>sample string 10</d3p1:Zip>
    </DefaultLocation>
    <OfficeTimeClockStatuses xmlns:d3p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.TimeClock">
      <d3p1:OfficeTimeClockStatusDTO>
        <d3p1:IsPayable>true</d3p1:IsPayable>
        <d3p1:OfficeTimeClockStatusId>2</d3p1:OfficeTimeClockStatusId>
        <d3p1:StatusDescription>sample string 3</d3p1:StatusDescription>
        <d3p1:StatusName>sample string 4</d3p1:StatusName>
      </d3p1:OfficeTimeClockStatusDTO>
      <d3p1:OfficeTimeClockStatusDTO>
        <d3p1:IsPayable>true</d3p1:IsPayable>
        <d3p1:OfficeTimeClockStatusId>2</d3p1:OfficeTimeClockStatusId>
        <d3p1:StatusDescription>sample string 3</d3p1:StatusDescription>
        <d3p1:StatusName>sample string 4</d3p1:StatusName>
      </d3p1:OfficeTimeClockStatusDTO>
    </OfficeTimeClockStatuses>
    <Permissions>
      <PermissionInfoDTO>
        <Add>true</Add>
        <Category>1</Category>
        <CategoryName>sample string 2</CategoryName>
        <Delete>true</Delete>
        <Edit>true</Edit>
        <Execute>true</Execute>
        <View>true</View>
      </PermissionInfoDTO>
      <PermissionInfoDTO>
        <Add>true</Add>
        <Category>1</Category>
        <CategoryName>sample string 2</CategoryName>
        <Delete>true</Delete>
        <Edit>true</Edit>
        <Execute>true</Execute>
        <View>true</View>
      </PermissionInfoDTO>
    </Permissions>
    <UserDisplayName>sample string 3</UserDisplayName>
    <UserFullName>sample string 6</UserFullName>
    <UserId>1</UserId>
    <UserLevel>sample string 4</UserLevel>
    <UserName>sample string 2</UserName>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfApiUserDTO>