Get All Student Types
GET /ssp/api/1/reference/studentType
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" :
[{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Early Alert",
"description" : "Early Alert Student",
"requireInitialAppointment" : false},
{"id" : "e34b0d14-f6f0-4adb-85c6-694de9fc0685",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Transfer",
"description" : "Transfer student",
"requireInitialAppointment" : true},
...
]
}
Get a Student Type
GET /ssp/api/1/reference/studentType/{id}
Security
SERVICE_REFERENCE_READ
Returns
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Early Alert",
"description" : "Early Alert",
"requireInitialAppointment" : false}
Create a Student Type
POST /ssp/api/1/reference/studentType
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"name" : "Early Alert",
"description" : "Early Alert",
"requireInitialAppointment" : false}
Returns
Campus
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Early Alert",
"description" : "Early Alert",
"requireInitialAppointment" : false}
Save a Student Type
PUT /ssp/api/1/reference/studentType/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Early Alert",
"description" : "Early Alert",
"requireInitialAppointment" : false}
Returns
StudentType
{"id" : "ce0d041d-d3ac-42a1-9085-7f744240e07e",
"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"objectStatus" : "ACTIVE",
"name" : "Early Alert",
"description" : "Early Alert",
"requireInitialAppointment" : false}
Delete a Student Type
DELETE /ssp/api/1/reference/studentType/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}