POST applications/{appId}/scenarios/{scenarioId}/people/query
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| appId | string |
Required |
|
| scenarioId | string |
Required |
Body Parameters
MoveScenarioQueryPeopleData| Name | Description | Type | Additional information |
|---|---|---|---|
| search_phrase | string |
None. |
|
| filter | Filter |
None. |
|
| offset | integer |
None. |
|
| limit | integer |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
multipart/form-data
Sample:
Sample not available.
application/xml, text/xml
Sample:
<MoveScenarioQueryPeopleData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.MoveScenarios"> <Filter>None</Filter> <Limit>1</Limit> <Offset>1</Offset> <SearchPhrase>sample string 1</SearchPhrase> </MoveScenarioQueryPeopleData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MoveScenarioPeopleResults| Name | Description | Type | Additional information |
|---|---|---|---|
| people | Collection of MoveScenarioPeopleListItem |
None. |
|
| more | boolean |
None. |
|
| total | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"people": [
{
"id": "sample string 1",
"label": "sample string 2",
"number": "sample string 3",
"unassignments": [
{
"id": "sample string 1",
"label": "sample string 2"
},
{
"id": "sample string 1",
"label": "sample string 2"
}
],
"assignment": {
"id": "sample string 1",
"label": "sample string 2"
}
},
{
"id": "sample string 1",
"label": "sample string 2",
"number": "sample string 3",
"unassignments": [
{
"id": "sample string 1",
"label": "sample string 2"
},
{
"id": "sample string 1",
"label": "sample string 2"
}
],
"assignment": {
"id": "sample string 1",
"label": "sample string 2"
}
}
],
"more": true,
"total": 2
}
multipart/form-data
Sample:
{"people":[{"id":"sample string 1","label":"sample string 2","number":"sample string 3","unassignments":[{"id":"sample string 1","label":"sample string 2"},{"id":"sample string 1","label":"sample string 2"}],"assignment":{"id":"sample string 1","label":"sample string 2"}},{"id":"sample string 1","label":"sample string 2","number":"sample string 3","unassignments":[{"id":"sample string 1","label":"sample string 2"},{"id":"sample string 1","label":"sample string 2"}],"assignment":{"id":"sample string 1","label":"sample string 2"}}],"more":true,"total":2}
application/xml, text/xml
Sample:
<MoveScenarioPeopleResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.MoveScenarios">
<More>true</More>
<People>
<MoveScenarioPeopleListItem>
<Assignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
</Assignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
<Number>sample string 3</Number>
<Unassignments>
<MoveScenarioAssignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
</MoveScenarioAssignment>
<MoveScenarioAssignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
</MoveScenarioAssignment>
</Unassignments>
</MoveScenarioPeopleListItem>
<MoveScenarioPeopleListItem>
<Assignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
</Assignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
<Number>sample string 3</Number>
<Unassignments>
<MoveScenarioAssignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
</MoveScenarioAssignment>
<MoveScenarioAssignment>
<Id>sample string 1</Id>
<Label>sample string 2</Label>
</MoveScenarioAssignment>
</Unassignments>
</MoveScenarioPeopleListItem>
</People>
<Total>2</Total>
</MoveScenarioPeopleResults>