GET api/userapi/usersbyfilter?customerId={customerId}&siteId={siteId}&active={active}&keyword={keyword}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId | globally unique identifier |
None. |
|
| siteId | globally unique identifier |
None. |
|
| active | boolean |
None. |
|
| keyword | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of UserListingViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| customer_name | string |
None. |
|
| firstname | string |
None. |
|
| id | globally unique identifier |
None. |
|
| isProductionSite | boolean |
None. |
|
| lastname | string |
None. |
|
| operator_code | string |
None. |
|
| active | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"customer_name": "sample string 1",
"firstname": "sample string 2",
"id": "de25dcea-6223-48d9-b7f8-e6fb67c4932d",
"isProductionSite": true,
"lastname": "sample string 5",
"operator_code": "sample string 6",
"active": true
},
{
"customer_name": "sample string 1",
"firstname": "sample string 2",
"id": "de25dcea-6223-48d9-b7f8-e6fb67c4932d",
"isProductionSite": true,
"lastname": "sample string 5",
"operator_code": "sample string 6",
"active": true
}
]
application/xml, text/xml
Sample:
<ArrayOfUserListingViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
<UserListingViewModel>
<active>true</active>
<customer_name>sample string 1</customer_name>
<firstname>sample string 2</firstname>
<id>de25dcea-6223-48d9-b7f8-e6fb67c4932d</id>
<isProductionSite>true</isProductionSite>
<lastname>sample string 5</lastname>
<operator_code>sample string 6</operator_code>
</UserListingViewModel>
<UserListingViewModel>
<active>true</active>
<customer_name>sample string 1</customer_name>
<firstname>sample string 2</firstname>
<id>de25dcea-6223-48d9-b7f8-e6fb67c4932d</id>
<isProductionSite>true</isProductionSite>
<lastname>sample string 5</lastname>
<operator_code>sample string 6</operator_code>
</UserListingViewModel>
</ArrayOfUserListingViewModel>