...
GET /ssp/api/1/reference/studentType
Security
SERVICE_REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
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)
...
| Code Block |
|---|
{"success" : "true",
"results" : "100",
"rows" :
[{"id" : "6201b18dce0d041d-9d1dd3ac-48d342a1-82d49085-092e52ad676b7f744240e07e",
"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" : "c57f11e1e34b0d14-7ef2f6f0-49894adb-9ac285c6-7b0690563995694de9fc0685",
"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 /ssp/api/1/reference/studentType/{id}
Security
SERVICE_REFERENCE_READ
Returns
| Code Block |
|---|
{"id" : "6201b18dce0d041d-9d1dd3ac-48d342a1-82d49085-092e52ad676b7f744240e07e",
"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} |
...
POST /ssp/api/1/reference/studentType
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"name" : "Early Alert",
"description" : "Early Alert",
"requireInitialAppointment" : false} |
...
Campus
| Code Block |
|---|
{"id" : "6201b18dce0d041d-9d1dd3ac-48d342a1-82d49085-092e52ad676b7f744240e07e",
"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} |
...
PUT /ssp/api/1/reference/studentType/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
| Code Block |
|---|
{"id" : "6201b18dce0d041d-9d1dd3ac-48d342a1-82d49085-092e52ad676b7f744240e07e",
"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} |
...
StudentType
| Code Block |
|---|
{"id" : "6201b18dce0d041d-9d1dd3ac-48d342a1-82d49085-092e52ad676b7f744240e07e",
"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 /ssp/api/1/reference/studentType/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
| Code Block |
|---|
{"success" : "true"} |
...