GET CPS/ActionsList?SearchValue={SearchValue}
Get school action information with optional filter on school year, school id, or school name.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SearchValue |
Default value is empty string. Ex: api.cps.edu/schoolactions/cps/ActionsList? |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Numeric value for search term will return all results for a requested school year or school id.
Collection of ActionSummaryName | Description | Type | Additional information |
---|---|---|---|
Events | Collection of ActionEvent |
None. |
|
Documents | Collection of ActionDocument |
None. |
|
SchoolID | string |
None. |
|
FormattedSchoolYear | string |
None. |
|
SchoolYear | integer |
None. |
|
SchoolShortName | string |
None. |
|
SchoolLongName | string |
None. |
|
AddressStreet | string |
None. |
|
AddressCity | string |
None. |
|
AddressState | string |
None. |
|
AddressZip | string |
None. |
|
PhoneNumber | string |
None. |
|
ActionType | string |
None. |
|
ActionDescription | string |
None. |
|
Notes | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Events": [ { "EventID": 1, "SchoolID": "sample string 2", "FormattedSchoolYear": "sample string 3", "SchoolYear": 1, "EventType": "sample string 4", "LocationName": "sample string 5", "StreetAddress": "sample string 6", "EventStart": "2024-10-09T04:18:59.6318106-05:00", "EventEnd": "2024-10-09T04:18:59.6318106-05:00" }, { "EventID": 1, "SchoolID": "sample string 2", "FormattedSchoolYear": "sample string 3", "SchoolYear": 1, "EventType": "sample string 4", "LocationName": "sample string 5", "StreetAddress": "sample string 6", "EventStart": "2024-10-09T04:18:59.6318106-05:00", "EventEnd": "2024-10-09T04:18:59.6318106-05:00" } ], "Documents": [ { "FileDownloadURL": "sample string 1", "FileID": 2, "SchoolID": "sample string 3", "FormattedSchoolYear": "sample string 4", "SchoolYear": 1, "FullFileName": "sample string 5", "Category": "sample string 6", "FileExtension": "sample string 7", "FileSize": 8, "ContentDataType": "sample string 9", "FileCreated": "2024-10-09T04:18:59.6318106-05:00", "Notes": "sample string 10" }, { "FileDownloadURL": "sample string 1", "FileID": 2, "SchoolID": "sample string 3", "FormattedSchoolYear": "sample string 4", "SchoolYear": 1, "FullFileName": "sample string 5", "Category": "sample string 6", "FileExtension": "sample string 7", "FileSize": 8, "ContentDataType": "sample string 9", "FileCreated": "2024-10-09T04:18:59.6318106-05:00", "Notes": "sample string 10" } ], "SchoolID": "sample string 1", "FormattedSchoolYear": "sample string 2", "SchoolYear": 1, "SchoolShortName": "sample string 3", "SchoolLongName": "sample string 4", "AddressStreet": "sample string 5", "AddressCity": "sample string 6", "AddressState": "sample string 7", "AddressZip": "sample string 8", "PhoneNumber": "sample string 9", "ActionType": "sample string 10", "ActionDescription": "sample string 11", "Notes": "sample string 12" }, { "Events": [ { "EventID": 1, "SchoolID": "sample string 2", "FormattedSchoolYear": "sample string 3", "SchoolYear": 1, "EventType": "sample string 4", "LocationName": "sample string 5", "StreetAddress": "sample string 6", "EventStart": "2024-10-09T04:18:59.6318106-05:00", "EventEnd": "2024-10-09T04:18:59.6318106-05:00" }, { "EventID": 1, "SchoolID": "sample string 2", "FormattedSchoolYear": "sample string 3", "SchoolYear": 1, "EventType": "sample string 4", "LocationName": "sample string 5", "StreetAddress": "sample string 6", "EventStart": "2024-10-09T04:18:59.6318106-05:00", "EventEnd": "2024-10-09T04:18:59.6318106-05:00" } ], "Documents": [ { "FileDownloadURL": "sample string 1", "FileID": 2, "SchoolID": "sample string 3", "FormattedSchoolYear": "sample string 4", "SchoolYear": 1, "FullFileName": "sample string 5", "Category": "sample string 6", "FileExtension": "sample string 7", "FileSize": 8, "ContentDataType": "sample string 9", "FileCreated": "2024-10-09T04:18:59.6318106-05:00", "Notes": "sample string 10" }, { "FileDownloadURL": "sample string 1", "FileID": 2, "SchoolID": "sample string 3", "FormattedSchoolYear": "sample string 4", "SchoolYear": 1, "FullFileName": "sample string 5", "Category": "sample string 6", "FileExtension": "sample string 7", "FileSize": 8, "ContentDataType": "sample string 9", "FileCreated": "2024-10-09T04:18:59.6318106-05:00", "Notes": "sample string 10" } ], "SchoolID": "sample string 1", "FormattedSchoolYear": "sample string 2", "SchoolYear": 1, "SchoolShortName": "sample string 3", "SchoolLongName": "sample string 4", "AddressStreet": "sample string 5", "AddressCity": "sample string 6", "AddressState": "sample string 7", "AddressZip": "sample string 8", "PhoneNumber": "sample string 9", "ActionType": "sample string 10", "ActionDescription": "sample string 11", "Notes": "sample string 12" } ]
application/xml, text/xml
Sample:
<ArrayOfActionSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ActionSummary> <SchoolID>sample string 1</SchoolID> <FormattedSchoolYear>sample string 2</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <SchoolShortName>sample string 3</SchoolShortName> <SchoolLongName>sample string 4</SchoolLongName> <AddressStreet>sample string 5</AddressStreet> <AddressCity>sample string 6</AddressCity> <AddressState>sample string 7</AddressState> <AddressZip>sample string 8</AddressZip> <PhoneNumber>sample string 9</PhoneNumber> <ActionType>sample string 10</ActionType> <ActionDescription>sample string 11</ActionDescription> <Notes>sample string 12</Notes> <Events> <ActionEvent> <EventID>1</EventID> <SchoolID>sample string 2</SchoolID> <FormattedSchoolYear>sample string 3</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <EventType>sample string 4</EventType> <LocationName>sample string 5</LocationName> <StreetAddress>sample string 6</StreetAddress> <EventStart>2024-10-09T04:18:59.6318106-05:00</EventStart> <EventEnd>2024-10-09T04:18:59.6318106-05:00</EventEnd> </ActionEvent> <ActionEvent> <EventID>1</EventID> <SchoolID>sample string 2</SchoolID> <FormattedSchoolYear>sample string 3</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <EventType>sample string 4</EventType> <LocationName>sample string 5</LocationName> <StreetAddress>sample string 6</StreetAddress> <EventStart>2024-10-09T04:18:59.6318106-05:00</EventStart> <EventEnd>2024-10-09T04:18:59.6318106-05:00</EventEnd> </ActionEvent> </Events> <Documents> <ActionDocument> <FileID>2</FileID> <SchoolID>sample string 3</SchoolID> <FormattedSchoolYear>sample string 4</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <FullFileName>sample string 5</FullFileName> <Category>sample string 6</Category> <FileExtension>sample string 7</FileExtension> <FileSize>8</FileSize> <ContentDataType>sample string 9</ContentDataType> <FileCreated>2024-10-09T04:18:59.6318106-05:00</FileCreated> <Notes>sample string 10</Notes> <FileDownloadURL>sample string 1</FileDownloadURL> </ActionDocument> <ActionDocument> <FileID>2</FileID> <SchoolID>sample string 3</SchoolID> <FormattedSchoolYear>sample string 4</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <FullFileName>sample string 5</FullFileName> <Category>sample string 6</Category> <FileExtension>sample string 7</FileExtension> <FileSize>8</FileSize> <ContentDataType>sample string 9</ContentDataType> <FileCreated>2024-10-09T04:18:59.6318106-05:00</FileCreated> <Notes>sample string 10</Notes> <FileDownloadURL>sample string 1</FileDownloadURL> </ActionDocument> </Documents> </ActionSummary> <ActionSummary> <SchoolID>sample string 1</SchoolID> <FormattedSchoolYear>sample string 2</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <SchoolShortName>sample string 3</SchoolShortName> <SchoolLongName>sample string 4</SchoolLongName> <AddressStreet>sample string 5</AddressStreet> <AddressCity>sample string 6</AddressCity> <AddressState>sample string 7</AddressState> <AddressZip>sample string 8</AddressZip> <PhoneNumber>sample string 9</PhoneNumber> <ActionType>sample string 10</ActionType> <ActionDescription>sample string 11</ActionDescription> <Notes>sample string 12</Notes> <Events> <ActionEvent> <EventID>1</EventID> <SchoolID>sample string 2</SchoolID> <FormattedSchoolYear>sample string 3</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <EventType>sample string 4</EventType> <LocationName>sample string 5</LocationName> <StreetAddress>sample string 6</StreetAddress> <EventStart>2024-10-09T04:18:59.6318106-05:00</EventStart> <EventEnd>2024-10-09T04:18:59.6318106-05:00</EventEnd> </ActionEvent> <ActionEvent> <EventID>1</EventID> <SchoolID>sample string 2</SchoolID> <FormattedSchoolYear>sample string 3</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <EventType>sample string 4</EventType> <LocationName>sample string 5</LocationName> <StreetAddress>sample string 6</StreetAddress> <EventStart>2024-10-09T04:18:59.6318106-05:00</EventStart> <EventEnd>2024-10-09T04:18:59.6318106-05:00</EventEnd> </ActionEvent> </Events> <Documents> <ActionDocument> <FileID>2</FileID> <SchoolID>sample string 3</SchoolID> <FormattedSchoolYear>sample string 4</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <FullFileName>sample string 5</FullFileName> <Category>sample string 6</Category> <FileExtension>sample string 7</FileExtension> <FileSize>8</FileSize> <ContentDataType>sample string 9</ContentDataType> <FileCreated>2024-10-09T04:18:59.6318106-05:00</FileCreated> <Notes>sample string 10</Notes> <FileDownloadURL>sample string 1</FileDownloadURL> </ActionDocument> <ActionDocument> <FileID>2</FileID> <SchoolID>sample string 3</SchoolID> <FormattedSchoolYear>sample string 4</FormattedSchoolYear> <SchoolYear>1</SchoolYear> <FullFileName>sample string 5</FullFileName> <Category>sample string 6</Category> <FileExtension>sample string 7</FileExtension> <FileSize>8</FileSize> <ContentDataType>sample string 9</ContentDataType> <FileCreated>2024-10-09T04:18:59.6318106-05:00</FileCreated> <Notes>sample string 10</Notes> <FileDownloadURL>sample string 1</FileDownloadURL> </ActionDocument> </Documents> </ActionSummary> </ArrayOfActionSummary>