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 Education Goals

GET /ssp/api/1/reference/educationGoal

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<EducationGoal>

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

 

Get an Education Goal

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

Returns

Citizenship

{"createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Associates Degree",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Associates Degree",
 "objectStatus" : "ACTIVE"}

 

Create an Education Goal

POST /ssp/api/1/reference/educationGoal

Sample Post

{"description" : "Associates Degree",
 "name" : "Associates Degree"}

Returns

EducationGoal

{"createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Associates Degree",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Associates Degree",
 "objectStatus" : "ACTIVE"}

 

Save an Education Goal

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

Sample Post

{"createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Associates Degree",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Associates Degree",
 "objectStatus" : "ACTIVE"}

Returns

EducationGoal

{"createdBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "createdDate" : "1332216000000",
 "description" : "Associates Degree",
 "id" : "c57f11e1-7ef2-4989-9ac2-7b0690563995",
 "modifiedBy" : 
   {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
    "firstName" : "John",
    "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "name" : "Associates Degree",
 "objectStatus" : "ACTIVE"}

 

Delete a Education Goal

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

Returns

{"success" : "true"}

or

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