GET CPS/ProfileBadges?SchoolID={SchoolID}&Year={Year}

Get school profile badge attributes for a provided school ID and school year.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SchoolID

integer

Default value is 0
Year

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Get school profile badge attributes for a provided school ID and school year. If School ID is 0 or not provided, all schools will be returned. If school year is 0 or not provided, all school year badges will be returned.

SchoolProfileBadge
NameDescriptionTypeAdditional information
SchoolID

integer

None.
SchoolYear

integer

None.
ReferenceCode

string

None.
Headline

string

None.
Detail

string

None.
SortOrder

integer

None.
LastUpdated

date

None.
CertificationLevel

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "SchoolID": 1,
  "SchoolYear": 2,
  "ReferenceCode": "sample string 3",
  "Headline": "sample string 4",
  "Detail": "sample string 5",
  "SortOrder": 6,
  "LastUpdated": "2025-05-09T07:01:44.9293874-05:00",
  "CertificationLevel": "sample string 7"
}

application/xml, text/xml

Sample: 
<SchoolProfileBadge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataAccess">
  <CertificationLevel>sample string 7</CertificationLevel>
  <Detail>sample string 5</Detail>
  <Headline>sample string 4</Headline>
  <LastUpdated>2025-05-09T07:01:44.9293874-05:00</LastUpdated>
  <ReferenceCode>sample string 3</ReferenceCode>
  <SchoolID>1</SchoolID>
  <SchoolYear>2</SchoolYear>
  <SortOrder>6</SortOrder>
</SchoolProfileBadge>