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"},
     "journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e"ACTIVE"},
  "journalEntryDetailjournalTrack" : 
     [{"journalStepid" :   "1ec33887-7d5e-4770-aef2-049a8314130e",
       {"idname" : "Track",

          "nameobjectStatus" : "ACTIVE"},
  "journalEntryDetails" :
     [{"journalStepDetailjournalStep" :
          {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "CAPSession"}},
      {"journalStepobjectStatus" : "ACTIVE"},
       "journalStepDetails" :
          [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
            "name" : "Action Plan Developed"},
            "journalStepDetailobjectStatus" : "ACTIVE"},
           {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
            "name" : ""}}Discussed Financial Aid Information",
   ...      ]     "objectStatus" : "journalStepDetailsACTIVE"},
 :       [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",  ...
        "createdDate" : "1332216000000"]},
       {"createdByjournalStep" :
           {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnTransition",

          "lastNameobjectStatus" : "DoeACTIVE"},
       "modifiedDatejournalStepDetails" :
"1332216000000",        "modifiedBy" : 
           [{"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,...
       "journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66" ]},
       {"id" : "7ed6d720-7f91...
     ]
 },
 {"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66",
       "createdDate" : "13322160000002008-04-09T12:07:56",
 
     "createdBy" : 
    
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    
      "firstName" : "John",
   
       "lastName" : "Doe"},
       "modifiedDate" : "13322160000002008-04-09T12:07:56",

      "modifiedBy" : 
   
      {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 
         "firstName" : "John",
      "lastName"     "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",
      "name" : "EVERYONE"} 
   "sortOrderjournalSource" : 2},

     {"id" : "3ac714c77ed6d720-390d7f91-499411e1-ac43b0c4-5de0a0ac98320800200c9a66",
       "createdDatename" : "1332216000000Email",
 
     "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"},
       "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"},
 
    ...      ]  },
 {"id" : "3c9520707ed6d720-7fe57f91-11e1-b0c4-0800200c9a66",
  "createdDate" : "2008-04-09T12:07:56",   "createdBy" :    "name" :  {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280""Discussed Financial Aid Information",
      "firstName      "objectStatus" : "JohnACTIVE"},
           ...
       "lastName"  : "Doe"]},
  "modifiedDate"   : "2008-04-09T12:07:56",
  "modifiedBy" :{"journalStep" :
         {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
      "firstName    "name" : "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" : "7ed6d7202d28c719-7f91a8a6-11e1414f-b0c4b27e-0800200c9a66f6479dfa6a51",
      "name" : "Email"},   "journalTrackIdname" : "1ec33887-7d5e-4770-aef2-049a8314130e",
  "journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
  "journalStepDetails" :Follow-Up Appointment Made",
           [{"idobjectStatus" : "23befc50-7f91-11e1-b0c4-0800200c9a66"ACTIVE"},
       "createdDate" : "1332216000000",
 ...
      "createdBy" :  ]},
      ...
     ]
 }]

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" : "John",
 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" : "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"},
 "journalEntryDetails" :
    [{"modifiedDatejournalStep" :
 "1332216000000",        {"modifiedByid" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280CAPSession",
           "firstNameobjectStatus" : "JohnACTIVE"},
    
      "lastNamejournalStepDetails" :
 "Doe"},        [{"objectStatusid" : "ACTIVE23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "DiscussedAction FinancialPlan Aid InformationDeveloped",
           "descriptionobjectStatus" : "DiscussedACTIVE"},
financial aid information with student and determined any additional financial needs."
       "sortOrder" : 2},
      {"id" : "3ac714c77ed6d720-390d7f91-499411e1-ac43b0c4-5de0a0ac98320800200c9a66",
           "createdDatename" : "1332216000000",Discussed Financial Aid      "createdBy" :Information",
           {"idobjectStatus" : "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" :
        [{"firstNameid" : "John7ed6d720-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

Security

PERSON_JOURNAL_ENTRY_WRITE

Sample Post

JournalEntryTO

Code Block

{"idcreatedDate" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,
 "createdBy" : 
    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

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",
 -cea8-422b-b215-00f6bcf5d280",
     "createdDatefirstName" : "1332216000000John",
     "lastName" : "createdByDoe"},
: "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    
      "firstName" : "John",
     
     "lastName" : "Doe"},
     
 "modifiedDateobjectStatus" : "1332216000000ACTIVE",
       "modifiedBy"entryDate" : 1332216000000,
          {"id"comment" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     ",
 "confidentialityLevel" :
     {"firstNameid" : "Johnc57f11e1-7ef2-4989-9ac2-7b0690563995",
           "lastName"name" : "DoeEVERYONE"},
 "journalSource" :
    {"objectStatusid" : "ACTIVE23befc50-7f91-11e1-b0c4-0800200c9a66",
 
     "name" : "Action Plan DevelopedAppointment",
       "descriptionobjectStatus" : "ACTIVE"Action},
plan developed"journalTrack" with:
student.",     {"id" :  "sortOrder" : 1}"1ec33887-7d5e-4770-aef2-049a8314130e",
      {"idname" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66Track",
       "createdDateobjectStatus" : "1332216000000ACTIVE"},
 "journalEntryDetails" :
    [{"createdByjournalStep" : 
          {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNameobjectStatus" : "JohnACTIVE"},
  
        "lastNamejournalStepDetails" :
 "Doe"},        [{"modifiedDateid" : "133221600000023befc50-7f91-11e1-b0c4-0800200c9a66",
           "modifiedByobjectStatus" : "ACTIVE"},
          {"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNameobjectStatus" : "JohnACTIVE"},
          ...
"lastName" : "Doe"},        "objectStatus" : "ACTIVE"]},
       {"namejournalStep" : "Discussed Financial Aid
Information",        {"descriptionid" : "Discussed financial aid information with student and determined any additional financial needs."
23befc50-7f91-11e1-b0c4-0800200c9a66",
         "objectStatus" : "ACTIVE"},
      "sortOrderjournalStepDetails" :
 2},       [{"id" : "3ac714c77ed6d720-390d7f91-499411e1-ac43b0c4-5de0a0ac98320800200c9a66",
          "createdDateobjectStatus" : "1332216000000ACTIVE",
       "createdBy" :},
           {"id" : "91f46e392d28c719-cea8a8a6-422b414f-b215b27e-00f6bcf5d280f6479dfa6a51",

          "firstNameobjectStatus" : "JohnACTIVE"},
         ...
  "lastName" : "Doe"},      ]},
     ...
       "modifiedDate]
}

Returns

JournalEntryTO

Code Block

{"id" : "1332216000000240e97c0-7fe5-11e1-b0c4-0800200c9a66",
 "createdDate" : 1332216000000,
   "modifiedBycreatedBy" :  
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     
     "firstName" : "John",
           "lastName" : "Doe"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
    {"objectStatusid" : "ACTIVE91f46e39-cea8-422b-b215-00f6bcf5d280",
       "namefirstName" : "Follow-Up Appointment Made",John",
     "lastName" :  "Doe"},
 "descriptionobjectStatus" : "ACTIVE"Follow-up,
appointment made with student. "entryDate" : 1332216000000,
 "comment" : "",
 "sortOrderconfidentialityLevel" :
3},    {"id" :  ..."c57f11e1-7ef2-4989-9ac2-7b0690563995",
     "name" ]
}

Save Journal Entry for a Person

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

Sample Post

JournalEntryTO

Code Block

: "EVERYONE"}
 "journalSource" :
    {"id" : "240e97c023befc50-7fe57f91-11e1-b0c4-0800200c9a66",
     "name" : "Appointment",
     "createdDateobjectStatus" : 1332216000000"ACTIVE"},
 "createdByjournalTrack" :
     {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",
      "firstNamename" : "JohnTrack",
     "lastNameobjectStatus" : "DoeACTIVE"},
 "modifiedDatejournalEntryDetails" :
