Page Comparison

...

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" :
     {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "name" : "EVERYONE"},
  "journalSource" :
     {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
      "name" : "Appointment"},
  "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",   "journalStepIdobjectStatus" : "23befc50-7f91-11e1-b0c4-0800200c9a66"ACTIVE"},
  "journalStepDetailsjournalTrack" :  
     [{"id" : "23befc501ec33887-7f917d5e-11e14770-b0c4aef2-0800200c9a66049a8314130e",

      "createdDatename" : "1332216000000Track",
       "createdByobjectStatus" : "ACTIVE"},
  "journalEntryDetails" :
      [{"idjournalStep" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
                "firstName{"id" : "John23befc50-7f91-11e1-b0c4-0800200c9a66",
           "lastNamename" : "DoeCAPSession"},
 
     "modifiedDateobjectStatus" : "1332216000000ACTIVE"},
       "modifiedByjournalStepDetails" :
           [{"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
            "firstNamename" : "JohnAction Plan Developed",
            "lastNameobjectStatus" : "DoeACTIVE"},
           {"objectStatusid" : "ACTIVE7ed6d720-7f91-11e1-b0c4-0800200c9a66",
            "name" : "ActionDiscussed Financial PlanAid DevelopedInformation",
            "descriptionobjectStatus" : "Action plan developed with student.""ACTIVE"},
           ...
          ]},
       {"sortOrderjournalStep" :
1},         {"id" : "7ed6d72023befc50-7f91-11e1-b0c4-0800200c9a66",
          "createdDatename" : "1332216000000Transition",
          "createdByobjectStatus" : "ACTIVE"},
       "journalStepDetails" :
         [{"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnDiscussed Financial Aid Information",
           "lastNameobjectStatus" : "DoeACTIVE"},
          {"modifiedDateid" : "13322160000002d28c719-a8a6-414f-b27e-f6479dfa6a51",
       "modifiedBy" :            {"id"name" : "91f46e39-cea8-422b-b215-00f6bcf5d280Follow-Up Appointment Made",
           "firstNameobjectStatus" : "JohnACTIVE"},
          ...
"lastName" : "Doe"},        "objectStatus" : "ACTIVE",]},
      ...
  "name" : "Discussed Financial]
