Versions Compared

Old Version 3

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Alexander Leader

Saved on

Key

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

Get All Early Alert

...

Suggestions

GET /ssp/api/1/reference/earlyAlertFacultySuggestionearlyAlertSuggestion

Security

SERVICE_REFERENCE_READ

Parameters

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

Returns

List<EarlyAlertFacultySuggestion>

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

 

Get an Early Alert

...

Suggestion

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

Security

SERVICE_REFERENCE_READ

Returns

EarlyAlertFacultySuggestionEarlyAlertSuggestion

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

 

Create an Early Alert

...

Suggestion

POST /ssp/api/1/reference/earlyAlertFacultySuggestionearlyAlertSuggestion

Security

SERVICE_REFERENCE_WRITE

Sample Post

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

Returns

EarlyAlertFacultySuggestionEarlyAlertSuggestion

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

 

Save an Early Alert

...

Suggestion

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "modifiedBy" : 
    {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "objectStatus" : "ACTIVE",
 "name" : "See Advisor or Coach",
 "description" : "See advisor or coach.",
 "ordersortOrder" : 1}

Returns

EarlyAlertFacultySuggestionEarlyAlertSuggestion

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

 

Delete an Early Alert

...

Suggestion

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

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...