...
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"},
"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",
"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"},
...
]},
...
]
},
{"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"},
"journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e"ACTIVE"},
"journalEntryDetailsjournalTrack" :
[{"journalStep" :
{"id" : "23befc501ec33887-7f917d5e-11e14770-b0c4aef2-0800200c9a66049a8314130e",
"name" : "CAPSessionTrack"},
"journalStepDetailsobjectStatus" : "ACTIVE"},
"journalEntryDetails" :
[{"journalStep" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Action Plan DevelopedCAPSession",
"objectStatus" : "ACTIVE"},
"journalStepDetails" :
[{"id" : "7ed6d72023befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "DiscussedAction FinancialPlan Aid InformationDeveloped"},
... "objectStatus" ]},
{"journalStep" :: "ACTIVE"},
{"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",
"name" : "Transition"},Discussed Financial Aid Information",
"journalStepDetails" :
[{"idobjectStatus" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"ACTIVE"},
"name" : "Discussed Financial Aid Information"},...
]},
{"journalStep" :
{"id" : "2d28c71923befc50-a8a67f91-414f11e1-b27eb0c4-f6479dfa6a510800200c9a66",
"name" : "Follow-Up Appointment Made"}Transition",
...
"objectStatus" : "ACTIVE"},
]},
"journalStepDetails" :
... [{"id" ]
}] |
Get One Journal Entry for a Person
GET /ssp/api/1/person/{id}/journalEntry/{id}
Security
PERSON_JOURNAL_ENTRY_READ
Returns
JournalEntry
| Code Block |
|---|
{: "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"}, ... ]}, ... ] }] |
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" : "240e97c07ed6d720-7fe57f91-11e1-b0c4-0800200c9a66", "createdDatename" : 1332216000000, "createdBy" : "Discussed Financial Aid Information", {"idobjectStatus" : "91f46e39-cea8-422b-b215-00f6bcf5d280",ACTIVE"}, "firstName" : "John", ... "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" : "Discussed Financial Aid Information", "objectStatus" : "EVERYONEACTIVE"}, "journalSource" : {"id" : "23befc502d28c719-7f91a8a6-11e1414f-b0c4b27e-0800200c9a66f6479dfa6a51", "name" : "Appointment"}, "journalTrackIdname" : "1ec33887-7d5e-4770-aef2-049a8314130e", "journalEntryDetails" : [{"journalStep" :Follow-Up Appointment Made", {"idobjectStatus" : "23befc50-7f91-11e1-b0c4-0800200c9a66", ACTIVE"}, "name" : "CAPSession"}, ... "journalStepDetails" : ]}, [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66", "name" : "Action Plan Developed"}, ... ] } |
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" : "7ed6d72091f46e39-7f91cea8-11e1422b-b0c4b215-0800200c9a6600f6bcf5d280", "name" : "Discussed Financial Aid Information"}, ... "firstName" : "John", "lastName" : ]"Doe"}, "modifiedDate" : 1332216000000, {"journalStepmodifiedBy" : {"id" : "23befc5091f46e39-7f91cea8-11e1422b-b0c4b215-0800200c9a6600f6bcf5d280", "namefirstName" : "TransitionJohn"}, "journalStepDetailslastName" : "Doe"}, [{"id"objectStatus" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66", "nameACTIVE", "entryDate" : 1332216000000, "comment" : "Discussed Financial Aid Information"}, "confidentialityLevel" : {"id" : "2d28c719c57f11e1-a8a67ef2-414f4989-b27e9ac2-f6479dfa6a517b0690563995", "name" : "Follow-Up Appointment MadeEVERYONE"}, "journalSource" : {"id" ... ]},: "23befc50-7f91-11e1-b0c4-0800200c9a66", "name" ...: "Appointment", ] } |
Create Journal Entry for a Person
POST /ssp/api/1/person/{id}/journalEntry
Security
PERSON_JOURNAL_ENTRY_WRITE
Sample Post
JournalEntryTO
| Code Block |
|---|
{"createdDate"objectStatus" : 1332216000000"ACTIVE"}, "createdByjournalTrack" : {"id" : "91f46e391ec33887-cea87d5e-422b4770-b215aef2-00f6bcf5d280049a8314130e", "firstNamename" : "JohnTrack", "lastNameobjectStatus" : "DoeACTIVE"}, "modifiedDatejournalEntryDetails" : 1332216000000, [{"modifiedByjournalStep" : {"id" : "91f46e3923befc50-cea87f91-422b11e1-b215b0c4-00f6bcf5d2800800200c9a66", "firstName" : "John", "lastNameobjectStatus" : "DoeACTIVE"}, "objectStatus" : "ACTIVE", "entryDatejournalStepDetails" : 1332216000000, "comment" : "", "confidentialityLevel" : [{"id" : "c57f11e123befc50-7ef27f91-498911e1-9ac2b0c4-7b06905639950800200c9a66", "nameobjectStatus" : "EVERYONEACTIVE"}, "journalSource" : {"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66", "name" : "Appointment"}, "journalTrackIdobjectStatus" : "1ec33887-7d5e-4770-aef2-049a8314130e"ACTIVE"}, "journalEntryDetails" : [{"journalStep" : ... {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66" ]}, {"journalStepDetailsjournalStep" : [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66"}, {"idobjectStatus" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66ACTIVE"}, ... ]}, {"journalStep"journalStepDetails" : [{"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",
"entryDate" : 1332216000000,
"comment" : "",
"confidentialityLevel" :
{"id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
"name" : "EVERYONE"}
"journalSource" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Appointment",
"objectStatus" : "ACTIVE"},
"journalTrackIdjournalTrack" :
{"id" : "1ec33887-7d5e-4770-aef2-049a8314130e"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-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-f6479dfa6a51",
"name" : "Follow-Up Appointment Made",
"nameobjectStatus" : "Follow-Up Appointment MadeACTIVE"},
...
]},
...
]
} |
Save Journal Entry for a Person
...
| 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"},
"journalTrackIdjournalTrack" :
{"id" : "1ec33887-7d5e-4770-aef2-049a8314130e"-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-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-f6479dfa6a51",
"name" : "Follow-Up Appointment Made",
"nameobjectStatus" : "Follow-Up Appointment MadeACTIVE"},
...
]},
...
]
} |
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" :
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
"name" : "Appointment",
"objectStatus" : "ACTIVE"},
"journalTrackIdjournalTrack" :
{"id" : "1ec33887-7d5e-4770-aef2-049a8314130e"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-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 Made",
"objectStatus" : "ACTIVE"},
...
]},
...
]
} |
Delete a Journal Entry from a Person
...