Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Referral Sources identify how the student was referred in for advising services.  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)

...

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"createdBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "createdDate" : "1332216000000",
      "description" : "Campus PoliceTwo or more DEV classes.",
      "id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7",
      "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "Campus PoliceDevelopmental",
      "objectStatus" : "ACTIVE"},
     {"createdBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "createdDate" : "1332216000000",
      "description" : "StudentUndecided Conductmajor",
      "id" : "55aebdf7c9ff0ce6-466baec6-49c44be2-a08cb1d1-6e01eaf101d79ca385edc637",
      "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "Student ConductUndecided",
      "objectStatus" : "ACTIVE"},
     ...
    ]
}

...

GET /ssp/api/1/reference/serviceReason/{id}

Security

SERVICE_REFERENCE_READ

Returns

ServiceReason

Code Block
{"createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Campus PoliceTwo or more DEV classes.",
 "id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7",
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Campus PoliceDevelopmental",
 "objectStatus" : "ACTIVE"}

...

POST /ssp/api/1/reference/serviceReason

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"description" : "Campus PoliceTwo or more DEV classes.",
 "name" : "Campus PoliceDevelopmental"}

Returns

ServiceReason

Code Block
{"createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Campus PoliceTwo or more DEV classes.",
 "id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7",
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Campus PoliceDevelopmental",
 "objectStatus" : "ACTIVE"}

...

PUT /ssp/api/1/reference/serviceReason/{id}

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Campus PoliceTwo or more DEV classes.",
 "id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7",
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Campus PoliceDevelopmental",
 "objectStatus" : "ACTIVE"}

...

Code Block
{"createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Campus PoliceTwo or more DEV classes.",
 "id" : "a8c83fd4d95ea029-ee3390c1-46ee4be0-8d89b547-9b2956696f378054fc6914b7",
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Campus PoliceDevelopmental",
 "objectStatus" : "ACTIVE"}

...

DELETE /ssp/api/1/reference/serviceReason/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...