Versions Compared

Old Version 12

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Jason Elwood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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"} 
  "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" : "Action Plan DevelopedCAPSession"},
           {"idobjectStatus" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66"ACTIVE"},
       "journalStepDetails" :
   "name       [{"id" : "Discussed Financial Aid Information"}23befc50-7f91-11e1-b0c4-0800200c9a66",
           ... "name" : "Action Plan Developed",
     ]},       {"journalStepobjectStatus" : "ACTIVE"},
           {"id" : "23befc507ed6d720-7f91-11e1-b0c4-0800200c9a66",
            "name" : "Transition"},Discussed Financial Aid Information",
    "journalStepDetails" :       "objectStatus" :  [{"id" : "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" :
    ...      ]
 }]

 

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",
           "firstNamename" : "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",...
        "name" : "Appointment"},
 "journalTrackId]
 }]

 

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" : "1ec33887240e97c0-7d5e7fe5-477011e1-aef2b0c4-049a8314130e0800200c9a66",
 "journalEntryDetailscreatedDate" : 1332216000000,
   [{"journalStepcreatedBy" : 
        {"{"id" : "23befc5091f46e39-7f91cea8-11e1422b-b0c4b215-0800200c9a6600f6bcf5d280",
    "firstName" : "John",
    "namelastName" : "CAPSessionDoe"},
 "modifiedDate" :  1332216000000,
 "journalStepDetailsmodifiedBy" : 
        [{"id" : "23befc5091f46e39-7f91cea8-11e1422b-b0c4-0800200c9a66",
           "name" : "Action Plan Developed"},
          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

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"},
   [{"idobjectStatus" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66ACTIVE",
       "entryDate" : 1332216000000,
  "namecomment" : "Discussed Financial Aid Information"},
 "confidentialityLevel"   :
    {"id" : "2d28c719c57f11e1-a8a67ef2-414f4989-b27e9ac2-f6479dfa6a517b0690563995",
    
     "name" : "Follow-Up Appointment MadeEVERYONE"},
         ...
        ]},
     ...

 "journalSource" :
   ] }

 

Create Journal Entry for a Person

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

Sample Post

JournalEntryTO

Code Block
{"id" : "240e97c023befc50-7fe57f91-11e1-b0c4-0800200c9a66",
 "createdDate    "name" : "Appointment",
     "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",
          "name" : "Follow-Up Appointment MadeUp 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

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-0800200c9a660800200c9a66",
           "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",
          "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"},
 "journalTrackId",
     "objectStatus" : "ACTIVE"},
 "journalTrack" :
     {"id" : "1ec33887-7d5e-4770-aef2-049a8314130e",
      "name" : "Track",
     "objectStatus" : "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"}

...