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 Step Details

GET /ssp/api/1/reference/journalStepDetail

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>
limit : Maximum number of results to return<br>
sort : Property name<br>
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

List<JournalStepDetail>

[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
  "createdDate" : "1332216000000",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "objectStatus" : "ACTIVE",
  "name" : "Action Plan Developed",
  "description" : "Action plan developed with student.",
  "sortOrder" : 1},
 {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
  "createdDate" : "1332216000000",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "objectStatus" : "ACTIVE",
  "name" : "Discussed Financial Aid Information",
  "description" : "Discussed financial aid information with student and determined any additional financial needs."
  "sortOrder" : 1},
 {"id" : "3ac714c7-390d-4994-ac43-5de0a0ac9832",
  "createdDate" : "1332216000000",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "objectStatus" : "ACTIVE",
  "name" : "Follow-Up Appointment Made",
  "description" : "Follow-up appointment made with student."
  "sortOrder" : 1},
 ...
]


Get All Journal Step Details For Journal Step

GET /ssp/api/1/reference/journalStep/{id}/journalStepDetails

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 : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

List<JournalStepDetail>

[{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
  "createdDate" : "1332216000000",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "objectStatus" : "ACTIVE",
  "name" : "Action Plan Developed",
  "description" : "Action plan developed with student.",
  "sortOrder" : 1},
 {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
  "createdDate" : "1332216000000",
  "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "modifiedDate" : "1332216000000",
  "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
  "objectStatus" : "ACTIVE",
  "name" : "Discussed Financial Aid Information",
  "description" : "Discussed financial aid information with student and determined any additional financial needs."
  "sortOrder" : 1},
 ...
]


Get One Journal Step Detail

GET /ssp/api/1/reference/journalStepDetail/{id}

Returns

JournalStepDetail

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "ACTIVE",
 "name" : "Action Plan Developed",
 "description" : "Action plan developed with student.",
 "sortOrder" : 1}

 

Create a Journal Step Detail

POST /ssp/api/1/reference/journalStepDetail

Sample Post

{"name" : "Action Plan Developed",
 "description" : "Action plan developed with student.",
 "sortOrder" : 1}

Returns

JournalStepDetail

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "ACTIVE",
 "name" : "Action Plan Developed",
 "description" : "Action plan developed with student.",
 "sortOrder" : 1}

 

Save a Journal Step Detail

PUT /ssp/api/1/reference/journalStepDetail/{id}

Sample Post

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "ACTIVE",
 "name" : "Action Plan Developed",
 "description" : "Action plan developed with student.",
 "sortOrder" : 1}

Returns

JournalStepDetail

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "modifiedDate" : "1332216000000",
 "modifiedById" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
 "objectStatus" : "ACTIVE",
 "name" : "Action Plan Developed",
 "description" : "Action plan developed with student.",
 "sortOrder" : 1}

 

Delete a Journal Step Detail

DELETE /ssp/api/1/reference/journalStepDetail/{id}

Returns

{"success" : "true"}

or

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