Page Comparison

Get All Journal Entries for Person

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

Security

PERSON_JOURNAL_ENTRY_READ

Notes

entryDate may be different than the createDate if an entry is back-dated.

...

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

...

Code Block

[{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66",
  "createdDate" : 1332216000000,
  "createdBy" : 
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstName" : "John",
      "lastName" : "Doe"},
  "modifiedDate" : 1332216000000,
  "modifiedBy" : 
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstName" : "John",
      "lastName" : "Doe"},
  "objectStatus" : "ACTIVE",
  "entryDate" : 1332216000000,
  "comment" : "",
  "confidentialityLevel" :
     {"confidentialityLevelIdid" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",   "journalTrackIdname" : "1ec33887-7d5e-4770-aef2-049a8314130e"EVERYONE"},
  "journalStepDetailsjournalSource" : 
     [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
       "createdDatename" : "1332216000000Appointment",
       "createdByobjectStatus" : "ACTIVE"},
  "journalTrack" : 
      {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",

          "firstNamename" : "JohnTrack",
  
        "lastNameobjectStatus" : "DoeACTIVE"},
   
   "modifiedDatejournalEntryDetails" : "1332216000000",
       [{"modifiedByjournalStep" :
           {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnCAPSession",
   
       "lastNameobjectStatus" : "DoeACTIVE"},
       "objectStatusjournalStepDetails" :
  "ACTIVE",        [{"nameid" : "Action Plan Developed23befc50-7f91-11e1-b0c4-0800200c9a66",
            "descriptionname" : "Action plan developed with student.", Plan Developed",
            "sortOrderobjectStatus" : 1"ACTIVE"},
           {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
       "createdDate" : "1332216000000",   "name" : "Discussed Financial Aid Information"createdBy",
:            {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE"},
           "firstName" : "John",...
          ]},
   "lastName" : "Doe"},
       "modifiedDate {"journalStep" :
"1332216000000",         {"modifiedByid" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280Transition",
           "firstNameobjectStatus" : "JohnACTIVE"},
 
         "lastNamejournalStepDetails" :
"Doe"},         [{"objectStatusid" : "ACTIVE7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Discussed Financial Aid Information",
           "descriptionobjectStatus" : "DiscussedACTIVE"},
financial aid information with student and determined any additional financial needs.{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
     "sortOrder" : 2},
      {"idname" : "3ac714c7-390d-4994-ac43-5de0a0ac9832Follow-Up Appointment Made",
           "createdDateobjectStatus" : "1332216000000ACTIVE"},
       "createdBy" :  ...
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",]},
      ...
     "firstName"]
: "John"},
           "lastName{"id" : "Doe"},
   3c952070-7fe5-11e1-b0c4-0800200c9a66",
   "modifiedDatecreatedDate" : "13322160000002008-04-09T12:07:56",

      "modifiedBycreatedBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 
         "firstName" : "John",
      "lastName" : "Doe"},
  "lastNamemodifiedDate" : "Doe"},
