| PST SDK 6.0.0.0-272350a

SetTargetStatus

Set status of a single tracking Target.

Endpoint

      POST /PSTapi/SetTargetStatus  HTTP/1.1
      Host: address:port

TargetStatus Object

Key | Value Type | Description
--- | --- | ---
TargetStatus | JSON Object | container for Target status information
name | string | name of the target
status | boolean | set the tracking status of a target to active(true) or inactive (false)

POST Payload: Request body parameters example

      {"TargetStatus":{"name":"MyTargetName","status":true}}

Response

Returns a status message.

Verification table

Status Code | Content Example | Meaning
--- | --- | ---
200 | {"message":"Model Status correctly set"} | Success message
400 | {"message":"JSON_ERROR: <...>"} | An error occurred when parsing a JSON object
400 | {"message":"TrackerException:MSG_MODEL_NOT_FOUND <...>"} | Requested Target could not be found
500 | {"message":"TrackerException: <...>"} | an other type of internal error