Aid Information"},
 {"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66",
   "descriptioncreatedDate" : "Discussed financial aid information with student and determined any additional financial needs."
 2008-04-09T12:07:56",
  "createdBy" : 
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "sortOrderfirstName" : 2}"John",
      {"idlastName" : "3ac714c7-390d-4994-ac43-5de0a0ac9832"Doe"},
       "createdDatemodifiedDate" : "13322160000002008-04-09T12:07:56",
       "createdBymodifiedBy" : 
  
       {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    
      "firstName" : "John",
   
       "lastName" : "Doe"},
       "modifiedDateobjectStatus" : "1332216000000ACTIVE",
  "entryDate" : 1332216000000,
  "modifiedBycomment" : "",
  "confidentialityLevel" :
      {"id" : "91f46e39c57f11e1-cea87ef2-422b4989-b2159ac2-00f6bcf5d2807b0690563995",
  
        "firstNamename" : "JohnEVERYONE",} 
  "journalSource" :
      {"lastNameid" : "Doe"},
7ed6d720-7f91-11e1-b0c4-0800200c9a66",
      "objectStatusname" : "ACTIVEEmail",
       "nameobjectStatus" : "Follow-Up Appointment Made",
"ACTIVE"},
  "journalTrack" : 
     {"descriptionid" : "Follow-up appointment made with student."1ec33887-7d5e-4770-aef2-049a8314130e",
       "sortOrdername" : 3},
      ..."Track",
     ]
 },
 {"id"objectStatus" : "3c952070-7fe5-11e1-b0c4-0800200c9a66"ACTIVE"},
  "createdDatejournalEntryDetails" : "2008-04-09T12:07:56",
     [{"createdByjournalStep" :
          {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnCAPSession",
           "lastNameobjectStatus" : "DoeACTIVE"},
  "modifiedDate" : "2008-04-09T12:07:56",   "modifiedByjournalStepDetails" :
          [{"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
      "firstName" : "John",       "lastNamename" : "DoeAction Plan Developed"},
  "objectStatus" : "ACTIVE",   "entryDate" : 1332216000000,   "commentobjectStatus" : "ACTIVE"},
   "confidentialityLevel"  :      {"id" : "c57f11e17ed6d720-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
            "name" : "EVERYONE"}Discussed Financial Aid Information",
            "journalSourceIdobjectStatus" : "aabf0232-5994-4108-986e-cfb6f28724ae",
  "journalSource" :ACTIVE"},
           ...
          ]},
      {"journalStep" :
         {"id" : "7ed6d72023befc50-7f91-11e1-b0c4-0800200c9a66",
          "name" : "EmailTransition"},
  "journalTrackId"  : "1ec33887-7d5e-4770-aef2-049a8314130e",      "journalStepIdobjectStatus" : "23befc50-7f91-11e1-b0c4-0800200c9a66",ACTIVE"},
       "journalStepDetails" :
         [{"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "createdDatename" : "1332216000000Discussed Financial Aid Information",
           "createdByobjectStatus" : "ACTIVE"},
          {"id" : "91f46e392d28c719-cea8a8a6-422b414f-b215b27e-00f6bcf5d280f6479dfa6a51",
           "firstNamename" : "JohnFollow-Up Appointment Made",
           "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : "1332216000000",  ...
         "modifiedBy" :]},
      ...
     ]
 }]

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" : "91f46e39240e97c0-cea87fe5-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
 "createdDate" : 1332216000000,
 "createdBy" : 
    {"firstNameid" : "John91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
   "objectStatusmodifiedBy" : "ACTIVE",
       {"nameid" : "Action Plan Developed91f46e39-cea8-422b-b215-00f6bcf5d280",

      "descriptionfirstName" : "Action plan developed with student.John",
       "sortOrderlastName" : 1"Doe"},
 "objectStatus"     {"id: "ACTIVE",
 "entryDate" : 1332216000000,
 "comment" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
 "confidentialityLevel" :
    {"createdDateid" : "1332216000000c57f11e1-7ef2-4989-9ac2-7b0690563995",
       "createdByname" : "EVERYONE"},
     "journalSource" :
    {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
   
       "firstNamename" : "JohnAppointment",
    
      "lastNameobjectStatus" : "DoeACTIVE"},
 "journalTrack" : 
     {"modifiedDateid" : "13322160000001ec33887-7d5e-4770-aef2-049a8314130e",
       "modifiedByname" : "Track",
      "objectStatus" : "ACTIVE"},
 {"idjournalEntryDetails" :
  "91f46e39-cea8-422b-b215-00f6bcf5d280",
  [{"journalStep" :
          {"firstNameid" : "John23befc50-7f91-11e1-b0c4-0800200c9a66",
           "lastNamename" : "DoeCAPSession"},
          "objectStatus" : "ACTIVE"},

      "namejournalStepDetails" :
"Discussed Financial Aid Information",      [{"id" : "description" : "Discussed financial aid information with student and determined any additional financial needs."23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Action Plan Developed",
           "sortOrderobjectStatus" : 2"ACTIVE"},
          {"id" : "3ac714c77ed6d720-390d7f91-499411e1-ac43b0c4-5de0a0ac98320800200c9a66",
           "createdDatename" : "1332216000000",Discussed Financial Aid Information",
    "createdBy" :            {"id" "objectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE"},
           "firstName" : "John",...
         ]},
     {"lastNamejournalStep" :
"Doe"},        {"modifiedDateid" : "133221600000023befc50-7f91-11e1-b0c4-0800200c9a66",
         "modifiedByname" : "Transition",
          {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE"},
      "journalStepDetails" :
   "firstName"  : "John   [{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "lastNamename" : "Doe"},Discussed Financial Aid Information",
          "objectStatus" : "ACTIVE"},
         {"nameid" : "Follow-Up Appointment Made",2d28c719-a8a6-414f-b27e-f6479dfa6a51",
          "descriptionname" : "Follow-up appointment made with student."Up Appointment Made",
          "sortOrderobjectStatus" : 3"ACTIVE"},
         ...
     ]   }]

...

]},
     ...
    ]
}

Create Journal Entry for a Person

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

Returns

JournalEntry

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" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"},
 "journalSource" :
    {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
     "name" : "Appointment"},
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "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},
      {"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},
      ...
     ]
}

