GET api/UserApi

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	globally unique identifier	None.
PhoneNumber	string	None.
ClientId	string	Required
Deleted	boolean	None.
Number	string	Required
StartDate	date	None.
FirstName	string	Required
LastName	string	Required
Address	string	None.
Roles	Collection of RoleModel	None.
ChangePass	boolean	None.
NewPassword	string	None.
TwoFactorEnabled	boolean	None.
EmailVerificationEnabled	boolean	None.
SetupCode2FA	string	None.
StoreURL	string	None.
StoreName	string	None.
FileName	string	None.
UserName	string	Required
Email	string	None.
Password	string	Required Data type: Password String length: inclusive between 6 and 100
ConfirmPassword	string	Data type: Password
ClientName	string	None.
RoleName	string	None.
IsManager	boolean	None.
ManagerKey	string	Data type: Password

Request Formats

application/json, text/json

Sample:

{
  "ID": "583abcea-0c71-4a49-9531-3d11a3b77aa4",
  "PhoneNumber": "sample string 1",
  "ClientId": "sample string 2",
  "Deleted": true,
  "Number": "sample string 4",
  "StartDate": "2026-05-08T18:28:56.2651711-07:00",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "Address": "sample string 7",
  "Roles": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "ClientId": "sample string 3",
      "Deleted": true,
      "Templates": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "ClientId": "sample string 4",
          "Deleted": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "ClientId": "sample string 4",
          "Deleted": true
        }
      ]
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "ClientId": "sample string 3",
      "Deleted": true,
      "Templates": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "ClientId": "sample string 4",
          "Deleted": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "ClientId": "sample string 4",
          "Deleted": true
        }
      ]
    }
  ],
  "ChangePass": true,
  "NewPassword": "sample string 9",
  "TwoFactorEnabled": true,
  "EmailVerificationEnabled": true,
  "SetupCode2FA": "sample string 12",
  "StoreURL": "sample string 13",
  "StoreName": "sample string 14",
  "FileName": "sample string 15",
  "UserName": "sample string 16",
  "Email": "sample string 17",
  "Password": "sample string 18",
  "ConfirmPassword": "sample string 19",
  "ClientName": "sample string 20",
  "RoleName": "sample string 21",
  "IsManager": true,
  "ManagerKey": "sample string 23"
}

application/xml, text/xml

Sample:

<HotelUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecurityApi">
  <ClientName>sample string 20</ClientName>
  <ConfirmPassword>sample string 19</ConfirmPassword>
  <Email>sample string 17</Email>
  <IsManager>true</IsManager>
  <ManagerKey>sample string 23</ManagerKey>
  <Password>sample string 18</Password>
  <RoleName>sample string 21</RoleName>
  <UserName>sample string 16</UserName>
  <Address>sample string 7</Address>
  <ChangePass>true</ChangePass>
  <ClientId>sample string 2</ClientId>
  <Deleted>true</Deleted>
  <EmailVerificationEnabled>true</EmailVerificationEnabled>
  <FileName>sample string 15</FileName>
  <FirstName>sample string 5</FirstName>
  <ID>583abcea-0c71-4a49-9531-3d11a3b77aa4</ID>
  <LastName>sample string 6</LastName>
  <NewPassword>sample string 9</NewPassword>
  <Number>sample string 4</Number>
  <PhoneNumber>sample string 1</PhoneNumber>
  <Roles>
    <RoleModel>
      <ClientId>sample string 3</ClientId>
      <Deleted>true</Deleted>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Templates>
        <Template>
          <ClientId>sample string 4</ClientId>
          <Deleted>true</Deleted>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Template>
        <Template>
          <ClientId>sample string 4</ClientId>
          <Deleted>true</Deleted>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Template>
      </Templates>
    </RoleModel>
    <RoleModel>
      <ClientId>sample string 3</ClientId>
      <Deleted>true</Deleted>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Templates>
        <Template>
          <ClientId>sample string 4</ClientId>
          <Deleted>true</Deleted>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Template>
        <Template>
          <ClientId>sample string 4</ClientId>
          <Deleted>true</Deleted>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Template>
      </Templates>
    </RoleModel>
  </Roles>
  <SetupCode2FA>sample string 12</SetupCode2FA>
  <StartDate>2026-05-08T18:28:56.2651711-07:00</StartDate>
  <StoreName>sample string 14</StoreName>
  <StoreURL>sample string 13</StoreURL>
  <TwoFactorEnabled>true</TwoFactorEnabled>