2008-04-09T12:07:56",
  "modifiedBy" : 
     {"objectStatusid" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
       "namefirstName" : "Follow-Up Appointment MadeJohn",
       "descriptionlastName" : "Follow-up appointment made with student."
    "Doe"},
  "objectStatus" : "ACTIVE",
  "entryDate" : 1332216000000,
  "sortOrdercomment" : 3}"",
      ...
   "confidentialityLevel" :
 ]  },  {"id" : "3c952070c57f11e1-7fe57ef2-11e14989-b0c49ac2-0800200c9a667b0690563995",
      "createdDatename" : "2008-04-09T12:07:56",EVERYONE"} 
  "createdByjournalSource" :
      {"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
      "firstNamename" : "JohnEmail",
      "lastNameobjectStatus" : "DoeACTIVE"},
  "modifiedDatejournalTrack" : "2008-04-09T12:07:56",
  "modifiedBy" :       {{"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",
      "firstNamename" : "JohnTrack",
      "lastNameobjectStatus" : "DoeACTIVE"},
  "objectStatusjournalEntryDetails" :
"ACTIVE",     [{"entryDatejournalStep" :
1332216000000,     "comment" : "",   {"confidentialityLevelIdid" : "c57f11e123befc50-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
  "journalSourceId         "name" : "aabf0232-5994-4108-986e-cfb6f28724aeCAPSession",
   "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
         "objectStatus" : "ACTIVE"},
       "journalStepDetails" :
          [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
            "createdDatename" : "1332216000000Action Plan Developed",
            "createdByobjectStatus" : "ACTIVE"},
           {"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
            "firstNamename" : "JohnDiscussed Financial Aid Information",
            "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : "1332216000000"    ...
          ]},
       {"modifiedByjournalStep" :
           {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnTransition",
           "lastNameobjectStatus" : "DoeACTIVE"},
       "objectStatusjournalStepDetails" :
"ACTIVE",         [{"nameid" : "Action Plan Developed",7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "descriptionname" : "ActionDiscussed planFinancial developed with student.Aid Information",
           "sortOrderobjectStatus" : 1"ACTIVE"},
          {"id" : "7ed6d7202d28c719-7f91a8a6-11e1414f-b0c4b27e-0800200c9a66f6479dfa6a51",
           "createdDatename" : "1332216000000",
       "createdBy" :Follow-Up Appointment Made",
            {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE"},
          ...
"firstName" : "John",       ]},
    "lastName" : "Doe"}, ...
     ]
 "modifiedDate}]

Get One Journal Entry for a Person

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

Security

PERSON_JOURNAL_ENTRY_READ

Returns

JournalEntry

Code Block

{"id" : "1332216000000240e97c0-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,
   "modifiedBycreatedBy" : 
    
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "firstNamelastName" : "JohnDoe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"lastNameid" : "Doe"},
 91f46e39-cea8-422b-b215-00f6bcf5d280",
     "objectStatusfirstName" : "ACTIVEJohn",
     "lastName" : "nameDoe"},
: "DiscussedobjectStatus" Financial Aid Information: "ACTIVE",
 "entryDate" : 1332216000000,
   "descriptioncomment" : "Discussed",
financial aid"confidentialityLevel" information:
with student and determined any additional financial needs."{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
       "sortOrdername" : 2"EVERYONE"},
 "journalSource" :
    {"id" : "3ac714c723befc50-390d7f91-499411e1-ac43b0c4-5de0a0ac98320800200c9a66",
       "createdDatename" : "1332216000000Appointment",
       "createdByobjectStatus" : "ACTIVE"},
 "journalTrack" : 
      {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",
           "firstNamename" : "JohnTrack",
      "objectStatus"     "lastName" : "Doe: "ACTIVE"},
   
   "modifiedDatejournalEntryDetails" : "1332216000000",
       "modifiedBy[{"journalStep" : 

         {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnCAPSession",
           "lastNameobjectStatus" : "DoeACTIVE"},
       "objectStatusjournalStepDetails" :
"ACTIVE",         [{"nameid" : "Follow-Up Appointment Made",23befc50-7f91-11e1-b0c4-0800200c9a66",
           "descriptionname" : "Follow-up appointment made with student."Action Plan Developed",
           "sortOrderobjectStatus" : 3"ACTIVE"},
  
   ...      ]  }]

Get One Journal Entry for a Person

...

Returns

JournalEntry

Code Block

{"id" : "240e97c07ed6d720-7fe57f91-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,  "createdBy" :      {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280Discussed Financial Aid Information",
     "firstName      "objectStatus" : "JohnACTIVE"},
          ...
   "lastName" : "Doe"      ]},
 "modifiedDate" : 1332216000000,  {"modifiedByjournalStep" :
        {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
         "firstNamename" : "JohnTransition",
         "lastNameobjectStatus" : "DoeACTIVE"},
  "objectStatus" : "ACTIVE",  "entryDatejournalStepDetails" :
  1332216000000,  "comment" : "",  [{"confidentialityLevelIdid" : "c57f11e17ed6d720-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
 "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",         "journalTrackIdname" : "1ec33887-7d5e-4770-aef2-049a8314130eDiscussed Financial Aid Information",
 "journalStepDetails"  :       [{"idobjectStatus" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
       "createdDate" : "1332216000000",
       "createdBy" :ACTIVE"},
             {"id" : "91f46e392d28c719-cea8a8a6-422b414f-b215b27e-00f6bcf5d280f6479dfa6a51",
           "firstNamename" : "JohnFollow-Up Appointment Made",
           "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : "1332216000000", ...
       "modifiedBy" : ]},
     ...
    ]
}

Create Journal Entry for a Person

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

Security

PERSON_JOURNAL_ENTRY_WRITE

Sample Post

JournalEntryTO

Code Block

{"createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"objectStatusid" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
 
     "namefirstName" : "Action Plan DevelopedJohn",

      "descriptionlastName" : "ActionDoe"},
plan developed"objectStatus" with: student."ACTIVE",
 "entryDate" : 1332216000000,
   "sortOrdercomment" : 1}"",
 "confidentialityLevel" :
    {"id" : "7ed6d720c57f11e1-7f917ef2-11e14989-b0c49ac2-0800200c9a667b0690563995",

      "createdDatename" : "1332216000000EVERYONE",
}
      "createdByjournalSource" : 
  
       {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
     "name" : "Appointment",
     "firstNameobjectStatus" : "JohnACTIVE"},
 "journalTrack" :
        {"lastNameid" : "Doe"}1ec33887-7d5e-4770-aef2-049a8314130e",
       "modifiedDatename" : "1332216000000Track",

      "modifiedByobjectStatus" : "ACTIVE"},
 "journalEntryDetails" :
       [{"journalStep" :
         {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",

          "firstNameobjectStatus" : "JohnACTIVE"},
      "journalStepDetails" :
         [{"lastNameid" : "Doe"},23befc50-7f91-11e1-b0c4-0800200c9a66",
           "objectStatus" : "ACTIVE"},
          {"nameid" : "Discussed Financial Aid Information",7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "descriptionobjectStatus" : "DiscussedACTIVE"},
financial aid information with student and determined any additional financial needs."...
         ]},
     {"sortOrderjournalStep" :
 2},       {"id" : "3ac714c723befc50-390d7f91-499411e1-ac43b0c4-5de0a0ac98320800200c9a66",
         "createdDateobjectStatus" : "1332216000000ACTIVE"},

      "createdByjournalStepDetails" :
           [{"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNameobjectStatus" : "JohnACTIVE"},
           {"lastNameid" : "Doe"},2d28c719-a8a6-414f-b27e-f6479dfa6a51",
          "modifiedDateobjectStatus" : "1332216000000ACTIVE"},
         ...
      "modifiedBy" :  ]},
     ...
    ]
}

