POST api/Space/selection/{id}?includeActive={includeActive}

Searches for spaces that match the specified criteria

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID value of the campus to search

integer

Required

includeActive

boolean

Required

Body Parameters

The text to search for. This will be matched as a "contains" clause

string

Request Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'String'.

Response Information

Resource Description

A list of spaces matching the criteria

Collection of SpaceSelectionSimpleSpace
NameDescriptionTypeAdditional information
Beds

integer

None.

PatientBeds

integer

None.

LastVerificationDate

date

None.

SpacePath

string

None.

AncestorList

Collection of string

None.

SpacePathDescription

string

None.

SpacePathList

Collection of SimpleSpace

None.

ID

integer

None.

Description

string

Required

Value

string

None.

EnDescription

string

None.

AccountID

integer

None.

IsEditable

boolean

None.

IsSelectable

boolean

None.

Code

string

None.

Color

string

None.

ShortDescription

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Beds": 1,
    "PatientBeds": 1,
    "LastVerificationDate": "2024-05-18T03:43:53.7913905Z",
    "SpacePath": "sample string 2",
    "AncestorList": [
      "sample string 1",
      "sample string 2"
    ],
    "SpacePathDescription": "sample string 1 \\ sample string 2 \\ sample string 4",
    "SpacePathList": [],
    "ID": 3,
    "Description": "sample string 4",
    "Value": "sample string 5",
    "EnDescription": "samplestring4",
    "AccountID": 6,
    "IsEditable": true,
    "IsSelectable": true,
    "Code": "sample string 9",
    "Color": "sample string 10",
    "ShortDescription": "sample string 11"
  },
  {
    "Beds": 1,
    "PatientBeds": 1,
    "LastVerificationDate": "2024-05-18T03:43:53.7913905Z",
    "SpacePath": "sample string 2",
    "AncestorList": [
      "sample string 1",
      "sample string 2"
    ],
    "SpacePathDescription": "sample string 1 \\ sample string 2 \\ sample string 4",
    "SpacePathList": [],
    "ID": 3,
    "Description": "sample string 4",
    "Value": "sample string 5",
    "EnDescription": "samplestring4",
    "AccountID": 6,
    "IsEditable": true,
    "IsSelectable": true,
    "Code": "sample string 9",
    "Color": "sample string 10",
    "ShortDescription": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSpaceSelectionSimpleSpace xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aramark.ISIS.Domain.Models">
  <SpaceSelectionSimpleSpace>
    <AccountID>6</AccountID>
    <Code>sample string 9</Code>
    <Color>sample string 10</Color>
    <Description>sample string 4</Description>
    <ID>3</ID>
    <IsEditable>true</IsEditable>
    <IsSelectable>true</IsSelectable>
    <ShortDescription>sample string 11</ShortDescription>
    <Value>sample string 5</Value>
    <AncestorList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AncestorList>
    <Beds>1</Beds>
    <LastVerificationDate>2024-05-18T03:43:53.7913905+00:00</LastVerificationDate>
    <PatientBeds>1</PatientBeds>
    <SpacePath>sample string 2</SpacePath>
    <SpacePathList />
  </SpaceSelectionSimpleSpace>
  <SpaceSelectionSimpleSpace>
    <AccountID>6</AccountID>
    <Code>sample string 9</Code>
    <Color>sample string 10</Color>
    <Description>sample string 4</Description>
    <ID>3</ID>
    <IsEditable>true</IsEditable>
    <IsSelectable>true</IsSelectable>
    <ShortDescription>sample string 11</ShortDescription>
    <Value>sample string 5</Value>
    <AncestorList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AncestorList>
    <Beds>1</Beds>
    <LastVerificationDate>2024-05-18T03:43:53.7913905+00:00</LastVerificationDate>
    <PatientBeds>1</PatientBeds>
    <SpacePath>sample string 2</SpacePath>
    <SpacePathList />
  </SpaceSelectionSimpleSpace>
</ArrayOfSpaceSelectionSimpleSpace>