POST api/Space/buildings

Gets a list of building available for the service account's campuses

Request Information

URI Parameters

None.

Body Parameters

FilterSpace
NameDescriptionTypeAdditional information
TaskValue

Collection of string

None.

SpaceID

integer

None.

ParentID

integer

None.

IsSpaceTree

boolean

None.

SpaceTypeID

integer

None.

IsActive

boolean

None.

SearchText

string

None.

QuickSearchTitle

string

None.

AccountID

integer

None.

SystemID

integer

None.

SpaceGroupID

integer

None.

SpaceContentID

integer

None.

ScheduleID

integer

None.

IsOnScheduleID

integer

None.

TaskID

integer

None.

Frequency

integer

None.

ScheduleStatusID

integer

None.

Level

integer

None.

IsPatientSpace

boolean

None.

ExcludeSpacesInBedStatLayoutID

integer

None.

IncludeInactive

boolean

None.

RoomsMustContainBeds

boolean

None.

VerifiedSinceDate

date

None.

HasInspectionTemplate

boolean

None.

IsHRS

boolean

None.

AllCampuses

Collection of SimpleItem

None.

CampusId

integer

None.

Buildings

Collection of integer

None.

SpaceTreeParentIDs

Collection of integer

None.

SpaceTreeChildIDs

Collection of integer

None.

Floor

integer

None.

Area

integer

None.

SurfaceType

integer

None.

ComparisonOperator

string

None.

SqFtValue

integer

None.

NetCleanableAny

boolean

None.

NetCleanableValue

boolean

None.

FinishedAny

boolean

None.

FinishedValue

boolean

None.

ContentComments

string

None.

ProjectTask

integer

None.

BaseMonth

integer

None.

ScheduledAny

boolean

None.

ScheduledValue

boolean

None.

FilterForSpaceMassUpdate

boolean

None.

IsQRScanSearch

boolean

None.

FinishTypeID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "TaskValue": [
    "sample string 1",
    "sample string 2"
  ],
  "SpaceID": 1,
  "ParentID": 1,
  "IsSpaceTree": true,
  "SpaceTypeID": 1,
  "IsActive": true,
  "SearchText": "sample string 2",
  "QuickSearchTitle": "sample string 3",
  "AccountID": 1,
  "SystemID": 1,
  "SpaceGroupID": 1,
  "SpaceContentID": 1,
  "ScheduleID": 1,
  "IsOnScheduleID": 1,
  "TaskID": 1,
  "Frequency": 1,
  "ScheduleStatusID": 1,
  "Level": 1,
  "IsPatientSpace": true,
  "ExcludeSpacesInBedStatLayoutID": 1,
  "IncludeInactive": true,
  "RoomsMustContainBeds": true,
  "VerifiedSinceDate": "2024-05-18T05:04:23.1832374Z",
  "HasInspectionTemplate": true,
  "IsHRS": true,
  "AllCampuses": [
    {
      "ID": 1,
      "Description": "sample string 2",
      "Value": "sample string 3",
      "EnDescription": "samplestring2",
      "AccountID": 4,
      "IsEditable": true,
      "IsSelectable": true,
      "Code": "sample string 7",
      "Color": "sample string 8",
      "ShortDescription": "sample string 9"
    },
    {
      "ID": 1,
      "Description": "sample string 2",
      "Value": "sample string 3",
      "EnDescription": "samplestring2",
      "AccountID": 4,
      "IsEditable": true,
      "IsSelectable": true,
      "Code": "sample string 7",
      "Color": "sample string 8",
      "ShortDescription": "sample string 9"
    }
  ],
  "CampusId": 1,
  "Buildings": [
    1,
    2
  ],
  "SpaceTreeParentIDs": [
    1,
    2
  ],
  "SpaceTreeChildIDs": [
    1,
    2
  ],
  "Floor": 1,
  "Area": 1,
  "SurfaceType": 1,
  "ComparisonOperator": "sample string 4",
  "SqFtValue": 1,
  "NetCleanableAny": true,
  "NetCleanableValue": true,
  "FinishedAny": true,
  "FinishedValue": true,
  "ContentComments": "sample string 9",
  "ProjectTask": 1,
  "BaseMonth": 10,
  "ScheduledAny": true,
  "ScheduledValue": true,
  "FilterForSpaceMassUpdate": true,
  "IsQRScanSearch": true,
  "FinishTypeID": 1
}

application/xml, text/xml

