Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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)

...

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

Security

SERVICE_REFERENCE_READ

Returns

Code Block
{"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}

...

POST /ssp/api/1/reference/studentType

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"name" : "Early Alert",
 "description" : "Early Alert",
 "requireInitialAppointment" : false}

...

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"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 /ssp/api/1/reference/studentType/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...