Service Reasons (previously Reason for Services) identify why the student is receiving the services of the advising/counseling department.
Get All Service Reasons
GET /ssp/api/1/reference/serviceReason
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)
Returns
List<ServiceReason>
{"success" : "true",
"results" : "100",
"rows" :
[{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Two or more DEV classes.",
"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Developmental",
"objectStatus" : "ACTIVE"},
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Undecided major",
"id" : "c9ff0ce6-aec6-4be2-b1d1-9ca385edc637",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Undecided",
"objectStatus" : "ACTIVE"},
...
]
}
Get a Service Reason
GET /ssp/api/1/reference/serviceReason/{id}
Security
SERVICE_REFERENCE_READ
Returns
ServiceReason
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Two or more DEV classes.",
"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Developmental",
"objectStatus" : "ACTIVE"}
Create a Service Reason
POST /ssp/api/1/reference/serviceReason
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"description" : "Two or more DEV classes.",
"name" : "Developmental"}
Returns
ServiceReason
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Two or more DEV classes.",
"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Developmental",
"objectStatus" : "ACTIVE"}
Save a Service Reason
PUT /ssp/api/1/reference/serviceReason/{id}
Security
SERVICE_REFERENCE_WRITE
Sample Post
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Two or more DEV classes.",
"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Developmental",
"objectStatus" : "ACTIVE"}
Returns
ServiceReason
{"createdBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"createdDate" : "1332216000000",
"description" : "Two or more DEV classes.",
"id" : "d95ea029-90c1-4be0-b547-8054fc6914b7",
"modifiedBy" :
{"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
"firstName" : "John",
"lastName" : "Doe"},
"modifiedDate" : "1332216000000",
"name" : "Developmental",
"objectStatus" : "ACTIVE"}
Delete a Service Reason
DELETE /ssp/api/1/reference/serviceReason/{id}
Security
SERVICE_REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}