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.
Parameters
status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : "ASC" or "DESC" or "ASCENDING" or "DESCENDING"
Returns
List<JournalEntry>
[{"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"},
"journalTrack" :
{"id" : "1ec33887-7d5e-4770-aef2-049a8314130e",
"name" : "Track"},
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "CAPSession"},
"journalStepDetails" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Action Plan Developed"},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
...
]},
{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Transition"},
"journalStepDetails" :
[{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
"name" : "Follow-Up Appointment Made"},
...
]},
...
]
},
{"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"}
"journalSource" :
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Email"},
"journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "CAPSession"},
"journalStepDetails" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Action Plan Developed"},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
...
]},
{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Transition"},
"journalStepDetails" :
[{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
"name" : "Follow-Up Appointment Made"},
...
]},
...
]
}]
Get One Journal Entry for a Person
GET /ssp/api/1/person/{id}/journalEntry/{id}
Security
PERSON_JOURNAL_ENTRY_READ
Returns
JournalEntry
{"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",
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "CAPSession"},
"journalStepDetails" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Action Plan Developed"},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
...
]},
{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Transition"},
"journalStepDetails" :
[{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
"name" : "Follow-Up Appointment Made"},
...
]},
...
]
}
Create Journal Entry for a Person
POST /ssp/api/1/person/{id}/journalEntry
Security
PERSON_JOURNAL_ENTRY_WRITE
Sample Post
JournalEntryTO
{"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",
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"},
"journalStepDetails" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"},
...
]},
{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"},
"journalStepDetails" :
[{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51"},
...
]},
...
]
}
Returns
JournalEntryTO
{"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",
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "CAPSession"},
"journalStepDetails" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Action Plan Developed"},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
...
]},
{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Transition"},
"journalStepDetails" :
[{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
"name" : "Follow-Up Appointment Made"},
...
]},
...
]
}
Save Journal Entry for a Person
PUT /ssp/api/1/person/{id}/journalEntry
Security
PERSON_JOURNAL_ENTRY_WRITE
Sample Post
JournalEntryTO
{"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",
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "CAPSession"},
"journalStepDetails" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Action Plan Developed"},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
...
]},
{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Transition"},
"journalStepDetails" :
[{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
"name" : "Follow-Up Appointment Made"},
...
]},
...
]
}
Returns
JournalEntryTO
{"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",
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "CAPSession"},
"journalStepDetails" :
[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Action Plan Developed"},
{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
...
]},
{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Transition"},
"journalStepDetails" :
[{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Discussed Financial Aid Information"},
{"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
"name" : "Follow-Up Appointment Made"},
...
]},
...
]
}
Delete a Journal Entry from a Person
DELETE /ssp/api/1/person/{id}/journalEntry/{id}
Security
PERSON_JOURNAL_ENTRY_DELETE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}