</HotelUser>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'HotelUser'.

Response Information

Resource Description

Collection of HotelUser

Name	Type	Additional information
ID	globally unique identifier	None.
PhoneNumber	string	None.
ClientId	string	Required
Deleted	boolean	None.
Number	string	Required
StartDate	date	None.
FirstName	string	Required
LastName	string	Required
Address	string	None.
Roles	Collection of RoleModel	None.
ChangePass	boolean	None.
NewPassword	string	None.
TwoFactorEnabled	boolean	None.
EmailVerificationEnabled	boolean	None.
SetupCode2FA	string	None.
StoreURL	string	None.
StoreName	string	None.
FileName	string	None.
UserName	string	Required
Email	string	None.
Password	string	Required Data type: Password String length: inclusive between 6 and 100
ConfirmPassword	string	Data type: Password
ClientName	string	None.
RoleName	string	None.
IsManager	boolean	None.
ManagerKey	string	Data type: Password

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": "023d5c84-6d3e-4f27-88a7-339e62754df3",
    "PhoneNumber": "sample string 1",
    "ClientId": "sample string 2",
    "Deleted": true,
    "Number": "sample string 4",
    "StartDate": "2026-05-08T18:28:56.2670653-07:00",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "Address": "sample string 7",
    "Roles": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "ClientId": "sample string 3",
        "Deleted": true,
        "Templates": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          }
        ]
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "ClientId": "sample string 3",
        "Deleted": true,
        "Templates": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          }
        ]
      }
    ],
    "ChangePass": true,
    "NewPassword": "sample string 9",
    "TwoFactorEnabled": true,
    "EmailVerificationEnabled": true,
    "SetupCode2FA": "sample string 12",
    "StoreURL": "sample string 13",
    "StoreName": "sample string 14",
    "FileName": "sample string 15",
    "UserName": "sample string 16",
    "Email": "sample string 17",
    "Password": "sample string 18",
    "ConfirmPassword": "sample string 19",
    "ClientName": "sample string 20",
    "RoleName": "sample string 21",
    "IsManager": true,
    "ManagerKey": "sample string 23"
  },
  {
    "ID": "023d5c84-6d3e-4f27-88a7-339e62754df3",
    "PhoneNumber": "sample string 1",
    "ClientId": "sample string 2",
    "Deleted": true,
    "Number": "sample string 4",
    "StartDate": "2026-05-08T18:28:56.2670653-07:00",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "Address": "sample string 7",
    "Roles": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "ClientId": "sample string 3",
        "Deleted": true,
        "Templates": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          }
        ]
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "ClientId": "sample string 3",
        "Deleted": true,
        "Templates": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "Description": "sample string 3",
            "ClientId": "sample string 4",
            "Deleted": true
          }
        ]
      }
    ],
    "ChangePass": true,
    "NewPassword": "sample string 9",
    "TwoFactorEnabled": true,
    "EmailVerificationEnabled": true,
    "SetupCode2FA": "sample string 12",
    "StoreURL": "sample string 13",
    "StoreName": "sample string 14",
    "FileName": "sample string 15",
    "UserName": "sample string 16",
    "Email": "sample string 17",
    "Password": "sample string 18",
    "ConfirmPassword": "sample string 19",
    "ClientName": "sample string 20",
    "RoleName": "sample string 21",
    "IsManager": true,
    "ManagerKey": "sample string 23"
  }
]

