getSituationDescription

A Graze API GET request that returns the description for a specified Situation.

Request arguments

Endpoint getSituationDescription 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.

Endpoint getSituationDescription returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

Successful requests return a JSON object containing the following:

Name	Type	Description
`sitn_id`	Number	Situation ID.
`description`	String	Text in the Situation' description field.

The following examples demonstrate typical use of endpoint getSituationDescription:

Example cURL request to return the description for Situation ID 231:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSituationDescription" \
--data-urlencode "sitn_id=231"

Example response returning the description for Situation ID 231:

{
    "sitn_id": "231", 
    "description": "SyslogLamCookbook source"
}