Skip to main content

setSituationAcknowledgeState

A Graze API POST request that acknowledges or unacknowledges the moderator who has been assigned to a Situation. The Situation must be assigned for this request to be successful.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint setSituationAcknowledgeState takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.

sitn_id

Number

Yes

Situation ID.

acknowledged

Number

Yes

The acknowledge state:

  • 0 = unacknowledged

  • 1 = acknowledged

Response

Endpoint setSituationAcknowledgeState returns the following response:

API update behavior

The behavior of this endpoint depends on whether the relevant alert or Situation is open, closed and still in the active database, or closed and archived to the historic database. This endpoint updates the alert or Situation as follows:

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of endpoint setSituationAcknowledgeState:

Request example

Example cURL request to set the moderator on Situation ID 64 as acknowledged:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/setSituationAcknowledgeState" -H "Content-Type: application/json; charset=UTF-8" -d '{"sitn_id" : 64, "acknowledged" : 1 }'

Response example

In this section: