Versions Compared

Old Version 1

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 /ssp/api/1/reference/programStatusChangeReason

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" : 
    [{"id" : "acf7d72123a93baa-196f3eb6-43534a59-9508a540-fe86c61e3c1d614637322c53",
      "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" : "ActiveFinancially Unable to Pay for Tuition",
      "description" : "StudentFinancially isUnable partto ofPay an active program.for Tuition"},
     {"id" : "e8f6a45bd0af4f16-79ce3b42-46874369-831cb684-ca5f190dddc328f003cf5918",
      "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" : "Non-participatingServices Not Needed",
      "description" : "TheServices student has chosen to not participate in the advising services offered by the college.Not Needed"},
     ...
    ]
}

 

Get a Program Status Change Reason

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

Security

SERVICE_REFERENCE_READ

Returns

Code Block
{"id" : "acf7d72123a93baa-196f3eb6-43534a59-9508a540-fe86c61e3c1d614637322c53",
 "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" : "ActiveFinancially Unable to Pay for Tuition",
 "description" : "StudentFinancially isUnable partto ofPay an active program.for Tuition"}

 

Create a Program Status Change Reason

POST /ssp/api/1/reference/programStatusChangeReason

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"name" : "ActiveFinancially Unable to Pay for Tuition",
 "description" : "StudentFinancially isUnable partto ofPay an active program.for Tuition"}

Returns

ProgramStatusChangeReason

Code Block
{"id" : "acf7d72123a93baa-196f3eb6-43534a59-9508a540-fe86c61e3c1d614637322c53",
 "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" : "ActiveFinancially Unable to Pay for Tuition",
 "description" : "StudentFinancially isUnable partto ofPay an active program.for Tuition"}

 

Save a Program Status Change Reason

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"id" : "acf7d72123a93baa-196f3eb6-43534a59-9508a540-fe86c61e3c1d614637322c53",
 "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" : "ActiveFinancially Unable to Pay for Tuition",
 "description" : "StudentFinancially isUnable partto ofPay an active program.for Tuition"}

Returns

ProgramStatusChangeReason

Code Block
{"id" : "acf7d72123a93baa-196f3eb6-43534a59-9508a540-fe86c61e3c1d614637322c53",
 "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" : "ActiveFinancially Unable to Pay for Tuition",
 "description" : "StudentFinancially isUnable partto ofPay an active program.for Tuition"}

 

Delete a Program Status Change Reason

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

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...