Career Decision Status API

Owned by Jason Elwood
Oct 05, 2015
4 min read

Get All Career Decision Statuses

GET /ssp/api/1/reference/careerstatus

Security

SERVICE_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":2,
   "rows":[  
      {  
         "id":"c0a80097-4b9f-1fb0-814b-9ffd69840004",
         "createdDate":1424318359940,
         "createdBy":{  
            "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
            "firstName":"Amy",
            "lastName":"Administrator",
            "fullName":"Amy Administrator"
         },
         "modifiedDate":1424318359940,
         "modifiedBy":{  
            "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
            "firstName":"Amy",
            "lastName":"Administrator",
            "fullName":"Amy Administrator"
         },
         "objectStatus":"ACTIVE",
         "name":"Complete",
         "description":"Complete",
         "code":"CP"
      },
      {  
         "id":"c0a80097-4b9f-1fb0-814b-9ffc11f60003",
         "createdDate":1424318271990,
         "createdBy":{  
            "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
            "firstName":"Amy",
            "lastName":"Administrator",
            "fullName":"Amy Administrator"
         },
         "modifiedDate":1424318271990,
         "modifiedBy":{  
            "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
            "firstName":"Amy",
            "lastName":"Administrator",
            "fullName":"Amy Administrator"
         },
         "objectStatus":"ACTIVE",
         "name":"None",
         "description":"No Status Decision",
         "code":"NO"
      }
   ]
}

 

Get a Career Decision Status

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

Security

SERVICE_REFERENCE_READ

Returns

Citizenship

{  
   "id":"c0a80097-4b9f-1fb0-814b-9ffd69840004",
   "createdDate":1424318359940,
   "createdBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1444060744353,
   "modifiedBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "name":"Complete",
   "description":"Complete",
   "code":"CP"
}

 

Create a Career Decision Status

POST /ssp/api/1/reference/careerstatus

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"name":"Complete",
 "description":"Complete",
 "code":"CP"
}

Returns

Career Decision Status

{  
   "id":"c0a80097-4b9f-1fb0-814b-9ffd69840004",
   "createdDate":1424318359940,
   "createdBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1444060744353,
   "modifiedBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "name":"Complete",
   "description":"Complete",
   "code":"CP"
}

 

Save a Career Decision Status

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

Security

SERVICE_REFERENCE_WRITE

Sample Post

{  
   "id":"c0a80097-4b9f-1fb0-814b-9ffd69840004",
   "createdDate":1424318359940,
   "createdBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1444060744353,
   "modifiedBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "name":"Complete",
   "description":"Complete",
   "code":"CP"
}

Returns

Career Decision Status

{  
   "id":"c0a80097-4b9f-1fb0-814b-9ffd69840004",
   "createdDate":1424318359940,
   "createdBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "modifiedDate":1444060744353,
   "modifiedBy":{  
      "id":"c0a80097-4b52-1f09-814b-5235b24f0001",
      "firstName":"Amy",
      "lastName":"Administrator",
      "fullName":"Amy Administrator"
   },
   "objectStatus":"ACTIVE",
   "name":"Complete",
   "description":"Complete",
   "code":"CP"
}

 

Delete a Career Decision Status

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

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

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