1332216000000,    [{"modifiedByjournalStep" :
         {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
          "firstNamename" : "JohnCAPSession",
     "lastName"  : "Doe"},  "objectStatus" : "ACTIVE"},
 "entryDate"  : 1332216000000,  "commentjournalStepDetails" :
 "",  "confidentialityLevel" :     [{"id" : "c57f11e123befc50-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
           "name" : "EVERYONE"}Action Plan Developed",
           "journalSourceIdobjectStatus" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalSource" :ACTIVE"},
          {"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",
     "name"   : "Appointment"},  "journalTrackIdname" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "journalStepDetails" :Discussed Financial Aid Information",
           [{"idobjectStatus" : "23befc50-7f91-11e1-b0c4-0800200c9a66",ACTIVE"},
          ...
  "createdDate" : "1332216000000",
        ]},
     {"createdByjournalStep" :
           {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
 
         "firstNamename" : "JohnTransition",
           "lastNameobjectStatus" : "DoeACTIVE"},
      "journalStepDetails" :
        [{"modifiedDateid" : "13322160000007ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "modifiedByname" : "Discussed Financial Aid Information",
          {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280"ACTIVE"},
           {"firstNameid" : "John2d28c719-a8a6-414f-b27e-f6479dfa6a51",
           "lastNamename" : "Doe"}Follow-Up Appointment Made",
          "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."
 23befc50-7f91-11e1-b0c4-0800200c9a66",
     "name" : "Appointment",
     "sortOrderobjectStatus" : 2"ACTIVE"},
 "journalTrack" :
     {"id" : "3ac714c71ec33887-390d7d5e-49944770-ac43aef2-5de0a0ac9832049a8314130e",
       "createdDatename" : "1332216000000Track",
 
     "createdByobjectStatus" : "ACTIVE"},
 "journalEntryDetails" :
       [{"idjournalStep" :
"91f46e39-cea8-422b-b215-00f6bcf5d280",         {"id"   "firstName" : "John",
: "23befc50-7f91-11e1-b0c4-0800200c9a66",
          "lastNamename" : "DoeCAPSession"},
          "modifiedDateobjectStatus" : "1332216000000"ACTIVE},
       "modifiedByjournalStepDetails" :
           [{"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnAction Plan Developed",
           "lastNameobjectStatus" : "DoeACTIVE"},
          {"objectStatusid" : "ACTIVE7ed6d720-7f91-11e1-b0c4-0800200c9a66",
       "name" : "Follow-Up Appointment Made"name",        "description" : "Follow-up appointment made with student.": "Discussed Financial Aid Information",
           "sortOrderobjectStatus" : 3"ACTIVE"},
          ...
     ]
}

Returns

JournalEntryTO

Code Block

{"id" : "240e97c0-7fe5-11e1-b0c4-0800200c9a66"    ]},
 "createdDate" : 1332216000000,  {"createdByjournalStep" :
        {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
         "firstNamename" : "JohnTransition",
         "lastNameobjectStatus" : "DoeACTIVE"},
  "modifiedDate" : 1332216000000,  "modifiedByjournalStepDetails" :
        [{"id" : "91f46e397ed6d720-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",

    "firstName" : "John",      "lastNamename" : "Doe"},Discussed Financial "objectStatus" : "ACTIVEAid Information",
 "entryDate" : 1332216000000,  "comment" : "",  "confidentialityLevel" :     {"idobjectStatus" : "c57f11e1-7ef2-4989-9ac2-7b0690563995"ACTIVE"},
     "name" : "EVERYONE"}  {"journalSourceIdid" : "aabf02322d28c719-5994a8a6-4108414f-986eb27e-cfb6f28724aef6479dfa6a51",
 "journalSource" :         {"idname" : "23befc50-7f91-11e1-b0c4-0800200c9a66",Follow-Up Appointment Made",
          "nameobjectStatus" : "AppointmentACTIVE"},
  "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "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",
     "firstNamelastName" : "JohnDoe"},
 "objectStatus" : "ACTIVE",
 "entryDate" : 1332216000000,
   "lastNamecomment" : "Doe"},
 "confidentialityLevel" :
    {"objectStatusid" : "ACTIVEc57f11e1-7ef2-4989-9ac2-7b0690563995",
 
     "name" : "EVERYONE"Action}
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",
     "objectStatus" : "ACTIVE"},
 "createdByjournalEntryDetails" :
    [{"journalStep" :
         {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
           "firstNamename" : "JohnCAPSession",
        
  "lastName" : "Doe"},        "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 8

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