GET api/userapi/users?active={active}&keyword={keyword}

Request Information

URI Parameters

Name	Description	Type	Additional information
active		boolean	None.
keyword		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of UserViewModel

Name	Type	Additional information
customer_name	string	None.
has_operator_password	boolean	None.
webapp_password	string	Data type: Password Matching regular expression pattern: ^(?=.[a-z])(?=.[A-Z])(?=.\d)(?=.[ !"#$%&\'()+,\-\.\/:;<=>?@\[\\\]^_`{\|}~])[A-Za-z\d !"#$%&\'()+,\-\.\/:;<=>?@\[\\\]^_`{\|}~]{8,}$
webapp_username	string	Required
rights	Collection of ShortRightViewModel	None.
isFromWpf	boolean	None.
sites	Collection of SiteViewModel	None.
locks	Collection of LockViewModel	None.
clearOperatorPassword	boolean	None.
active	boolean	Required
admin	boolean	None.
badge_tag_id	string	None.
cell_phone	string	None.
customer_id	globally unique identifier	None.
firstname	string	None.
id	globally unique identifier	None.
language_code	string	Required
lastname	string	None.
mail	string	None.
operator_code	string	Required
operator_password	string	Data type: Password
phone	string	None.
webapp_password_last_update	date	None.
role_id	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "customer_name": "sample string 1",
    "has_operator_password": true,
    "webapp_password": "sample string 3",
    "webapp_username": "sample string 4",
    "rights": [
      {
        "code": "sample string 1",
        "id": "664790fc-97f6-470f-a671-e9452facbb1c"
      },
      {
        "code": "sample string 1",
        "id": "664790fc-97f6-470f-a671-e9452facbb1c"
      }
    ],
    "isFromWpf": true,
    "sites": [
      {
        "active": true,
        "address": "sample string 1",
        "site_analysis_count": 1,
        "city": "sample string 2",
        "country": "sample string 3",
        "customer_id": "61c170cd-c593-4a6c-98d2-c6c8a212a89a",
        "dB_ip": "sample string 5",
        "dB_name": "sample string 6",
        "dB_password": "sample string 7",
        "dB_user": "sample string 8",
        "delay_between_scans": 9,
        "id": "44b22dc5-c166-40ae-99cc-1ab7d561771c",
        "ph_max": 1,
        "ph_min": 1,
        "name": "sample string 11",
        "number": 1,
        "selected_sticker_id": "db36978f-bc3f-4360-b95f-2060d0b62272",
        "wash_temp": 1,
        "wash_temp_duration": 1,
        "witness_maxwash": 1,
        "zip_code": "sample string 12"
      },
      {
        "active": true,
        "address": "sample string 1",
        "site_analysis_count": 1,
        "city": "sample string 2",
        "country": "sample string 3",
        "customer_id": "61c170cd-c593-4a6c-98d2-c6c8a212a89a",
        "dB_ip": "sample string 5",
        "dB_name": "sample string 6",
        "dB_password": "sample string 7",
        "dB_user": "sample string 8",
        "delay_between_scans": 9,
        "id": "44b22dc5-c166-40ae-99cc-1ab7d561771c",
        "ph_max": 1,
        "ph_min": 1,
        "name": "sample string 11",
        "number": 1,
        "selected_sticker_id": "db36978f-bc3f-4360-b95f-2060d0b62272",
        "wash_temp": 1,
        "wash_temp_duration": 1,
        "witness_maxwash": 1,
        "zip_code": "sample string 12"
      }
    ],
    "locks": [
      {
        "id": "5c928cc8-f9c3-483b-b029-2c6e898f695b",
        "name": "sample string 2",
        "direction": "sample string 3",
        "distribution_id": "acc57561-29f4-41c3-bd59-53e89629a881",
        "guard_id": "ae535ef6-0091-435f-bcf1-2c1b0acc1829",
        "active": true
      },
      {
        "id": "5c928cc8-f9c3-483b-b029-2c6e898f695b",
        "name": "sample string 2",
        "direction": "sample string 3",
        "distribution_id": "acc57561-29f4-41c3-bd59-53e89629a881",
        "guard_id": "ae535ef6-0091-435f-bcf1-2c1b0acc1829",
        "active": true
      }
    ],
    "clearOperatorPassword": true,
    "active": true,
    "admin": true,
    "badge_tag_id": "sample string 9",
    "cell_phone": "sample string 10",
    "customer_id": "22737315-0811-4d32-a35b-dda6ad9238db",
    "firstname": "sample string 11",
    "id": "8b05115c-83ce-4320-ba84-669eac5f9794",
    "language_code": "sample string 13",
    "lastname": "sample string 14",
    "mail": "sample string 15",
    "operator_code": "sample string 16",
    "operator_password": "sample string 17",
    "phone": "sample string 18",
    "webapp_password_last_update": "2026-01-19T09:22:03.3108679+00:00",
    "role_id": "7f3a2d34-e391-4a69-b638-c29731decffd"
  },
  {
    "customer_name": "sample string 1",
    "has_operator_password": true,
    "webapp_password": "sample string 3",
    "webapp_username": "sample string 4",
    "rights": [
      {
        "code": "sample string 1",
        "id": "664790fc-97f6-470f-a671-e9452facbb1c"
      },
      {
        "code": "sample string 1",
        "id": "664790fc-97f6-470f-a671-e9452facbb1c"
      }
    ],
    "isFromWpf": true,
    "sites": [
      {
        "active": true,
        "address": "sample string 1",
        "site_analysis_count": 1,
        "city": "sample string 2",
        "country": "sample string 3",
        "customer_id": "61c170cd-c593-4a6c-98d2-c6c8a212a89a",
        "dB_ip": "sample string 5",
        "dB_name": "sample string 6",
        "dB_password": "sample string 7",
        "dB_user": "sample string 8",
        "delay_between_scans": 9,
        "id": "44b22dc5-c166-40ae-99cc-1ab7d561771c",
        "ph_max": 1,
        "ph_min": 1,
        "name": "sample string 11",
        "number": 1,
        "selected_sticker_id": "db36978f-bc3f-4360-b95f-2060d0b62272",
        "wash_temp": 1,
        "wash_temp_duration": 1,
        "witness_maxwash": 1,
        "zip_code": "sample string 12"
      },
      {
        "active": true,
        "address": "sample string 1",
        "site_analysis_count": 1,
        "city": "sample string 2",
        "country": "sample string 3",
        "customer_id": "61c170cd-c593-4a6c-98d2-c6c8a212a89a",
        "dB_ip": "sample string 5",
        "dB_name": "sample string 6",
        "dB_password": "sample string 7",
        "dB_user": "sample string 8",
        "delay_between_scans": 9,
        "id": "44b22dc5-c166-40ae-99cc-1ab7d561771c",
        "ph_max": 1,
        "ph_min": 1,
        "name": "sample string 11",
        "number": 1,
        "selected_sticker_id": "db36978f-bc3f-4360-b95f-2060d0b62272",
        "wash_temp": 1,
        "wash_temp_duration": 1,
        "witness_maxwash": 1,
        "zip_code": "sample string 12"
      }
    ],
    "locks": [
      {
        "id": "5c928cc8-f9c3-483b-b029-2c6e898f695b",
        "name": "sample string 2",
        "direction": "sample string 3",
        "distribution_id": "acc57561-29f4-41c3-bd59-53e89629a881",
        "guard_id": "ae535ef6-0091-435f-bcf1-2c1b0acc1829",
        "active": true
      },
      {
        "id": "5c928cc8-f9c3-483b-b029-2c6e898f695b",
        "name": "sample string 2",
        "direction": "sample string 3",
        "distribution_id": "acc57561-29f4-41c3-bd59-53e89629a881",
        "guard_id": "ae535ef6-0091-435f-bcf1-2c1b0acc1829",
        "active": true
      }
    ],
    "clearOperatorPassword": true,
    "active": true,
    "admin": true,
    "badge_tag_id": "sample string 9",
    "cell_phone": "sample string 10",
    "customer_id": "22737315-0811-4d32-a35b-dda6ad9238db",
    "firstname": "sample string 11",
    "id": "8b05115c-83ce-4320-ba84-669eac5f9794",
    "language_code": "sample string 13",
    "lastname": "sample string 14",
    "mail": "sample string 15",
    "operator_code": "sample string 16",
    "operator_password": "sample string 17",
    "phone": "sample string 18",
    "webapp_password_last_update": "2026-01-19T09:22:03.3108679+00:00",
    "role_id": "7f3a2d34-e391-4a69-b638-c29731decffd"
  }
]

