...
GET /ssp/api/1/reference/specialServiceGroup
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>return
limit : Maximum number of results to return<br>return
sort : Property name<br>name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
...
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
{
[{ "createdBysuccess" :
:"true",
{"idmessage" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"results":15,
"firstNamerows" :[ "John",
{ "lastName" : "Doe"},
"id":"0a640a2a-409d-1271-8140-d0c1692a00fe",
"createdDate":1440938671017,
: "1332216000000", "descriptioncreatedBy":{
: "English as a Second Language", "id" : "437f6f2b58ba5ee3-7b1e734e-47b44ae9-8603b9c5-9e1208605c0d943774b4de41",
"modifiedBy" : "firstName":"System",
{"idlastName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Administrator",
"firstNamefullName" :"System "JohnAdministrator",
"lastName" : "Doe"},
"modifiedDate":1469799440140,
: "1332216000000", "namemodifiedBy" :{ "English
as a Second Language", "objectStatusid" : "ACTIVE"},
"c0a80097-5210-159c-8152-10179f730006",
{"createdBy" : {"idfirstName" : "91f46e39-cea8-422b-b215-00f6bcf5d280"Amy",
"firstNamelastName" : "JohnAdministrator",
"lastName" : "Doe"fullName":"Amy Administrator"
},
"createdDateobjectStatus" : "1332216000000ACTIVE",
"descriptionname" : "LifeATD SkillsPilot",
"iddescription" : "7bf36968-ad48-4c5f-9838-ebf495713c08","ATD Pilot",
"modifiedBycode" :"ATD PA00FE",
{ "idnotifyOnWithdraw":false
: "91f46e39-cea8-422b-b215-00f6bcf5d280", },
"firstName"{ : "John",
"lastNameid" : "Doe"},"0a640a2a-409d-1271-8140-d0c138a100fd",
"modifiedDatecreatedDate":1440938658593,
: "1332216000000", "namecreatedBy" :{ "Life Skills",
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"objectStatus" : "ACTIVE"}, "firstName":"System",
"lastName":"Administrator",
... ]
} |
Get a Special Service Group
GET /ssp/api/1/reference/specialServiceGroup/{id}
Returns
SpecialServiceGroup
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "English as a Second Language",
"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "English as a Second Language",
"objectStatus" : "ACTIVE"} |
...
"fullName":"System Administrator"
},
"modifiedDate":1469799442623,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"DEI Focus Group",
"description":"DEI Focus Group",
"code":"DEI F100FD",
"notifyOnWithdraw":false
},
{
"id":"8563dbee-1326-11e2-8e53-406c8f22c3ce",
"createdDate":1412899200000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1469799448890,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Displaced Worker",
"description":"This group is typically focused on vocational retraining.",
"code":"Displ2C3CE",
"notifyOnWithdraw":false
},
{
"id":"f6201a04-bb31-4ca5-b606-609f3ad09f87",
"createdDate":1408492800000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1469799452890,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Distance Learning",
"description":"Student is primarily a distance learner",
"code":"Dista09F87",
"notifyOnWithdraw":false
},
{
"id":"40b6b8aa-bca1-11e1-9344-037cb4088c72",
"createdDate":1408492800000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1469799457063,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Honor Student",
"description":"Students who are part of the Honors Program",
"code":"Honor88C72",
"notifyOnWithdraw":false
},
{
"id":"0a640a2a-409d-1271-8140-d0c0fc9600fc",
"createdDate":1440938643223,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1469799460220,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Learning Community",
"description":"Learning Community",
"code":"Learn600FC",
"notifyOnWithdraw":false
},
{
"id":"0a640a2a-409d-1271-8140-d0bde65200fb",
"createdDate":1440938440913,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1468951739293,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Pathways to Completion",
"description":"Student participating in Pathways to Completion",
"code":"Pathw200FB",
"notifyOnWithdraw":true
},
{
"id":"0a640a2a-409d-1271-8140-d0c3ceb80102",
"createdDate":1440938828087,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1468951709183,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"PSEO",
"description":"PSEO Student",
"code":"PSEO80102",
"notifyOnWithdraw":true
},
{
"id":"0a640a2a-409d-1271-8140-d0c1cdf500ff",
"createdDate":1440938696820,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1468951711573,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Seniors to Sophmores",
"description":"Seniors to Sophmores",
"code":"Senio500FF",
"notifyOnWithdraw":true
},
{
"id":"0a640a2a-409d-1271-8140-d0c224f20100",
"createdDate":1440938719090,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1468951714463,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"State U Dual Admission",
"description":"State U Dual Admission",
"code":"State20100",
"notifyOnWithdraw":true
},
{
"id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
"createdDate":1412899200000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1468951717403,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Student Athlete",
"description":"Student Athletes often face significant schedule balancing challenges.",
"code":"Stude2C3CE",
"notifyOnWithdraw":true
},
{
"id":"0a640a2a-409d-1271-8140-d0c31c810101",
"createdDate":1440938782467,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1468951720307,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"UAAI",
"description":"Urban African American Intiative",
"code":"UAAI10101",
"notifyOnWithdraw":true
}
]
} |
Get a Special Service Group
GET /ssp/api/1/reference/specialServiceGroup/{id}
Security
SERVICE_REFERENCE_READ
Returns
SpecialServiceGroup
| Code Block |
|---|
{
"id":"856a3600-1326-11e2-9b79-406c8f22c3ce",
"createdDate":1412899200000,
"createdBy":{
"id":"58ba5ee3-734e-4ae9-b9c5-943774b4de41",
"firstName":"System",
"lastName":"Administrator",
"fullName":"System Administrator"
},
"modifiedDate":1468951717403,
"modifiedBy":{
"id":"c0a80097-5210-159c-8152-10179f730006",
"firstName":"Amy",
"lastName":"Administrator",
"fullName":"Amy Administrator"
},
"objectStatus":"ACTIVE",
"name":"Student Athlete",
"description":"Student Athletes often face significant schedule balancing challenges.",
"code":"Stude2C3CE",
"notifyOnWithdraw":true
}, |
Create a Special Service Group
POST /ssp/api/1/reference/specialServiceGroup
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"description" : "English as a Second Language",
"name" : "English as a Second Language"
"notifyOnWithdraw" : false
"code" : DEI1801} |
Returns
SpecialServiceGroup
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "English as a Second Language",
"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000"",
"name" : "English as a Second Language",
"notifyOnWithdraw" : false,
"namecode" : "English as a Second LanguageDEI1801",
"objectStatus" : "ACTIVE"} |
...
Save a Special Service Group
PUT /ssp/api/1/reference/specialServiceGroup/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "English as a Second Language",
"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "English as a Second Language",
"notifyOnWithdraw" : false,
"code" : "DEI1801",
"objectStatus" : "ACTIVE"} |
...
| Code Block |
|---|
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "English as a Second Language",
"id" : "437f6f2b-7b1e-47b4-8603-9e1208605c0d",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "English as a Second Language",
"code" : "DEI1801",
"objectStatus" : "ACTIVE"} |
...
DELETE /ssp/api/1/reference/specialServiceGroup/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...