GET CMUser?UserID={UserID}&ExternalEmployeeID={ExternalEmployeeID}&IncludeInactive={IncludeInactive}&ScheduleDaysOld={ScheduleDaysOld}

If the client uses CM and Centralised Users, This Call Returns A List Of All Users.

Request Information

URI Parameters

Name	Type	Additional information
UserID	integer	None.
ExternalEmployeeID	string	None.
IncludeInactive	boolean	None.
ScheduleDaysOld	integer	None.

Body Parameters

None.

Response Information

Resource Description

ApiUserModel

Name	Type	Description	Additional information
SiteId	integer		None.
Users	Collection of UserDto		None.

Response Formats

application/json, text/json

Sample:

{
  "SiteId": 1,
  "Users": [
    {
      "UserId": 1,
      "UserName": "sample string 2",
      "ExternalEmployeeID": "sample string 3",
      "HourlyRate": 1.0,
      "UserLevel": {
        "LevelID": 1,
        "LevelName": "sample string 2",
        "ExternalGroupId": "sample string 3"
      },
      "RecallNumber": "sample string 4",
      "CardNumber": "sample string 5",
      "IsActive": true,
      "AllowedToOpenTableFromOtherClerks": true,
      "SignOffAtSaleFinalisation": true,
      "CompulsoryClockOn": true,
      "ShowButtonOnLoginScreen": true,
      "AutoDisplayFloorPlan": true,
      "UseSecondLanguage": true,
      "DisplayName": "sample string 8",
      "EmployeeEmail": "sample string 9",
      "UserSchedule": [
        {
          "UserScheduleID": 1,
          "UserID": 2,
          "JobID": 3,
          "SiteID": 4,
          "StartTime": "2024-11-21T06:23:56.1247109+00:00",
          "EndTime": "2024-11-21T06:23:56.1247109+00:00"
        },
        {
          "UserScheduleID": 1,
          "UserID": 2,
          "JobID": 3,
          "SiteID": 4,
          "StartTime": "2024-11-21T06:23:56.1247109+00:00",
          "EndTime": "2024-11-21T06:23:56.1247109+00:00"
        }
      ],
      "IncludedSites": [
        1,
        2
      ]
    },
    {
      "UserId": 1,
      "UserName": "sample string 2",
      "ExternalEmployeeID": "sample string 3",
      "HourlyRate": 1.0,
      "UserLevel": {
        "LevelID": 1,
        "LevelName": "sample string 2",
        "ExternalGroupId": "sample string 3"
      },
      "RecallNumber": "sample string 4",
      "CardNumber": "sample string 5",
      "IsActive": true,
      "AllowedToOpenTableFromOtherClerks": true,
      "SignOffAtSaleFinalisation": true,
      "CompulsoryClockOn": true,
      "ShowButtonOnLoginScreen": true,
      "AutoDisplayFloorPlan": true,
      "UseSecondLanguage": true,
      "DisplayName": "sample string 8",
      "EmployeeEmail": "sample string 9",
      "UserSchedule": [
        {
          "UserScheduleID": 1,
          "UserID": 2,
          "JobID": 3,
          "SiteID": 4,
          "StartTime": "2024-11-21T06:23:56.1247109+00:00",
          "EndTime": "2024-11-21T06:23:56.1247109+00:00"
        },
        {
          "UserScheduleID": 1,
          "UserID": 2,
          "JobID": 3,
          "SiteID": 4,
          "StartTime": "2024-11-21T06:23:56.1247109+00:00",
          "EndTime": "2024-11-21T06:23:56.1247109+00:00"
        }
      ],
      "IncludedSites": [
        1,
        2
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ApiUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.User.Dto">
  <SiteId>1</SiteId>
  <Users>
    <UserDto>
      <AllowedToOpenTableFromOtherClerks>true</AllowedToOpenTableFromOtherClerks>
      <AutoDisplayFloorPlan>true</AutoDisplayFloorPlan>
      <CardNumber>sample string 5</CardNumber>
      <CompulsoryClockOn>true</CompulsoryClockOn>
      <DisplayName>sample string 8</DisplayName>
      <EmployeeEmail>sample string 9</EmployeeEmail>
      <ExternalEmployeeID>sample string 3</ExternalEmployeeID>
      <HourlyRate>1</HourlyRate>
      <IncludedSites xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </IncludedSites>
      <IsActive>true</IsActive>
      <RecallNumber>sample string 4</RecallNumber>
      <ShowButtonOnLoginScreen>true</ShowButtonOnLoginScreen>
      <SignOffAtSaleFinalisation>true</SignOffAtSaleFinalisation>
      <UseSecondLanguage>true</UseSecondLanguage>
      <UserId>1</UserId>
      <UserLevel>
        <CMUserLevelCompanyID>4</CMUserLevelCompanyID>
        <ExternalGroupId>sample string 3</ExternalGroupId>
        <LevelID>1</LevelID>
        <LevelName>sample string 2</LevelName>
      </UserLevel>
      <UserLevelCompanyID>7</UserLevelCompanyID>
      <UserName>sample string 2</UserName>
      <UserSchedule>
        <UserScheduleDto>
          <EndTime>2024-11-21T06:23:56.1247109+00:00</EndTime>
          <JobID>3</JobID>
          <SiteID>4</SiteID>
          <StartTime>2024-11-21T06:23:56.1247109+00:00</StartTime>
          <UserID>2</UserID>
          <UserScheduleID>1</UserScheduleID>
        </UserScheduleDto>
        <UserScheduleDto>
          <EndTime>2024-11-21T06:23:56.1247109+00:00</EndTime>
          <JobID>3</JobID>
          <SiteID>4</SiteID>
          <StartTime>2024-11-21T06:23:56.1247109+00:00</StartTime>
          <UserID>2</UserID>
          <UserScheduleID>1</UserScheduleID>
        </UserScheduleDto>
      </UserSchedule>
      <updateSites>true</updateSites>
    </UserDto>
    <UserDto>
      <AllowedToOpenTableFromOtherClerks>true</AllowedToOpenTableFromOtherClerks>
      <AutoDisplayFloorPlan>true</AutoDisplayFloorPlan>
      <CardNumber>sample string 5</CardNumber>
      <CompulsoryClockOn>true</CompulsoryClockOn>
      <DisplayName>sample string 8</DisplayName>
      <EmployeeEmail>sample string 9</EmployeeEmail>
      <ExternalEmployeeID>sample string 3</ExternalEmployeeID>
      <HourlyRate>1</HourlyRate>
      <IncludedSites xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </IncludedSites>
      <IsActive>true</IsActive>
      <RecallNumber>sample string 4</RecallNumber>
      <ShowButtonOnLoginScreen>true</ShowButtonOnLoginScreen>
      <SignOffAtSaleFinalisation>true</SignOffAtSaleFinalisation>
      <UseSecondLanguage>true</UseSecondLanguage>
      <UserId>1</UserId>
      <UserLevel>
        <CMUserLevelCompanyID>4</CMUserLevelCompanyID>
        <ExternalGroupId>sample string 3</ExternalGroupId>
        <LevelID>1</LevelID>
        <LevelName>sample string 2</LevelName>
      </UserLevel>
      <UserLevelCompanyID>7</UserLevelCompanyID>
      <UserName>sample string 2</UserName>
      <UserSchedule>
        <UserScheduleDto>
          <EndTime>2024-11-21T06:23:56.1247109+00:00</EndTime>
          <JobID>3</JobID>
          <SiteID>4</SiteID>
          <StartTime>2024-11-21T06:23:56.1247109+00:00</StartTime>
          <UserID>2</UserID>
          <UserScheduleID>1</UserScheduleID>
        </UserScheduleDto>
        <UserScheduleDto>
          <EndTime>2024-11-21T06:23:56.1247109+00:00</EndTime>
          <JobID>3</JobID>
          <SiteID>4</SiteID>
          <StartTime>2024-11-21T06:23:56.1247109+00:00</StartTime>
          <UserID>2</UserID>
          <UserScheduleID>1</UserScheduleID>
        </UserScheduleDto>
      </UserSchedule>
      <updateSites>true</updateSites>
    </UserDto>
  </Users>
</ApiUserModel>