BackofficeApi

<back to all web services

SearchUsersRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/staff/search_users
SearchUsersRequest Parameters:
NameParameterData TypeRequiredDescription
EmailPrefixquerystringYes
SearchUsersResponse Parameters:
NameParameterData TypeRequiredDescription
UsersformList<BackofficeUserDto>Yes
BackofficeUserDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
FirstNameformstringYes
LastNameformstringYes
MobilePhoneformstringYes
LocaleformLocaleNo
Locale Enum:
EnUs
NbNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /staff/search_users HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <Users>
    <BackofficeUserDto>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <Id>0</Id>
      <LastName>String</LastName>
      <Locale>EnUs</Locale>
      <MobilePhone>String</MobilePhone>
    </BackofficeUserDto>
  </Users>
</SearchUsersResponse>