GET applications/{appId}/scenarios/{scenarioId}/validate?assignment_policy={assignment_policy}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
appId

string

Required

scenarioId

string

Required

assignment_policy

string

Required

Body Parameters

None.

Response Information

Resource Description

MoveScenarioValidationResults
NameDescriptionTypeAdditional information
error_count

integer

None.

warning_count

integer

None.

people

Collection of PersonValidationResult

None.

unassignments

Collection of UnassignmentValidationResult

None.

assignments

Collection of AssignmentValidationResult

None.

floors

Collection of FloorValidationResult

None.

Response Formats

application/json, text/json

Sample:
{
  "error_count": 1,
  "warning_count": 2,
  "people": [
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "person_key": "sample string 1",
        "person_label": "sample string 2",
        "resultant_assignment_count": 3
      }
    },
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "person_key": "sample string 1",
        "person_label": "sample string 2",
        "resultant_assignment_count": 3
      }
    }
  ],
  "unassignments": [
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "person_key": "sample string 1",
        "person_label": "sample string 2",
        "space_key": "sample string 3",
        "space_label": "sample string 4"
      }
    },
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "person_key": "sample string 1",
        "person_label": "sample string 2",
        "space_key": "sample string 3",
        "space_label": "sample string 4"
      }
    }
  ],
  "assignments": [
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "person_label": "sample string 2",
        "space_key": "sample string 3",
        "space_label": "sample string 4",
        "capacity": 1,
        "resultant_assignment_count": 5
      }
    },
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "person_label": "sample string 2",
        "space_key": "sample string 3",
        "space_label": "sample string 4",
        "capacity": 1,
        "resultant_assignment_count": 5
      }
    }
  ],
  "floors": [
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "floor_key": "sample string 1"
      }
    },
    {
      "code": "sample string 1",
      "type": "sample string 2",
      "arguments": {
        "floor_key": "sample string 1"
      }
    }
  ]
}

multipart/form-data

Sample:
{"error_count":1,"warning_count":2,"people":[{"code":"sample string 1","type":"sample string 2","arguments":{"person_key":"sample string 1","person_label":"sample string 2","resultant_assignment_count":3}},{"code":"sample string 1","type":"sample string 2","arguments":{"person_key":"sample string 1","person_label":"sample string 2","resultant_assignment_count":3}}],"unassignments":[{"code":"sample string 1","type":"sample string 2","arguments":{"person_key":"sample string 1","person_label":"sample string 2","space_key":"sample string 3","space_label":"sample string 4"}},{"code":"sample string 1","type":"sample string 2","arguments":{"person_key":"sample string 1","person_label":"sample string 2","space_key":"sample string 3","space_label":"sample string 4"}}],"assignments":[{"code":"sample string 1","type":"sample string 2","arguments":{"person_label":"sample string 2","space_key":"sample string 3","space_label":"sample string 4","capacity":1,"resultant_assignment_count":5}},{"code":"sample string 1","type":"sample string 2","arguments":{"person_label":"sample string 2","space_key":"sample string 3","space_label":"sample string 4","capacity":1,"resultant_assignment_count":5}}],"floors":[{"code":"sample string 1","type":"sample string 2","arguments":{"floor_key":"sample string 1"}},{"code":"sample string 1","type":"sample string 2","arguments":{"floor_key":"sample string 1"}}]}

application/xml, text/xml

Sample:
<MoveScenarioValidationResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.MoveScenarios.Validation">
  <Assignments>
    <AssignmentValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <Capacity>1</Capacity>
        <PersonKey>sample string 1</PersonKey>
        <PersonLabel>sample string 2</PersonLabel>
        <ResultantAssignmentCount>5</ResultantAssignmentCount>
        <SpaceKey>sample string 3</SpaceKey>
        <SpaceLabel>sample string 4</SpaceLabel>
      </Arguments>
    </AssignmentValidationResult>
    <AssignmentValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <Capacity>1</Capacity>
        <PersonKey>sample string 1</PersonKey>
        <PersonLabel>sample string 2</PersonLabel>
        <ResultantAssignmentCount>5</ResultantAssignmentCount>
        <SpaceKey>sample string 3</SpaceKey>
        <SpaceLabel>sample string 4</SpaceLabel>
      </Arguments>
    </AssignmentValidationResult>
  </Assignments>
  <ErrorCount>1</ErrorCount>
  <Floors>
    <FloorValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <FloorKey>sample string 1</FloorKey>
      </Arguments>
    </FloorValidationResult>
    <FloorValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <FloorKey>sample string 1</FloorKey>
      </Arguments>
    </FloorValidationResult>
  </Floors>
  <People>
    <PersonValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <PersonKey>sample string 1</PersonKey>
        <PersonLabel>sample string 2</PersonLabel>
        <ResultantAssignmentCount>3</ResultantAssignmentCount>
      </Arguments>
    </PersonValidationResult>
    <PersonValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <PersonKey>sample string 1</PersonKey>
        <PersonLabel>sample string 2</PersonLabel>
        <ResultantAssignmentCount>3</ResultantAssignmentCount>
      </Arguments>
    </PersonValidationResult>
  </People>
  <Unassignments>
    <UnassignmentValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <PersonKey>sample string 1</PersonKey>
        <PersonLabel>sample string 2</PersonLabel>
        <SpaceKey>sample string 3</SpaceKey>
        <SpaceLabel>sample string 4</SpaceLabel>
      </Arguments>
    </UnassignmentValidationResult>
    <UnassignmentValidationResult>
      <Code>sample string 1</Code>
      <Type>sample string 2</Type>
      <Arguments>
        <PersonKey>sample string 1</PersonKey>
        <PersonLabel>sample string 2</PersonLabel>
        <SpaceKey>sample string 3</SpaceKey>
        <SpaceLabel>sample string 4</SpaceLabel>
      </Arguments>
    </UnassignmentValidationResult>
  </Unassignments>
  <WarningCount>2</WarningCount>
</MoveScenarioValidationResults>