POST applications/{appId}/scenarios/{scenarioId}/apply

Request Information

URI Parameters

NameDescriptionTypeAdditional information
appId

string

Required

scenarioId

string

Required

Body Parameters

ApplyMoveScenarioData
NameDescriptionTypeAdditional information
assignment_policy

string

None.

Request Formats

application/json, text/json

Sample:
{
  "assignment_policy": "sample string 1"
}

multipart/form-data

Sample:
{"assignment_policy":"sample string 1"}

application/xml, text/xml

Sample:
<ApplyMoveScenarioData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.MoveScenarios">
  <AssignmentPolicy>sample string 1</AssignmentPolicy>
</ApplyMoveScenarioData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MoveScenarioDetails
NameDescriptionTypeAdditional information
id

globally unique identifier

None.

name

string

None.

status

string

None.

created

integer

None.

created_by

string

None.

updated

integer

None.

updated_by

string

None.

floors

Collection of Floor

None.

floor_count

integer

None.

person_count

integer

None.

no_assignment_person_count

integer

None.

has_request

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "994ee5df-f481-4256-ba3e-8093dd46117f",
  "name": "sample string 2",
  "status": "sample string 3",
  "created": 4,
  "created_by": "sample string 5",
  "updated": 6,
  "updated_by": "sample string 7",
  "floors": [
    {
      "id": "sample string 1",
      "label": "sample string 2",
      "valid": true,
      "building": {
        "id": "sample string 1",
        "label": "sample string 2"
      }
    },
    {
      "id": "sample string 1",
      "label": "sample string 2",
      "valid": true,
      "building": {
        "id": "sample string 1",
        "label": "sample string 2"
      }
    }
  ],
  "floor_count": 8,
  "person_count": 9,
  "no_assignment_person_count": 10,
  "has_request": true
}

multipart/form-data

Sample:
{"id":"994ee5df-f481-4256-ba3e-8093dd46117f","name":"sample string 2","status":"sample string 3","created":4,"created_by":"sample string 5","updated":6,"updated_by":"sample string 7","floors":[{"id":"sample string 1","label":"sample string 2","valid":true,"building":{"id":"sample string 1","label":"sample string 2"}},{"id":"sample string 1","label":"sample string 2","valid":true,"building":{"id":"sample string 1","label":"sample string 2"}}],"floor_count":8,"person_count":9,"no_assignment_person_count":10,"has_request":true}

application/xml, text/xml

Sample:
<MoveScenarioDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.MoveScenarios">
  <Created>4</Created>
  <CreatedBy>sample string 5</CreatedBy>
  <FloorCount>8</FloorCount>
  <Floors xmlns:d2p1="http://schemas.datacontract.org/2004/07/application_api.Models.Facility">
    <d2p1:Floor>
      <d2p1:Building>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Label>sample string 2</d2p1:Label>
      </d2p1:Building>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:Valid>true</d2p1:Valid>
    </d2p1:Floor>
    <d2p1:Floor>
      <d2p1:Building>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Label>sample string 2</d2p1:Label>
      </d2p1:Building>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:Valid>true</d2p1:Valid>
    </d2p1:Floor>
  </Floors>
  <HasRequest>true</HasRequest>
  <Id>994ee5df-f481-4256-ba3e-8093dd46117f</Id>
  <Name>sample string 2</Name>
  <NoAssignmentPersonCount>10</NoAssignmentPersonCount>
  <PersonCount>9</PersonCount>
  <Status>sample string 3</Status>
  <Updated>6</Updated>
  <UpdatedBy>sample string 7</UpdatedBy>
</MoveScenarioDetails>