Schedule List API

The Schedule List API provides Green Building Studio client developers a facility for discovering what building operation schedules are currently recognized by Green Building Studio.

Making The Request

To access the Schedule List API, use:

https://gbs.autodesk.com/gbs/api/v1/project/scheduleList/responseFormat

where responseFormat may be either of the following values:

json indicates output in JavaScript Object Notation (JSON)
xml indicates output as XML

Note: If responseFormat is omitted, the output will default to XML.

Schedule List API Responses

Schedule API responses are returned in the format indicated in the responseFormat within the request URL.

JSON Output Example

[{"ScheduleDescription": "Default schedules based on Building Type specified.", "ScheduleId": 1, "ScheduleName": "Default"}, {"ScheduleDescription": "Building is operating at all times throughout the year.", "ScheduleId": 2, "ScheduleName": "24\/7 Facility"}, {"ScheduleDescription": "Building is operating 24 hour M-Sat and closed on Sundays", "ScheduleId": 3, "ScheduleName": "24\/6 Facility"}, {"ScheduleDescription": "Building is operating 24 hour M-F and closed on Saturday and Sundays",     "ScheduleId": 4, "ScheduleName": "24\/5 Facility"}, {"ScheduleDescription": "Building operates everyday, but is closed at night.", "ScheduleId": 5,     "ScheduleName": "12\/7 Facility"}, {"ScheduleDescription": "Building operates M-Sat, but is closed at night and Sundays", "ScheduleId": 6, "ScheduleName": "12\/6 Facility"}, {     "ScheduleDescription": "Building operates M-F, but is closed at night and Weekends", "ScheduleId": 7, "ScheduleName": "12\/5 Facility"}, {"ScheduleDescription": "Facility open during school year but closed summers and holidays.", "ScheduleId": 8, "ScheduleName": "K-12 School"}, {"ScheduleDescription": "Facility open throughout the year but closed on holidays.", "ScheduleId": 9, "ScheduleName": "Year-round School"}, {"ScheduleDescription": "Building operates daily, heaviest in the evenings, closed overnight", "ScheduleId": 10, "ScheduleName": "Theater\/Performing Arts"}, {"ScheduleDescription": "Building operates daily, heaviest Sunday mornings and daytime, closed nights",     "ScheduleId": 11,"ScheduleName": "Worship"}]

XML Output Example

<ArrayOfScheduleItem>
 <ScheduleItem>
  <ScheduleDescription>Default schedules based on Building Type specified.</ScheduleDescription>
  <ScheduleId>1</ScheduleId>
  <ScheduleName>Default</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building is operating at all times throughout the year.</ScheduleDescription>
  <ScheduleId>2</ScheduleId>
  <ScheduleName>24/7 Facility</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building is operating 24 hour M-Sat and closed on Sundays</ScheduleDescription>
  <ScheduleId>3</ScheduleId>
  <ScheduleName>24/6 Facility</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building is operating 24 hour M-F and closed on Saturday and Sundays</ScheduleDescription>
  <ScheduleId>4</ScheduleId>
  <ScheduleName>24/5 Facility</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building operates everyday, but is closed at night.</ScheduleDescription>
  <ScheduleId>5</ScheduleId>
  <ScheduleName>12/7 Facility</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building operates M-Sat, but is closed at night and Sundays</ScheduleDescription>
  <ScheduleId>6</ScheduleId>
  <ScheduleName>12/6 Facility</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building operates M-F, but is closed at night and Weekends</ScheduleDescription>
  <ScheduleId>7</ScheduleId>
  <ScheduleName>12/5 Facility</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Facility open during school year but closed summers and holidays.</ScheduleDescription>
  <ScheduleId>8</ScheduleId>
  <ScheduleName>K-12 School</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Facility open throughout the year but closed on holidays.</ScheduleDescription>
  <ScheduleId>9</ScheduleId>
  <ScheduleName>Year-round School</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building operates daily, heaviest in the evenings, closed overnight</ScheduleDescription>
  <ScheduleId>10</ScheduleId>
  <ScheduleName>Theater/Performing Arts</ScheduleName>
  </ScheduleItem> <ScheduleItem>
  <ScheduleDescription>Building operates daily, heaviest Sunday mornings and daytime, closed nights</ScheduleDescription>
  <ScheduleId>11</ScheduleId>
  <ScheduleName>Worship</ScheduleName>
 </ScheduleItem>
</ArrayOfScheduleItem>