Versions Compared

Key

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

Get All Early Alert Faculty Suggestions

GET /ssp/api/1/reference/facultySuggestionearlyAlertFacultySuggestion

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>
limit : Maximum number of results to return<br>
sort : Property name<br>
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

List<FacultySuggestion>List<EarlyAlertFacultySuggestion>

Code Block
[{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "objectStatus" : "ACTIVE",
  "name" : "See Advisor or Coach",
  "description" : "See advisor or coach",
  "order" : 1},
 {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "createdDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "objectStatus" : "ACTIVE",
  "name" : "The Tutoring/Learning Center",
  "description" : "See the Tutoring/Learning Center.",
  "order" : 2},
 ...
]

 

Get

...

an Early Alert Faculty Suggestion

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

Returns

FacultySuggestionEarlyAlertFacultySuggestion

Code Block
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "See Advisor or Coach",
 "description" : "See advisor or coach.",
 "order" : 1}

 

Create

...

an Early Alert Faculty Suggestion

POST /ssp/api/1/reference/facultySuggestionearlyAlertFacultySuggestion

Sample Post

Code Block
{"name" : "See Instructor"
 "description" : "See instructor."}

Returns

FacultySuggestionEarlyAlertFacultySuggestion

Code Block
{"id" : "73bfcb09-95f5-4f52-87cf-76277193d51c",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "See Instructor",
 "description" : "See instructor.",
 "order" : 3}

 

Save

...

an Early Alert Faculty Suggestion

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

Sample Post

Code Block
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "See Advisor or Coach",
 "description" : "See advisor or coach.",
 "order" : 1}

Returns

FacultySuggestionEarlyAlertFacultySuggestion

Code Block
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "createdDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "See Advisor or Coach",
 "description" : "See advisor or coach.",
 "order" : 1}

 

Delete

...

an Early Alert Faculty Suggestion

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

Returns

Code Block
{"ServiceResponse" : 
    {"success" : "true"}}

or

Code Block
{"ServiceResponse" : 
    {"success" : "false", 
   
 "message" : "Message when success is false."}}