Get All Special Service Groups
GET /ssp/api/1/reference/specialServiceGroup
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)
Returns
{"success" : "true",
"results" : "100",
"rows" :
[{"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"},
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Life Skills",
"id" : "7bf36968-ad48-4c5f-9838-ebf495713c08",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Life Skills",
"objectStatus" : "ACTIVE"},
...
]
}
Get a Special Service Group
GET /ssp/api/1/reference/specialServiceGroup/{id}
Security
SERVICE_REFERENCE_READ
Returns
SpecialServiceGroup
{"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"}
Create a Special Service Group
POST /ssp/api/1/reference/specialServiceGroup
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"description" : "English as a Second Language",
"name" : "English as a Second Language"}
Returns
SpecialServiceGroup
{"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"}
Save a Special Service Group
PUT /ssp/api/1/reference/specialServiceGroup/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"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"}
Returns
SpecialServiceGroup
{"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"}
Delete a Special Service Group
DELETE /ssp/api/1/reference/specialServiceGroup/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}