POST api/hire/requestchildusers
Request a users child users
Request Information
URI Parameters
None.
Body Parameters
A ChildUsersRequestModel
ChildUsersRequestModelName | Description | Type | Additional information |
---|---|---|---|
token |
The token returned after login used for authentication |
string |
None. |
userID |
The userid returned after login used for authentication. The child users will be pulled from this userid |
unsigned integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "token": "sample string 1", "userID": 2 }
application/xml, text/xml
Sample:
<ChildUsersRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <token>sample string 1</token> <userID>2</userID> </ChildUsersRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A list of ChildUsersResponseModels
Collection of ChildUsersResponseModelName | Description | Type | Additional information |
---|---|---|---|
userID |
The id of the user |
unsigned integer |
None. |
userName |
The name of the user |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "userID": 1, "userName": "sample string 2" }, { "userID": 1, "userName": "sample string 2" } ]
application/xml, text/xml
Sample:
<ArrayOfChildUsersResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ChildUsersResponseModel> <userID>1</userID> <userName>sample string 2</userName> </ChildUsersResponseModel> <ChildUsersResponseModel> <userID>1</userID> <userName>sample string 2</userName> </ChildUsersResponseModel> </ArrayOfChildUsersResponseModel>