Returns

JournalEntryTO

Code Block

{"id" : "91f46e39240e97c0-cea87fe5-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"firstNameid" : "John91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"objectStatusid" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",

      "namefirstName" : "Follow-Up Appointment MadeJohn",
 
     "descriptionlastName" : "Follow-up appointment made with student."
       "sortOrderDoe"},
 "objectStatus" : "ACTIVE",
 "entryDate" : 1332216000000,
 "comment" : 3}"",
 "confidentialityLevel" :
   ...
     ]
}

Create Journal Entry for a Person

PUT /ssp/api/1/person/{id}/journalEntry

Sample Post

JournalEntryTO

Code Block

{ {"id" : "240e97c0c57f11e1-7fe57ef2-11e14989-b0c49ac2-0800200c9a667b0690563995",
     "createdDatename" : 1332216000000,"EVERYONE"}
 "createdByjournalSource" : 
    {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
     "firstNamename" : "JohnAppointment",
     "lastNameobjectStatus" : "DoeACTIVE"},
 "modifiedDate" : 1332216000000,
 "modifiedByjournalTrack" :
     {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",
      "firstNamename" : "JohnTrack",
     "lastNameobjectStatus" : "DoeACTIVE"},
 "objectStatusjournalEntryDetails" :
  "ACTIVE",  [{"entryDatejournalStep" :
1332216000000,     "comment" : "",  {"confidentialityLevelIdid" : "c57f11e123befc50-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
  "journalSourceId        "name" : "aabf0232-5994-4108-986e-cfb6f28724ae","CAPSession",
          "journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e",ACTIVE"},
      "journalStepDetails" :
         [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"},
      {"id     "name" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"}Action Plan Developed",
      {"id     "objectStatus" : "3ac714c7-390d-4994-ac43-5de0a0ac9832ACTIVE"},
      ...    {"id"  ]
}

Returns

JournalEntryTO

Code Block

{"id" : "240e97c0-7fe5: "7ed6d720-7f91-11e1-b0c4-0800200c9a66",

"createdDate" : 1332216000000,  "createdBy" :      {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280Discussed Financial Aid Information",
     "firstName" : "John",      "lastNameobjectStatus" : "DoeACTIVE"},
 "modifiedDate"  : 1332216000000,  "modifiedBy" :   ...
  {"id"  : "91f46e39-cea8-422b-b215-00f6bcf5d280",     ]},
     {"journalStep" :
        {"firstNameid" : "John23befc50-7f91-11e1-b0c4-0800200c9a66",
         "lastNamename" : "DoeTransition"},
         "objectStatus" : "ACTIVE"},
      "entryDatejournalStepDetails" :
  1332216000000,  "comment" : "",  [{"confidentialityLevelIdid" : "c57f11e17ed6d720-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
          "journalSourceIdname" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalTrackIdDiscussed Financial Aid Information",
          "objectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e"ACTIVE"},
 "journalStepDetails" :       [{"id" : "23befc502d28c719-7f91a8a6-11e1414f-b0c4b27e-0800200c9a66f6479dfa6a51",
          "createdDatename" : "1332216000000Follow-Up Appointment Made",
       "createdBy" :            {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "modifiedDate" : "1332216000000",
       "modifiedBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "objectStatus" : "ACTIVE",
       "name" : "Action Plan Developed",
       "description" : "Action plan developed with student.",
       "sortOrder" : 1},
      {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
       "createdDate" : "1332216000000",
       "createdBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "modifiedDate" : "1332216000000",
       "modifiedBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "objectStatus" : "ACTIVE",
       "name" : "Discussed Financial Aid Information",
       "description" : "Discussed financial aid information with student and determined any additional financial needs."
       "sortOrder" : 2},
      {"id" : "3ac714c7-390d-4994-ac43-5de0a0ac9832",
       "createdDate" : "1332216000000",
       "createdBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "modifiedDate" : "1332216000000",
       "modifiedBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "objectStatus" : "ACTIVE",
       "name" : "Follow-Up Appointment Made",
       "description" : "Follow-up appointment made with student."
       "sortOrder" : 3},
      ...
     ]
}

Save Journal Entry for a Person

PUT /ssp/api/1/person/{id}/journalEntry

Sample Post

JournalEntryTO

Code Block

{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},
 "objectStatus" : "ACTIVE",
 "entryDate" : 1332216000000,
 "comment" : "",
 "confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepDetails" : 
     [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
       "createdDate" : "1332216000000",
       "createdBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "modifiedDate" : "1332216000000",
       "modifiedBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
       "objectStatus" : "ACTIVE"},
       "name" : "Action Plan Developed", ...
        "description" : "Action plan developed with student.",]},
     ...
       "sortOrder" : 1},
      ]
}

Save Journal Entry for a Person

PUT /ssp/api/1/person/{id}/journalEntry

Security

PERSON_JOURNAL_ENTRY_WRITE

Sample Post

JournalEntryTO

Code Block

{"id" : "7ed6d720240e97c0-7f917fe5-11e1-b0c4-0800200c9a66",
     
 "createdDate" : "1332216000000",
     
 "createdBy" : 
   
      {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     
     "firstName" : "John",
  
        "lastName" : "Doe"},
       "modifiedDate" : "1332216000000",
       "modifiedBy" : 
    
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "firstNamelastName" : "JohnDoe"},
 "objectStatus" : "ACTIVE",
  "entryDate" :  1332216000000,
 "lastNamecomment" : "Doe"},
 "confidentialityLevel" :
    {"objectStatusid" : "ACTIVEc57f11e1-7ef2-4989-9ac2-7b0690563995",

      "name" : "DiscussedEVERYONE"}
Financial Aid Information"journalSource", :
      {"descriptionid" : "Discussed financial aid information with student and determined any additional financial needs."
       "sortOrder" : 2},23befc50-7f91-11e1-b0c4-0800200c9a66",
     "name" : "Appointment",
     "objectStatus" : "ACTIVE"},
 "journalTrack" :
      {"id" : "3ac714c71ec33887-390d7d5e-49944770-ac43aef2-5de0a0ac9832049a8314130e",
       "createdDatename" : "1332216000000Track",
     "objectStatus" : "ACTIVE"},
 "createdByjournalEntryDetails" :
    [{"journalStep" :
         {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215-00f6bcf5d280b0c4-0800200c9a66",
          "name" : "CAPSession",
          "objectStatus" : "ACTIVE},
      "firstNamejournalStepDetails" : "John",
           [{"lastNameid" : "Doe"},23befc50-7f91-11e1-b0c4-0800200c9a66",
           "modifiedDatename" : "1332216000000",Action Plan Developed"
           "modifiedByobjectStatus" : "ACTIVE"},
          {"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnDiscussed Financial Aid Information",
           "lastNameobjectStatus" : "Doe"},
 ACTIVE"},
          ...
     "objectStatus" : "ACTIVE",  ]},
     {"namejournalStep" : "Follow-Up
Appointment Made",        {"descriptionid" : "Follow-up appointment made with student."23befc50-7f91-11e1-b0c4-0800200c9a66",
           "sortOrdername" : 3}"Transition",
      ...      ]
}

