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",
     "objectStatus" : "ACTIVE"},
  "journalTrackId"journalTrack" : 
     {"id" : "1ec33887-7d5e-4770-aef2-049a8314130e",
      "name" : "Track",
     "objectStatus" : "ACTIVE"},
  "journalEntryDetails" :
     [{"journalStep" :
          {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "CAPSession"},
     "objectStatus" : "ACTIVE"},
       "journalStepDetails" :
          [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
            "name" : "Action Plan Developed",
            "objectStatus" : "ACTIVE"},
           {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
            "name" : "Discussed Financial Aid Information",
            "objectStatus" : "ACTIVE"},
           ...
          ]},
      {"journalStep" :
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          "name" : "Transition"},
          "journalStepDetailsobjectStatus" : "ACTIVE"},
        [{"idjournalStepDetails" :
         [{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Discussed Financial Aid Information",
           "objectStatus" : "ACTIVE"},
          {"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
           "name" : "Follow-Up Appointment Made",
           "objectStatus" : "ACTIVE"},
          ...
         ]},
      ...
     ]
 },
 {"id" : "3c952070-7fe5-11e1-b0c4-0800200c9a66",
  "createdDate" : "2008-04-09T12:07:56",
  "createdBy" : 
     {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
      "firstName" : "John",
      "lastName" : "Doe"},
  "modifiedDate" : "2008-04-09T12:07:56",
  "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" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
      "name" : "Email"},
     "journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e"ACTIVE"},
  "journalEntryDetailsjournalTrack" : 
     [{"journalStepid" :  "1ec33887-7d5e-4770-aef2-049a8314130e",
        {"idname" : "23befc50-7f91-11e1-b0c4-0800200c9a66Track",
    
      "nameobjectStatus" : "CAPSessionACTIVE"},
  "journalEntryDetails" :
     [{"journalStepDetailsjournalStep" :
          [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
            "name" : "ActionCAPSession",
 Plan Developed          "objectStatus" : "ACTIVE"},
       "journalStepDetails" :
          [{"id" : "7ed6d72023befc50-7f91-11e1-b0c4-0800200c9a66",
            "name" : "DiscussedAction FinancialPlan Aid InformationDeveloped"},
           ... "objectStatus"          ]},
   : "ACTIVE"},
  {"journalStep" :          {"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",
            "name" : "Transition"},Discussed Financial Aid Information",
            "journalStepDetailsobjectStatus" : "ACTIVE"},
          [{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", ...
          ]},
 "name" : "Discussed Financial Aid Information{"journalStep"}, :
         {"id" : "2d28c71923befc50-a8a67f91-414f11e1-b27eb0c4-f6479dfa6a510800200c9a66",
           "name" : "Follow-Up Appointment Made"}Transition",
          ...
 "objectStatus" : "ACTIVE"},
       ]},
 "journalStepDetails" :
    ...      ]
 }]

Get One Journal Entry for a Person

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

Returns

JournalEntry

Code Block

{[{"id" : "240e97c07ed6d720-7fe57f91-11e1-b0c4-0800200c9a66",
 "createdDate"  : 1332216000000,  "createdBy" :      {"idname" : "91f46e39-cea8-422b-b215-00f6bcf5d280Discussed Financial Aid Information",
    "firstName" : "John",     "lastNameobjectStatus" : "DoeACTIVE"},
 "modifiedDate" : 1332216000000,
 "modifiedBy" :      {"id" : "91f46e392d28c719-cea8a8a6-422b414f-b215b27e-00f6bcf5d280f6479dfa6a51",
     "firstName      "name" : "JohnFollow-Up Appointment Made",
     "lastName" : "Doe"},     "objectStatus" : "ACTIVE"},
 "entryDate" : 1332216000000,  "comment" : "",  "confidentialityLevel" : ...
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",   ]},
  "name" : "EVERYONE"},  "journalSource" :...
     {"id"]
: "23befc50-7f91-11e1-b0c4-0800200c9a66", }]

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" : "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",
     "objectStatus" : "ACTIVE"},
 "journalTrack" : 
     {"id" : "1ec33887-7d5e-4770-aef2-049a8314130e",
      "name" : "Track",
      "objectStatus" : "ACTIVE"},
 "journalEntryDetails" :
    [{"journalStep" :
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          "name" : "CAPSession",
          "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
         [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Action Plan Developed",
           "objectStatus" : "ACTIVE"},
          {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Discussed Financial Aid Information",
           "nameobjectStatus" : "AppointmentACTIVE"},
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "journalEntryDetails" :
          ...
         ]},
     [{"journalStep" :
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a660800200c9a66",
         "name" : "Transition",
          "nameobjectStatus" : "CAPSessionACTIVE"},
      "journalStepDetails" :
         [{"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",

          "name" : "Discussed Financial Aid Information",
          "ActionobjectStatus" Plan: Developed"ACTIVE"},
          {"id" : "7ed6d7202d28c719-7f91a8a6-11e1414f-b0c4b27e-0800200c9a66f6479dfa6a51",
           "name" : "DiscussedFollow-Up FinancialAppointment Aid InformationMade"},
          ...
     "objectStatus" : "ACTIVE"},
   ]},      {"journalStep" :...
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",]},
     ...
      "name]
}

