Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Get All Journal Entries for Person

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

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" : "",
  "confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
  "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
  "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},
      ...
     ]
 },
 {"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" : "",
  "confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
  "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
  "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
  "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},
      ...
     ]
 }]

 

Get One Journal Entry for a Person

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

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" : "",
 "confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "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

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

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" : "",
 "confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "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},
      ...
     ]
}

 

Save Journal Entry for a Person

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

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" : "",
 "confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "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},
      ...
     ]
}

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" : "",
 "confidentialityLevelId" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "journalSourceId" : "aabf0232-5994-4108-986e-cfb6f28724ae",
 "journalTrackId" : "1ec33887-7d5e-4770-aef2-049a8314130e",
 "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},
      ...
     ]
}


Delete a Journal Entry from a Person

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

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}
  • No labels