application/xml, text/xml

Sample:

<ArrayOfuser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <user>
    <active>true</active>
    <admin>true</admin>
    <badge_tag_id>sample string 9</badge_tag_id>
    <cell_phone>sample string 10</cell_phone>
    <customer_id>22737315-0811-4d32-a35b-dda6ad9238db</customer_id>
    <firstname>sample string 11</firstname>
    <id>8b05115c-83ce-4320-ba84-669eac5f9794</id>
    <language_code>sample string 13</language_code>
    <lastname>sample string 14</lastname>
    <mail>sample string 15</mail>
    <operator_code>sample string 16</operator_code>
    <operator_password>sample string 17</operator_password>
    <phone>sample string 18</phone>
    <role_id>7f3a2d34-e391-4a69-b638-c29731decffd</role_id>
    <webapp_password_last_update>2026-01-19T09:22:03.3108679+00:00</webapp_password_last_update>
    <clearOperatorPassword>true</clearOperatorPassword>
    <customer_name>sample string 1</customer_name>
    <has_operator_password>true</has_operator_password>
    <isFromWpf>true</isFromWpf>
    <locks>
      <lock>
        <active>true</active>
        <direction>sample string 3</direction>
        <distribution_id>acc57561-29f4-41c3-bd59-53e89629a881</distribution_id>
        <guard_id>ae535ef6-0091-435f-bcf1-2c1b0acc1829</guard_id>
        <id>5c928cc8-f9c3-483b-b029-2c6e898f695b</id>
        <name>sample string 2</name>
      </lock>
      <lock>
        <active>true</active>
        <direction>sample string 3</direction>
        <distribution_id>acc57561-29f4-41c3-bd59-53e89629a881</distribution_id>
        <guard_id>ae535ef6-0091-435f-bcf1-2c1b0acc1829</guard_id>
        <id>5c928cc8-f9c3-483b-b029-2c6e898f695b</id>
        <name>sample string 2</name>
      </lock>
    </locks>
    <rights>
      <right>
        <ID>664790fc-97f6-470f-a671-e9452facbb1c</ID>
        <code>sample string 1</code>
      </right>
      <right>
        <ID>664790fc-97f6-470f-a671-e9452facbb1c</ID>
        <code>sample string 1</code>
      </right>
    </rights>
    <sites>
      <site>
        <DB_ip>sample string 5</DB_ip>
        <DB_name>sample string 6</DB_name>
        <DB_password>sample string 7</DB_password>
        <DB_user>sample string 8</DB_user>
        <active>true</active>
        <address>sample string 1</address>
        <city>sample string 2</city>
        <country>sample string 3</country>
        <customer_id>61c170cd-c593-4a6c-98d2-c6c8a212a89a</customer_id>
        <delay_between_scans>9</delay_between_scans>
        <id>44b22dc5-c166-40ae-99cc-1ab7d561771c</id>
        <name>sample string 11</name>
        <number>1</number>
        <ph_max>1</ph_max>
        <ph_min>1</ph_min>
        <selected_sticker_id>db36978f-bc3f-4360-b95f-2060d0b62272</selected_sticker_id>
        <site_analysis_count>1</site_analysis_count>
        <wash_temp>1</wash_temp>
        <wash_temp_duration>1</wash_temp_duration>
        <witness_maxwash>1</witness_maxwash>
        <zip_code>sample string 12</zip_code>
      </site>
      <site>
        <DB_ip>sample string 5</DB_ip>
        <DB_name>sample string 6</DB_name>
        <DB_password>sample string 7</DB_password>
        <DB_user>sample string 8</DB_user>
        <active>true</active>
        <address>sample string 1</address>
        <city>sample string 2</city>
        <country>sample string 3</country>
        <customer_id>61c170cd-c593-4a6c-98d2-c6c8a212a89a</customer_id>
        <delay_between_scans>9</delay_between_scans>
        <id>44b22dc5-c166-40ae-99cc-1ab7d561771c</id>
        <name>sample string 11</name>
        <number>1</number>
        <ph_max>1</ph_max>
        <ph_min>1</ph_min>
        <selected_sticker_id>db36978f-bc3f-4360-b95f-2060d0b62272</selected_sticker_id>
        <site_analysis_count>1</site_analysis_count>
        <wash_temp>1</wash_temp>
        <wash_temp_duration>1</wash_temp_duration>
        <witness_maxwash>1</witness_maxwash>
        <zip_code>sample string 12</zip_code>
      </site>
    </sites>
    <webapp_password>sample string 3</webapp_password>
    <webapp_username>sample string 4</webapp_username>
  </user>
  <user>
    <active>true</active>
    <admin>true</admin>
    <badge_tag_id>sample string 9</badge_tag_id>
    <cell_phone>sample string 10</cell_phone>
    <customer_id>22737315-0811-4d32-a35b-dda6ad9238db</customer_id>
    <firstname>sample string 11</firstname>
    <id>8b05115c-83ce-4320-ba84-669eac5f9794</id>
    <language_code>sample string 13</language_code>
    <lastname>sample string 14</lastname>
    <mail>sample string 15</mail>
    <operator_code>sample string 16</operator_code>
    <operator_password>sample string 17</operator_password>
    <phone>sample string 18</phone>
    <role_id>7f3a2d34-e391-4a69-b638-c29731decffd</role_id>
    <webapp_password_last_update>2026-01-19T09:22:03.3108679+00:00</webapp_password_last_update>
    <clearOperatorPassword>true</clearOperatorPassword>
    <customer_name>sample string 1</customer_name>
    <has_operator_password>true</has_operator_password>
    <isFromWpf>true</isFromWpf>
    <locks>
      <lock>
        <active>true</active>
        <direction>sample string 3</direction>
        <distribution_id>acc57561-29f4-41c3-bd59-53e89629a881</distribution_id>
        <guard_id>ae535ef6-0091-435f-bcf1-2c1b0acc1829</guard_id>
        <id>5c928cc8-f9c3-483b-b029-2c6e898f695b</id>
        <name>sample string 2</name>
      </lock>
      <lock>
        <active>true</active>
        <direction>sample string 3</direction>
        <distribution_id>acc57561-29f4-41c3-bd59-53e89629a881</distribution_id>
        <guard_id>ae535ef6-0091-435f-bcf1-2c1b0acc1829</guard_id>
        <id>5c928cc8-f9c3-483b-b029-2c6e898f695b</id>
        <name>sample string 2</name>
      </lock>
    </locks>
    <rights>
      <right>
        <ID>664790fc-97f6-470f-a671-e9452facbb1c</ID>
        <code>sample string 1</code>
      </right>
      <right>
        <ID>664790fc-97f6-470f-a671-e9452facbb1c</ID>
        <code>sample string 1</code>
      </right>
    </rights>
    <sites>
      <site>
        <DB_ip>sample string 5</DB_ip>
        <DB_name>sample string 6</DB_name>
        <DB_password>sample string 7</DB_password>
        <DB_user>sample string 8</DB_user>
        <active>true</active>
        <address>sample string 1</address>
        <city>sample string 2</city>
        <country>sample string 3</country>
        <customer_id>61c170cd-c593-4a6c-98d2-c6c8a212a89a</customer_id>
        <delay_between_scans>9</delay_between_scans>
        <id>44b22dc5-c166-40ae-99cc-1ab7d561771c</id>
        <name>sample string 11</name>
        <number>1</number>
        <ph_max>1</ph_max>
        <ph_min>1</ph_min>
        <selected_sticker_id>db36978f-bc3f-4360-b95f-2060d0b62272</selected_sticker_id>
        <site_analysis_count>1</site_analysis_count>
        <wash_temp>1</wash_temp>
        <wash_temp_duration>1</wash_temp_duration>
        <witness_maxwash>1</witness_maxwash>
        <zip_code>sample string 12</zip_code>
      </site>
      <site>
        <DB_ip>sample string 5</DB_ip>
        <DB_name>sample string 6</DB_name>
        <DB_password>sample string 7</DB_password>
        <DB_user>sample string 8</DB_user>
        <active>true</active>
        <address>sample string 1</address>
        <city>sample string 2</city>
        <country>sample string 3</country>
        <customer_id>61c170cd-c593-4a6c-98d2-c6c8a212a89a</customer_id>
        <delay_between_scans>9</delay_between_scans>
        <id>44b22dc5-c166-40ae-99cc-1ab7d561771c</id>
        <name>sample string 11</name>
        <number>1</number>
        <ph_max>1</ph_max>
        <ph_min>1</ph_min>
        <selected_sticker_id>db36978f-bc3f-4360-b95f-2060d0b62272</selected_sticker_id>
        <site_analysis_count>1</site_analysis_count>
        <wash_temp>1</wash_temp>
        <wash_temp_duration>1</wash_temp_duration>
        <witness_maxwash>1</witness_maxwash>
        <zip_code>sample string 12</zip_code>
      </site>
    </sites>
    <webapp_password>sample string 3</webapp_password>
    <webapp_username>sample string 4</webapp_username>
  </user>
</ArrayOfuser>