Create Journal Entry for a Person

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

Security

PERSON_JOURNAL_ENTRY_WRITE

Sample Post

JournalEntryTO

Code Block

{"createdDate" : "Transition"},
 1332216000000,
    "journalStepDetailscreatedBy" : 
       [{"id" : "7ed6d72091f46e39-7f91cea8-11e1422b-b0c4b215-0800200c9a6600f6bcf5d280",
     "firstName" : "John",
     "namelastName" : "Doe"Discussed Financial Aid Information"}},
 "modifiedDate" : 1332216000000,
 "modifiedBy" : 
     {"id" : "2d28c71991f46e39-a8a6cea8-414f422b-b27eb215-f6479dfa6a51",
   00f6bcf5d280",
      "namefirstName" : "Follow-Up Appointment Made"}John",
     "lastName"    ...
        ]: "Doe"},
 "objectStatus" : "ACTIVE",
 ...
    ]
}

Create Journal Entry for a Person

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

Sample Post

JournalEntryTO

Code Block

"entryDate" : 1332216000000,
 "comment" : "",
 "confidentialityLevel" :
    {"id" : "240e97c0c57f11e1-7fe57ef2-11e14989-b0c49ac2-0800200c9a667b0690563995",
     "createdDatename" : 1332216000000,"EVERYONE"}
 "createdByjournalSource" :
     {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66",
     "firstNamename" : "JohnAppointment",
     "lastNameobjectStatus" : "Doe"},
 "modifiedDate" : 1332216000000ACTIVE"},
 "modifiedByjournalTrack" :
     {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e",
      "firstNamename" : "JohnTrack",
     "lastNameobjectStatus" : "DoeACTIVE"},
 "objectStatusjournalEntryDetails" : "ACTIVE",
 "entryDate" : 1332216000000,  [{"commentjournalStep" :
"",   "confidentialityLevel" :     {"id" : "c57f11e123befc50-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
     "name"  : "EVERYONE"}  "journalSourceIdobjectStatus" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalSource" :ACTIVE"},
      "journalStepDetails" :
         [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "nameobjectStatus" : "AppointmentACTIVE"},
          {"journalTrackIdid" : "1ec338877ed6d720-7d5e7f91-477011e1-aef2b0c4-049a8314130e0800200c9a66",
 "journalEntryDetails"
:     [{"journalStep" :          {"id"objectStatus" : "23befc50-7f91-11e1-b0c4-0800200c9a66ACTIVE"},
       "journalStepDetails" :  ...
       [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"},
  ]},
     {"journalStep" :
        {"id" : "7ed6d72023befc50-7f91-11e1-b0c4-0800200c9a66"},
          ...
         ]"objectStatus" : "ACTIVE"},
     { "journalStepjournalStepDetails" :
        [{"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66"},
          "journalStepDetailsobjectStatus" : "ACTIVE"},
         [{"id" : "7ed6d7202d28c719-7f91a8a6-11e1414f-b0c4b27e-0800200c9a66f6479dfa6a51"},
         { "idobjectStatus" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51ACTIVE"},
         ...
        ]},
     ...
    ]
}

Returns

...

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",
 " : "ACTIVEentryDate" : 1332216000000,
 "comment" : "",
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "entryDate" : 1332216000000,  "commentname" : "EVERYONE",}
 "confidentialityLeveljournalSource" :
    {"id" : "c57f11e123befc50-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
     "name" : "EVERYONE"}Appointment",
     "journalSourceIdobjectStatus" : "aabf0232-5994-4108-986e-cfb6f28724ae"ACTIVE"},
 "journalSourcejournalTrack" :
     {"id" : "23befc501ec33887-7f917d5e-11e14770-b0c4aef2-0800200c9a66049a8314130e",
      "name" : "AppointmentTrack"},
     "journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e" "ACTIVE"},
 "journalEntryDetails" :
    [{"journalStep" :
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          "name" : "CAPSession",
          "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
         [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Action Plan Developed",
           "objectStatus" : "ACTIVE"},
          {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66-0800200c9a66",
           "name" : "Discussed Financial Aid Information",
           "nameobjectStatus" : "Discussed Financial Aid InformationACTIVE"},
          ...
         ]},
     {"journalStep" :
        {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
         "name" : "Transition",
         "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
        [{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "name" : "Discussed Financial Aid Information",
          "objectStatus" : "ACTIVE"},
         {"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51-b27e-f6479dfa6a51",
          "name" : "Follow-Up Appointment Made",
          "nameobjectStatus" : "Follow-Up Appointment MadeACTIVE"},
         ...
        ]},
     ...
    ]
}

