Versions Compared

Old Version 1

changes.mady.by.user Alexander Leader

Saved on

compared with

New Version Current

changes.mady.by.user Alexander Leader

Saved on

Key

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

...

GET /ssp/api/1/reference/journalTrack

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)

Returns

List<JournalTrack>

Code Block
Code Block
{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : "1332216000000",
      "createdBy" : 
"createdById         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
   "modifiedById   "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus" : "ACTIVE",
      "name" : "Individualized Learning Plan",
      "description" : "Individualized Learning Plan",
      "sortOrder" : 1},
     {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : "1332216000000",
      "createdById"createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "modifiedBy" : 
         {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus" : "ACTIVE",
      "name" : "Early Alert",
      "description" : "Early Alert"
      "sortOrder" : 1},
     ...
    ]
}


Get One Journal Track

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

Security

SERVICE_REFERENCE_READ

Returns

JournalTrack

Code Block
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdById"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "Individualized Learning Plan",
 "description" : "Individualized Learning Plan",
 "sortOrder" : 1}

...

POST /ssp/api/1/reference/journalTrack

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"name" : "Individualized Learning Plan",
 "description" : "Individualized Learning Plan",
 "sortOrder" : 1}

...

Code Block
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedById"modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "Individualized Learning Plan",
 "description" : "Individualized Learning Plan",
 "sortOrder" : 1}

...

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdById"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedById"modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "Individualized Learning Plan",
 "description" : "Individualized Learning Plan",
 "sortOrder" : 1}

...

Code Block
{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdBy" : 
    {"createdByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"modifiedByIdid" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "Individualized Learning Plan",
 "description" : "Individualized Learning Plan",
 "sortOrder" : 1}

 

Delete a Journal Track

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

Security

SERVICE_REFERENCE_WRITE

Returns

Code Block
{"success" : "true"}

or

Code Block
{"success" : "false", 
 "message" : "Message when success is false."}


Add a Journal Step to a Journal Track

POST /ssp/api/1/reference/journalTrack/{id}/journalStep

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66"}

Returns

Code Block
{"success" : "true"}

or

Code Block
{"success" : "false", 
 "message" : "Message when success is false."}


Remove a Journal Step from a Journal Track

DELETE /ssp/api/1/reference/journalTrack/{id}/journalStep

Security

SERVICE_REFERENCE_WRITE

Sample Post

Code Block
{"journalStepId" : "23befc50-7f91-11e1-b0c4-0800200c9a66"}

Returns

Code Block
{"success" : "true"}

...