Get a Plan (MAP) Status
Description
Two methods are available to store the Plan status in SSP. The calculation can be made by SSP or provided in the external data. Each has a separate API for accessing the information (GET). The external data only accepts a GET method. The SSP calculated data accepts each method described below. Paginated collection of all plan summaries for {person-uuid}, optionally filtered by status. See API notes for status parameter handling handling.
Methods
External Data: GET /ssp/api/1/person/{id}/map/plan/planstatus
SSP Data: GET /ssp/api/1/person/{id}/map/plan/calculatedPlanstatus
Security
PERSON_MAP_READ
Returns
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}
Create a Plan (MAP) Status
SSP Data: POST /ssp/api/1/person/{id}/map/plan/calculatedPlanstatus
External Data: None
Security
PERSON_MAP_WRITE
Sample Post
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}
Returns
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}
Save a Plan (MAP) Status
SSP Data: PUT /ssp/api/1/person/{id}/map/plan/calculatedPlanstatus
External Data: None
Security
PERSON_MAP_WRITE
Sample Post
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}
Returns
{"schoolId":"jwilson219",
"status":"ON",
"statusReason":" "}
Delete a Plan (MAP) Status
SSP Data: DELETE /ssp/api/1/person/{id}/map/plan/calculatedPlanstatus
External Data: None
Security
PERSON_MAP_WRITE
Returns
{"success" : "true"}
or
{"success" : "false",
"message" : "Message when success is false."}