Returns

JournalEntryTO

Code Block

{"id"objectStatus" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,ACTIVE"},
      "createdByjournalStepDetails" :
        [{"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
          "firstNamename" : "JohnDiscussed Financial Aid Information",
          "lastNameobjectStatus" : "DoeACTIVE"},
 "modifiedDate"
: 1332216000000,  "modifiedBy" :      {"id" : "91f46e392d28c719-cea8a8a6-422b414f-b215b27e-00f6bcf5d280f6479dfa6a51",
     "firstName" : "John     "name" : "Follow-Up Appointment Made",
     "lastName"  : "Doe"},  "objectStatus" : "ACTIVE"},
 "entryDate"  : 1332216000000,  "comment" : "", ...
"confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",  "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepDetails" :   ]},
     ...
     []
}

Returns

JournalEntryTO

Code Block

{"id" : "23befc50240e97c0-7f917fe5-11e1-b0c4-0800200c9a66",
    
  "createdDate" : "1332216000000",
       "createdBy" : 
    
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
           "lastName" : "Doe"},
     
 "modifiedDate" : "1332216000000",

      "modifiedBy" : 
          {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           "firstName" : "John",
      : "John",
     "lastName" : "Doe"},
     
 "objectStatus" : "ACTIVE",
 "entryDate" : 1332216000000,
   "namecomment" : "Action Plan Developed",
 "confidentialityLevel" :
    {"descriptionid" : "Action plan developed with student.c57f11e1-7ef2-4989-9ac2-7b0690563995",
       "sortOrdername" : 1"EVERYONE"},
 "journalSource" :
    {"id" : "7ed6d72023befc50-7f91-11e1-b0c4-0800200c9a66",
 
     "createdDatename" : "1332216000000Appointment",
       "createdByobjectStatus" : "ACTIVE"},
  "journalTrack" :
      {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",
  
        "firstNamename" : "JohnTrack",
    
      "lastNameobjectStatus" : "DoeACTIVE"},
     
 "modifiedDatejournalEntryDetails" :
