Versions Compared

Key

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

...

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)

Note

The programStatusChangeReasonRequired tells the consumer that when a student's program status is changed to this status then a ProgramStatusChangeReason must be specified.

Returns

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "acf7d721-196f-4353-9508-fe86c61e3c1d",
      "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" : "Active",
      "description" : "Student is part of an active program."
      "programStatusChangeReasonRequired" : false},
     {"id" : "e8f6a45b-79ce-4687-831c-ca5f190dddc3",
      "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-participating",
      "description" : "The student has chosen to not participate in the advising services offered by the college.",
      "programStatusChangeReasonRequired" : true},
     ...
    ]
}

...