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

« Previous Version 18 Current »

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
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",
     "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",
     "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"},
          ...
         ]},
      ...
     ]
 }]

 

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",
     "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"},
         ...
        ]},
     ...
    ]
}

 

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",
     "objectStatus" : "ACTIVE"},
 "journalTrack" :
     {"id" : "1ec33887-7d5e-4770-aef2-049a8314130e",
      "name" : "Track",
     "objectStatus" : "ACTIVE"},
 "journalEntryDetails" :
    [{"journalStep" :
         {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
          "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
         [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
           "objectStatus" : "ACTIVE"},
          {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
           "objectStatus" : "ACTIVE"},
          ...
         ]},
     {"journalStep" :
        {"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
         "objectStatus" : "ACTIVE"},
      "journalStepDetails" :
        [{"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
          "objectStatus" : "ACTIVE"},
         {"id" : "2d28c719-a8a6-414f-b27e-f6479dfa6a51",
          "objectStatus" : "ACTIVE"},
         ...
        ]},
     ...
    ]
}

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",
     "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"},
         ...
        ]},
     ...
    ]
}

 

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",
     "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"},
         ...
        ]},
     ...
    ]
}

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",
     "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"},
         ...
        ]},
     ...
    ]
}


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."}
  • No labels