"1332216000000",        "modifiedBy[{"journalStep" :
           {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnCAPSession",

          "lastNameobjectStatus" : "DoeACTIVE"},,
      "journalStepDetails" :
         [{"objectStatusid" : "ACTIVE23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "DiscussedAction FinancialPlan Aid InformationDeveloped",
           "descriptionobjectStatus" : "ACTIVE"Discussed},
financial aid information with student and determined any additional financial needs.{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
     "sortOrder" : 2},       {"idname" : "3ac714c7-390d-4994-ac43-5de0a0ac9832",Discussed Financial Aid Information",
           "createdDateobjectStatus" : "1332216000000ACTIVE"},
          ...
  "createdBy" :      ]},
     {"idjournalStep" :
"91f46e39-cea8-422b-b215-00f6bcf5d280",            "firstName{"id" : "John23befc50-7f91-11e1-b0c4-0800200c9a66",
           "lastNamename" : "DoeTransition"},
         "modifiedDateobjectStatus" : "1332216000000ACTIVE"},
       "modifiedByjournalStepDetails" :
           [{"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnDiscussed Financial Aid Information",
           "lastNameobjectStatus" : "DoeACTIVE"},
         {"objectStatusid" : "ACTIVE2d28c719-a8a6-414f-b27e-f6479dfa6a51",
          "name" : "Follow-Up Appointment Made",
          "descriptionobjectStatus" : "Follow-up appointment made with student."ACTIVE"},
         ...
       "sortOrder" : 3 ]},
      ...
     ]
}

Delete a Journal Entry from a Person

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

Security

PERSON_JOURNAL_ENTRY_DELETE

Returns

Code Block
{"success" : "true"}

...

Versions Compared

Old Version 1

New Version Current

Key

Get All Journal Entries for Person

Get One Journal Entry for a Person

Get One Journal Entry for a Person

Create Journal Entry for a Person

Create Journal Entry for a Person

Save Journal Entry for a Person

Save Journal Entry for a Person

Delete a Journal Entry from a Person