Sample:
<FilterSpace xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aramark.ISIS.Domain.Filters">
  <AccountID>1</AccountID>
  <AllCampuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/Aramark.ISIS.Domain.Models">
    <d2p1:SimpleItem>
      <d2p1:AccountID>4</d2p1:AccountID>
      <d2p1:Code>sample string 7</d2p1:Code>
      <d2p1:Color>sample string 8</d2p1:Color>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IsEditable>true</d2p1:IsEditable>
      <d2p1:IsSelectable>true</d2p1:IsSelectable>
      <d2p1:ShortDescription>sample string 9</d2p1:ShortDescription>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:SimpleItem>
    <d2p1:SimpleItem>
      <d2p1:AccountID>4</d2p1:AccountID>
      <d2p1:Code>sample string 7</d2p1:Code>
      <d2p1:Color>sample string 8</d2p1:Color>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IsEditable>true</d2p1:IsEditable>
      <d2p1:IsSelectable>true</d2p1:IsSelectable>
      <d2p1:ShortDescription>sample string 9</d2p1:ShortDescription>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:SimpleItem>
  </AllCampuses>
  <Area>1</Area>
  <BaseMonth>10</BaseMonth>
  <Buildings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Buildings>
  <CampusId>1</CampusId>
  <ComparisonOperator>sample string 4</ComparisonOperator>
  <ContentComments>sample string 9</ContentComments>
  <ExcludeSpacesInBedStatLayoutID>1</ExcludeSpacesInBedStatLayoutID>
  <FilterForSpaceMassUpdate>true</FilterForSpaceMassUpdate>
  <FinishTypeID>1</FinishTypeID>
  <FinishedAny>true</FinishedAny>
  <FinishedValue>true</FinishedValue>
  <Floor>1</Floor>
  <Frequency>1</Frequency>
  <HasInspectionTemplate>true</HasInspectionTemplate>
  <IncludeInactive>true</IncludeInactive>
  <IsActive>true</IsActive>
  <IsHRS>true</IsHRS>
  <IsOnScheduleID>1</IsOnScheduleID>
  <IsPatientSpace>true</IsPatientSpace>
  <IsQRScanSearch>true</IsQRScanSearch>
  <IsSpaceTree>true</IsSpaceTree>
  <Level>1</Level>
  <NetCleanableAny>true</NetCleanableAny>
  <NetCleanableValue>true</NetCleanableValue>
  <ParentID>1</ParentID>
  <ProjectTask>1</ProjectTask>
  <QuickSearchTitle>sample string 3</QuickSearchTitle>
  <RoomsMustContainBeds>true</RoomsMustContainBeds>
  <ScheduleID>1</ScheduleID>
  <ScheduleStatusID>1</ScheduleStatusID>
  <ScheduledAny>true</ScheduledAny>
  <ScheduledValue>true</ScheduledValue>
  <SearchText>sample string 2</SearchText>
  <SpaceContentID>1</SpaceContentID>
  <SpaceGroupID>1</SpaceGroupID>
  <SpaceID>1</SpaceID>
  <SpaceTreeChildIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SpaceTreeChildIDs>
  <SpaceTreeParentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SpaceTreeParentIDs>
  <SpaceTypeID>1</SpaceTypeID>
  <SqFtValue>1</SqFtValue>
  <SurfaceType>1</SurfaceType>
  <SystemID>1</SystemID>
  <TaskID>1</TaskID>
  <TaskValue xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </TaskValue>
  <VerifiedSinceDate>2024-05-18T05:04:23.1832374+00:00</VerifiedSinceDate>
</FilterSpace>

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 'FilterSpace'.

Response Information

Resource Description

A list of spaces at the Building level

Collection of SimpleItem
NameDescriptionTypeAdditional information
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:
[
  {
    "ID": 1,
    "Description": "sample string 2",
    "Value": "sample string 3",
    "EnDescription": "samplestring2",
    "AccountID": 4,
    "IsEditable": true,
    "IsSelectable": true,
    "Code": "sample string 7",
    "Color": "sample string 8",
    "ShortDescription": "sample string 9"
  },
  {
    "ID": 1,
    "Description": "sample string 2",
    "Value": "sample string 3",
    "EnDescription": "samplestring2",
    "AccountID": 4,
    "IsEditable": true,
    "IsSelectable": true,
    "Code": "sample string 7",
    "Color": "sample string 8",
    "ShortDescription": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSimpleItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aramark.ISIS.Domain.Models">
  <SimpleItem>
    <AccountID>4</AccountID>
    <Code>sample string 7</Code>
    <Color>sample string 8</Color>
    <Description>sample string 2</Description>
    <ID>1</ID>
    <IsEditable>true</IsEditable>
    <IsSelectable>true</IsSelectable>
    <ShortDescription>sample string 9</ShortDescription>
    <Value>sample string 3</Value>
  </SimpleItem>
  <SimpleItem>
    <AccountID>4</AccountID>
    <Code>sample string 7</Code>
    <Color>sample string 8</Color>
    <Description>sample string 2</Description>
    <ID>1</ID>
    <IsEditable>true</IsEditable>
    <IsSelectable>true</IsSelectable>
    <ShortDescription>sample string 9</ShortDescription>
    <Value>sample string 3</Value>
  </SimpleItem>
</ArrayOfSimpleItem>