Get All Completed Items
GET /ssp/api/1/reference/completedItem
Security
REFERENCE_READ
Parameters
status : ALL, ACTIVE, INACTIVE
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
{"success":"true",
"message":"",
"results":4,
"rows":[
{"id":"0a90940a-43ec-1d0f-8143-ef5f52610002",
"createdDate":1391290438242,
"createdBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1391290438242,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Registered for Classes",
"description":"Registered for Classes for the upcoming term"},
{"id":"0a90940a-43ec-1d0f-8143-ef5f67d00003",
"createdDate":1391290443728,
"createdBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1391290443728,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Bought Books",
"description":"Purchased books for the registered classes"},
...
]
}
Get a Completed Item
GET /ssp/api/1/reference/completedItem/{id}
Security
REFERENCE_READ
Returns
{"success":"true",
"message":"",
"results":1,
"rows":[
{"id":"0a90940a-43ec-1d0f-8143-ef5f52610002",
"createdDate":1391290438242,
"createdBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1391290438242,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Registered for Classes",
"description":"Registered for Classes for the upcoming term"},
]
}
Create a Completed Item
POST /ssp/api/1/reference/completedItem
Security
REFERENCE_WRITE
Sample Post
"name":"Registered for Classes",
"description":"Registered for Classes for the upcoming term"}
Returns
{"id":"0a90940a-43ec-1d0f-8143-ef5f52610002",
"createdDate":1391290438242,
"createdBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1391290438242,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Registered for Classes",
"description":"Registered for Classes for the upcoming term"}
Save a Completed Item
PUT /ssp/api/1/reference/completedItem/{id}
Security
REFERENCE_WRITE
Sample Post
{"id":"0a90940a-43ec-1d0f-8143-ef5f52610002",
"createdDate":1391290438242,
"createdBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1391290438242,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Registered for Classes",
"description":"Registered for Classes for the upcoming term"}
Returns
{"id":"0a90940a-43ec-1d0f-8143-ef5f52610002",
"createdDate":1391290438242,
"createdBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"modifiedDate":1391290438242,
"modifiedBy":{"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
"firstName":"Amy",
"lastName":"Administrator"},
"objectStatus":"ACTIVE",
"name":"Registered for Classes",
"description":"Registered for Classes for the upcoming term"}
Delete a Completed Item
DELETE /ssp/api/1/reference/completedItem/{id}
Security
REFERENCE_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}