Versions Compared

Old Version 1

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Jason Elwood

Saved on

Key

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

...

Associates various program status records with a student.  Only one effective program status record can exist.  All others are expired.

Info

Updated in v2.6.0

Get All Program Statuses

GET /ssp/api/1/person/{id}/programStatus

Security

PERSON_PROGRAM_STATUS_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" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "createdDate" : "1332216000000",
      "description" : "International.",
      "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "modifiedDate" : "1332216000000",
      "objectStatus" : "ACTIVE",
      "namepersonId" : "Earn a 2.0 Fall Term"64a97729-7999-4b31-b70b-f0b705dff288",
       "confidentialityLevelprogramStatusId" :          {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "acf7d721-196f-4353-9508-fe86c61e3c1d",
        "nameeffectiveDate" : "EVERYONE"}1332216000000,
     },      {"createdById"expirationDate" : "91f46e39-cea8-422b-b215-00f6bcf5d280"null,
      "createdDateprogramStatusChangeReasonId" : "1332216000000"acf7d721-196f-4353-9508-fe86c61e3d80},
      "descriptionprogramStatusChangeReasonName" : "Graduate"Military Activated},
       {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "modifiedByIdcreatedBy" : "91f46e39-cea8-422b-b215-00f6bcf5d280", 
         {"modifiedDateid" : "133221600000091f46e39-cea8-422b-b215-00f6bcf5d280",
  
   "objectStatus" : "ACTIVE",       "namefirstName" : "GraduateJohn",
      "confidentialityLevel" :          {"id"lastName" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"Doe"},
          "namecreatedDate" : "EVERYONE"}
     }1332216000000,
     ... "modifiedBy" : 
 ] }

 

Get a Program Status

GET /ssp/api/1/person/{id}/programStatus/{id}

Returns

ProgramStatus

Code Block
{"createdBy" :      {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},
      "createdDatemodifiedDate" : "1332216000000",
 "description" : "Naturalized Citizen.",  "idobjectStatus" : "c57f11e1-7ef2-4989-9ac2-7b0690563995ACTIVE",
 "modifiedBy"
:      {"idprogramStatusId" : "91f46e39e8f6a45b-cea879ce-422b4687-b215831c-00f6bcf5d280ca5f190dddc3",
      "firstNameeffectiveDate" : "John"1332216000000,
      "lastNameexpirationDate" : "Doe"}1332216000000,
 "modifiedDate"  : "1332216000000",  "objectStatusprogramStatusChangeReasonId" : "ACTIVE",
 "name" : "Earn a 2.0 Fall Term",
 "confidentialityLevel23a93baa-3eb6-4a59-a540-614637322c53"},
      "programStatusChangeReasonName" : "Military Activated},
  {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 ...
    "name" : "EVERYONE"}
}]
}

 

...

Get a Program Status

POST GET /ssp/api/1/person/{id}/programStatus

Sample Post

Code Block
{"confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"},
 "name" : "Earn a 2.0 Fall Term",
 "description" : "Earn a 2.0 Fall Term"}

Returns

ProgramStatus/{id}

Security

PERSON_PROGRAM_STATUS_READ

Returns

PersonProgramStatus

Code Block
{"id" : "5a8ecb016201b18d-e5999d1d-45a248d3-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:5682d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
"description" : "Earn a 2.0 Fall Term",
 "modifiedDate" : "2008-04-09T12:07:56""createdDate" : 1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "objectStatus" : "ActiveACTIVE",
 "nameprogramStatusId" : "Earn a 2.0 Fall Term""acf7d721-196f-4353-9508-fe86c61e3c1d",
 "effectiveDate" : 1332216000000,
 "confidentialityLevelexpirationDate" : null,
   {"idprogramStatusChangeReasonId" : "c57f11e1acf7d721-7ef2196f-49894353-9ac29508-7b0690563995",
   fe86c61e3d80,
 "nameprogramStatusChangeReasonName" : "EVERYONE"}
}

 

Save a Program Status

...

Military Activated},}

Get Current Program Status

This method will return the only program status that is not marked expired, if there is one.

GET /ssp/api/1/person/{id}/programStatus/{id}Sample Postcurrent

Security

PERSON_PROGRAM_STATUS_READ

Returns

PersonProgramStatus

 

Code Block
{"id" : "5a8ecb016201b18d-e5999d1d-45a248d3-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:5682d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDatecreatedDate" : "2008-04-09T12:07:56"1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "descriptionmodifiedDate" : 1332216000000,
 "EarnobjectStatus" a 2.0 Fall Term: "ACTIVE",
 "personId":"64a97729-7999-4b31-b70b-f0b705dff288",
  "objectStatusprogramStatusId" : "Activeacf7d721-196f-4353-9508-fe86c61e3c1d",
 "nameeffectiveDate" : "Earn1332216000000,
a 2.0 Fall Term" "expirationDate" : null,
 "confidentialityLevelprogramStatusChangeReasonId" : acf7d721-196f-4353-9508-fe86c61e3d80,
 "programStatusChangeReasonName" : "Military {"idActivated},}

Create a Program Status

POST /ssp/api/1/person/{id}/programStatus

Security

PERSON_PROGRAM_STATUS_WRITE

Note

Any existing person program status record that is not expired will be expired (expirationDate = current datetime) when a new person program status is created.

Sample Post

Code Block
{"programStatusId" : "c57f11e1acf7d721-7ef2196f-49894353-9ac29508-7b0690563995fe86c61e3c1d",
 "effectiveDate" : 1332216000000,
 "nameexpirationDate" : "EVERYONE"}
null,
 "programStatusChangeReasonId" : acf7d721-196f-4353-9508-fe86c61e3d80,
 "programStatusChangeReasonName" : "Military Activated},}

Returns

ProgramStatusPersonProgramStatus

Code Block
{"id" : "5a8ecb016201b18d-e5999d1d-45a248d3-8d69-5e53aff3a4bc",
 "createdDate" : "2008-04-09T12:07:56"82d4-092e52ad676b",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "modifiedDatecreatedDate" : "2008-04-09T12:07:56"1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"}, 
 "descriptionmodifiedDate" : "Earn a 2.0 Fall Term"1332216000000,
 "objectStatus" : "ActiveACTIVE",
 "nameprogramStatusId" : "Earn a 2.0 Fall Term""acf7d721-196f-4353-9508-fe86c61e3c1d",
 "effectiveDate" : 1332216000000,
 "confidentialityLevelexpirationDate" : null,
   {"idprogramStatusChangeReasonId" : "c57f11e1acf7d721-7ef2196f-49894353-9ac29508-7b0690563995"fe86c61e3d80,

    "nameprogramStatusChangeReasonName" : "EVERYONE"}Military Activated}

 

Delete a Program Status

DELETE /ssp/api/1/person/{id}/programStatus/{id}

Security

PERSON_PROGRAM_STATUS_DELETE

Note

Set expirationDate equivalent to the current date.

Returns

Code Block
{"success" : "true"}

...