Create 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" : "",
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" : "EVERYONE"}  "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalSource" :
    {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
     "name" : "Appointment"},
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "journalStepDetails" : 
     [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"},
      {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"},
      {"id" : "3ac714c7-390d-4994-ac43-5de0a0ac9832"},
      ...
     ]
}

Returns

JournalEntryTO

...

Security

PERSON_JOURNAL_ENTRY_WRITE

Sample Post

JournalEntryTO

Code Block

{"createdDate" : 1332216000000,
 "createdBy" : 
    {"id" : "23befc5091f46e39-7f91cea8-11e1422b-b0c4b215-0800200c9a6600f6bcf5d280",
     "namefirstName" : "AppointmentJohn"},
     "journalTrackIdlastName" : "1ec33887-7d5e-4770-aef2-049a8314130e"Doe"},
 "journalStepIdmodifiedDate" : 1332216000000,
 "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "journalStepDetailsmodifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     [{"idfirstName" : "23befc50-7f91-11e1-b0c4-0800200c9a66John",
 
     "createdDatelastName" : "1332216000000Doe"},
 "objectStatus" : "ACTIVE",
   "createdByentryDate" : 1332216000000,
 "comment" : "",
 "confidentialityLevel" :
    {"id" : "91f46e39c57f11e1-cea87ef2-422b4989-b2159ac2-00f6bcf5d2807b0690563995",
     "name" : "EVERYONE"}
   "firstNamejournalSource" :
    {"Johnid",      : "23befc50-7f91-11e1-b0c4-0800200c9a66",
     "lastNamename" : "DoeAppointment"},

      "modifiedDateobjectStatus" : "1332216000000ACTIVE"},
       "modifiedBy"journalTrack" : 
 
        {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",
           "firstNamename" : "JohnTrack",
           "lastName"objectStatus" : "DoeACTIVE"},
 "journalEntryDetails" :
    [{"objectStatusjournalStep" :
 "ACTIVE",        {"nameid" : "Action Plan Developed",23befc50-7f91-11e1-b0c4-0800200c9a66",
          "descriptionobjectStatus" : "Action plan developed with student."ACTIVE"},
       "sortOrderjournalStepDetails" :
1},         [{"id" : "7ed6d72023befc50-7f91-11e1-b0c4-0800200c9a66",
     
 "createdDate" : "1332216000000",        "createdByobjectStatus" : "ACTIVE"},
          {"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNameobjectStatus" : "JohnACTIVE"},
          ...
"lastName" : "Doe"},        "modifiedDate" : "1332216000000",
]},
      {"modifiedByjournalStep" : 
 
        {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNameobjectStatus" : "JohnACTIVE"},
      "journalStepDetails" :
    "lastName    [{"id" : "Doe"},7ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "objectStatus" : "ACTIVE"},
         {"nameid" : "Discussed Financial Aid Information","2d28c719-a8a6-414f-b27e-f6479dfa6a51",
          "descriptionobjectStatus" : "ACTIVE"Discussed},
financial aid information with student and determined any additional financial needs..."
       "sortOrder" : 2 ]},
     ...
    ]
}

Returns

JournalEntryTO

Code Block

{"id" : "3ac714c7240e97c0-390d7fe5-499411e1-ac43b0c4-5de0a0ac98320800200c9a66",
       "createdDate" : "1332216000000",
       "createdBy" : 
    
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     
     "firstName" : "John",
   
       "lastName" : "Doe"},
     
 "modifiedDate" : "1332216000000",
      1332216000000,
 "modifiedBy" : 
    
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 
         "firstName" : "John",
 
         "lastName" : "Doe"},
       "objectStatus" : "ACTIVE",

      "nameentryDate" : "Follow-Up Appointment Made"1332216000000,
       "description"comment" : "Follow-up appointment made with student."
     ",
 "sortOrderconfidentialityLevel" : 3},
      ...
 
   ] }

Save Journal Entry for a Person