Save Journal Entry for a Person

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

Security

PERSON_JOURNAL_ENTRY_WRITE

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" : "ACTIVE"1332216000000,
 "comment" : "",
 "confidentialityLevel" :
    {"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "entryDate" : 1332216000000,  "commentname" : "EVERYONE",}
 "confidentialityLeveljournalSource" :
    {"id" : "c57f11e123befc50-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66",
     "name" : "EVERYONE"}Appointment",
     "journalSourceIdobjectStatus" : "aabf0232-5994-4108-986e-cfb6f28724ae"ACTIVE"},
 "journalSourcejournalTrack" :
     {"id" : "23befc501ec33887-7f917d5e-11e14770-b0c4aef2-0800200c9a66049a8314130e",
      "name" : "AppointmentTrack"},
     "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e"objectStatus" : "ACTIVE"},
 "journalEntryDetails" :
    [{"journalStep" :
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          "name" : "CAPSession",
          "objectStatus" : "ACTIVE},
      "journalStepDetails" :
         [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Action Plan Developed"
           "objectStatus" : "ACTIVE"},
          {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66-b0c4-0800200c9a66",
           "name" : "Discussed Financial Aid Information",
           "nameobjectStatus" : "Discussed Financial Aid InformationACTIVE"},
          ...
         ]},
     {"journalStep" :
        {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
         "name" : "Transition",
         "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
        [{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "name" : "Discussed Financial Aid Information",
          "objectStatus" : "ACTIVE"},
         {"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
          "name" : "Follow-Up Appointment MadeMade",
          "objectStatus" : "ACTIVE"},
         ...
        ]},
     ...
    ]
}

Returns

...

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" :
    {"journalSourceIdid" : "aabf023223befc50-59947f91-410811e1-986e-cfb6f28724ae"b0c4-0800200c9a66",
     "name" : "Appointment",
     "objectStatus" : "ACTIVE"},
 "journalSourcejournalTrack" :
     {"id" : "23befc501ec33887-7f917d5e-11e14770-b0c4aef2-0800200c9a66049a8314130e",
      "name" : "Appointment"},Track",
     "journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e"ACTIVE"},
 "journalEntryDetails" :
    [{"journalStep" :
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          "name" : "CAPSession",
          "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
         [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Action Plan Developed",
           "objectStatus" : "ACTIVE"},
          {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "name" : "Discussed Financial Aid InformationFinancial Aid Information",
           "objectStatus" : "ACTIVE"},
          ...
         ]},
     {"journalStep" :
        {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
         "name" : "Transition",
         "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
        [{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "name" : "Discussed Financial Aid Information",
          "objectStatus" : "ACTIVE"},
         {"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
          "name" : "Follow-Up Appointment Made",
          "objectStatus" : "ACTIVE"},
         ...
        ]},
     ...
    ]
}

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 11

New Version Current

Key

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

Delete a Journal Entry from a Person