Versions Compared

Key

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

...

GET /ssp/api/1/reference/journalStepDetail

Security

SERVICE_REFERENCE_READ

Parameters

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

...

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

Security

SERVICE_REFERENCE_READ

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)

...

Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "23befc50aa4cbb22-7f91f5bf-11e14510-b0c48f99-0800200c9a669dfce1d2bba6",
      "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" : "7ed6d72012965f9c-7f91f801-11e14203-b0c4bc6e-0800200c9a66abb69ac75281",
      "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" : 1},
     ...
    ]
}

...

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

Security

SERVICE_REFERENCE_READ

Returns

JournalStepDetail

Code Block
{"id" : "23befc50aa4cbb22-7f91f5bf-11e14510-b0c48f99-0800200c9a669dfce1d2bba6",
 "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}

...

POST /ssp/api/1/reference/journalStepDetail

Security

SERVICE_REFERENCE_WRITE

Sample Post

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

...

JournalStepDetail

Code Block
{"id" : "23befc50aa4cbb22-7f91f5bf-11e14510-b0c48f99-0800200c9a669dfce1d2bba6",
 "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}

...

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"id" : "23befc50aa4cbb22-7f91f5bf-11e14510-b0c48f99-0800200c9a669dfce1d2bba6",
 "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}

...

JournalStepDetail

Code Block
{"id" : "23befc50aa4cbb22-7f91f5bf-11e14510-b0c48f99-0800200c9a669dfce1d2bba6",
 "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}

...

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

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

...