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

« Previous Version 3 Next »

Get All Student Statuses

GET /ssp/api/1/reference/studentStatus

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

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"createdBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "createdDate" : "1332216000000",
      "description" : "Current",
      "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
      "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "Current",
      "objectStatus" : "ACTIVE"},
     {"createdBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "createdDate" : "1332216000000",
      "description" : "Former",
      "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
      "modifiedBy" : 
        {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
         "firstName" : "John",
         "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "name" : "Former",
      "objectStatus" : "ACTIVE"},
     ...
    ]
}

 

Get a Student Status

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

Returns

StudentStatus

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},   
 "createdDate" : "1332216000000",
 "description" : "Former",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Former",
 "objectStatus" : "ACTIVE"}

 

Create a Student Status

POST /ssp/api/1/reference/studentStatus

Sample Post

{"name" : "Former"
 "description" : "Former."}

Returns

StudentStatus

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Former",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Former",
 "objectStatus" : "ACTIVE"}

 

Save a Student Status

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

Sample Post

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Former",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Former",
 "objectStatus" : "ACTIVE"}

Returns

StudentStatus

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Former",
 "id" : "6201b18d-9d1d-48d3-82d4-092e52ad676b",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Former",
 "objectStatus" : "ACTIVE"}

 

Delete a Student Status

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

Returns

{"ServiceResponse" : 
    {"success" : "true"}}

or

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