application/xml, text/xml

Sample:

<ArrayOfHotelUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecurityApi">
  <HotelUser>
    <ClientName>sample string 20</ClientName>
    <ConfirmPassword>sample string 19</ConfirmPassword>
    <Email>sample string 17</Email>
    <IsManager>true</IsManager>
    <ManagerKey>sample string 23</ManagerKey>
    <Password>sample string 18</Password>
    <RoleName>sample string 21</RoleName>
    <UserName>sample string 16</UserName>
    <Address>sample string 7</Address>
    <ChangePass>true</ChangePass>
    <ClientId>sample string 2</ClientId>
    <Deleted>true</Deleted>
    <EmailVerificationEnabled>true</EmailVerificationEnabled>
    <FileName>sample string 15</FileName>
    <FirstName>sample string 5</FirstName>
    <ID>023d5c84-6d3e-4f27-88a7-339e62754df3</ID>
    <LastName>sample string 6</LastName>
    <NewPassword>sample string 9</NewPassword>
    <Number>sample string 4</Number>
    <PhoneNumber>sample string 1</PhoneNumber>
    <Roles>
      <RoleModel>
        <ClientId>sample string 3</ClientId>
        <Deleted>true</Deleted>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Templates>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
        </Templates>
      </RoleModel>
      <RoleModel>
        <ClientId>sample string 3</ClientId>
        <Deleted>true</Deleted>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Templates>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
        </Templates>
      </RoleModel>
    </Roles>
    <SetupCode2FA>sample string 12</SetupCode2FA>
    <StartDate>2026-05-08T18:28:56.2670653-07:00</StartDate>
    <StoreName>sample string 14</StoreName>
    <StoreURL>sample string 13</StoreURL>
    <TwoFactorEnabled>true</TwoFactorEnabled>
  </HotelUser>
  <HotelUser>
    <ClientName>sample string 20</ClientName>
    <ConfirmPassword>sample string 19</ConfirmPassword>
    <Email>sample string 17</Email>
    <IsManager>true</IsManager>
    <ManagerKey>sample string 23</ManagerKey>
    <Password>sample string 18</Password>
    <RoleName>sample string 21</RoleName>
    <UserName>sample string 16</UserName>
    <Address>sample string 7</Address>
    <ChangePass>true</ChangePass>
    <ClientId>sample string 2</ClientId>
    <Deleted>true</Deleted>
    <EmailVerificationEnabled>true</EmailVerificationEnabled>
    <FileName>sample string 15</FileName>
    <FirstName>sample string 5</FirstName>
    <ID>023d5c84-6d3e-4f27-88a7-339e62754df3</ID>
    <LastName>sample string 6</LastName>
    <NewPassword>sample string 9</NewPassword>
    <Number>sample string 4</Number>
    <PhoneNumber>sample string 1</PhoneNumber>
    <Roles>
      <RoleModel>
        <ClientId>sample string 3</ClientId>
        <Deleted>true</Deleted>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Templates>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
        </Templates>
      </RoleModel>
      <RoleModel>
        <ClientId>sample string 3</ClientId>
        <Deleted>true</Deleted>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Templates>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
          <Template>
            <ClientId>sample string 4</ClientId>
            <Deleted>true</Deleted>
            <Description>sample string 3</Description>
            <Id>1</Id>
            <Name>sample string 2</Name>
          </Template>
        </Templates>
      </RoleModel>
    </Roles>
    <SetupCode2FA>sample string 12</SetupCode2FA>
    <StartDate>2026-05-08T18:28:56.2670653-07:00</StartDate>
    <StoreName>sample string 14</StoreName>
    <StoreURL>sample string 13</StoreURL>
    <TwoFactorEnabled>true</TwoFactorEnabled>
  </HotelUser>
</ArrayOfHotelUser>