...

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,
         {"commentid" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
    "confidentialityLevel" :     {"idname" : "c57f11e1-7ef2-4989-9ac2-7b0690563995CAPSession",
          "nameobjectStatus" : "EVERYONE"}"ACTIVE"},
      "journalSourceIdjournalStepDetails" : "aabf0232-5994-4108-986e-cfb6f28724ae",
   "journalSource" :     [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "AppointmentAction Plan Developed"},
   "journalTrackId        "objectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepIdACTIVE"},
          {"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",
 "journalStepDetails"   :       [{"idname" : "23befc50-7f91-11e1-b0c4-0800200c9a66Discussed 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" : "ActionFollow-Up PlanAppointment DevelopedMade",
          "descriptionobjectStatus" : "Action plan developed with student.","ACTIVE"},
         ...
       "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",
           "lastName" : "Doe"},

      "objectStatus" : "ACTIVE",
 "entryDate" : 1332216000000,
   "namecomment" : "Discussed Financial Aid Information",
 "confidentialityLevel" :
    {"descriptionid" : "Discussed financial aid information with student and determined any additional financial needs."
 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" : "John",
           "lastName" : "Doe"},
 Track",
     "modifiedDateobjectStatus" : "1332216000000ACTIVE"},
 "journalEntryDetails" :
    [{"modifiedByjournalStep" : 

         {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",

          "firstNamename" : "JohnCAPSession",
           "lastNameobjectStatus" : "Doe"ACTIVE},

      "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"},
  
   ...      ] }

Returns

JournalEntryTO

Code Block

{"id" : "240e97c07ed6d720-7fe57f91-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,  "createdBy" :      {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280",Discussed Financial Aid Information",
           "firstNameobjectStatus" : "JohnACTIVE"},
          ...
   "lastName" : "Doe"      ]},
 "modifiedDate" : 1332216000000,  {"modifiedByjournalStep" :
        {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
         "firstNamename" : "JohnTransition",
     "lastName" : "Doe"},  "objectStatus" : "ACTIVE"},
  "entryDate" : 1332216000000,  "commentjournalStepDetails" :
"",  "confidentialityLevel" :     [{"id" : "c57f11e17ed6d720-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
          "name" : "EVERYONE"}Discussed Financial Aid Information",
          "journalSourceIdobjectStatus" : "aabf0232-5994-4108-986e-cfb6f28724ae"ACTIVE"},
 "journalSource"   :     {"id" : "23befc502d28c719-7f91a8a6-11e1414f-b0c4b27e-0800200c9a66f6479dfa6a51",
          "name" : "Follow-Up Appointment Made"},
 "journalTrackId         "objectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "journalStepDetails" : ACTIVE"},
         ...
        ]},
     ...
     []
}

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",
     "firstNamelastName" : "JohnDoe"},
 "objectStatus" : "ACTIVE",
 "entryDate" :  1332216000000,
  "lastNamecomment" : "Doe"},
 "confidentialityLevel" :
    {"objectStatusid" : "ACTIVEc57f11e1-7ef2-4989-9ac2-7b0690563995",
       "name" : "ActionEVERYONE"}
Plan Developed"journalSource", :
    {"id" : "description" : "Action plan developed with student.",
 23befc50-7f91-11e1-b0c4-0800200c9a66",
     "name" : "Appointment",
     "sortOrderobjectStatus" : 1"ACTIVE"},
 "journalTrack" :
     {"id" : "7ed6d7201ec33887-7f917d5e-11e14770-b0c4aef2-0800200c9a66049a8314130e",
       "createdDatename" : "1332216000000Track",
 
     "createdByobjectStatus" : "ACTIVE"},
 "journalEntryDetails" :
       [{"idjournalStep" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
           {"firstNameid" : "John23befc50-7f91-11e1-b0c4-0800200c9a66",

          "lastNamename" : "DoeCAPSession"},
          "modifiedDateobjectStatus" : "1332216000000ACTIVE"},

      "modifiedByjournalStepDetails" :
           [{"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnAction Plan Developed",
           "lastNameobjectStatus" : "DoeACTIVE"},
          {"objectStatusid" : "ACTIVE7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Discussed Financial Aid Information",
       "description" : "Discussed financial aid information with student and
determined any additional financial needs."        "sortOrderobjectStatus" : 2"ACTIVE"},
      {"id" : "3ac714c7-390d-4994-ac43-5de0a0ac9832",  ...
     "createdDate" : "1332216000000",  ]},
     {"createdByjournalStep" :
           {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnTransition",

          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDate" : "1332216000000",
       "modifiedBy" : 
 "journalStepDetails" :
        [{"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 7

New Version Current

Key

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