deleteLocationNote

POST public/deleteLocationNote

Deletes a note.

Request syntax

curl https://apiv2.acumera.net/public/deleteLocationNote \
  --cookie av_session.txt \
  --data-urlencode "location_note_id=<location_note_id>"

The username, password, and tfa_token parameters are also accepted, and are required only if the client hasn't already signed in with login. See Getting started with the SC//AcuVigil API.

Request parameters

The request accepts the following parameters in a form-encoded body.

Parameter	Type	Description	Required	Default value
`location_note_id`	Integer	The ID of the note. To find note IDs, use getLocationNotes.	Yes

Response syntax

{
    "success": "string",
    "returnCode": "string",
    "returnMessage": "string"
}

Response parameters

Field	Description
`success`	`"1"` if the note was deleted.
`returnCode`	`NOTE_DELETED` when the note was deleted.
`returnMessage`	A description of the result.

Errors

If the call fails, success is "0", and returnCode and returnMessage describe the problem. The HTTP status is still 200.

Return code	Message	Cause
`NO_NOTE_SELECTED`	No note was selected.	`location_note_id` is missing or isn't a number.
`NOTE_NOT_FOUND`	The note was not found.	No note has that ID, for example because it was already deleted.
`AUTH_FAILED_FUNC_NOT_ALLOWED`	Authorization failed because you are not permitted to access the requested function.	You aren't allowed to delete this note.
`INVALID_LOGIN`	We were unable to log you in. Make sure you entered the correct username, password and 2FA code.	You haven't signed in, your session has ended, or the credentials sent with the call are wrong.

Examples

Example: Delete a note

curl https://apiv2.acumera.net/public/deleteLocationNote \
  --cookie av_session.txt \
  --data-urlencode "location_note_id=123457"

Response:

{
    "success": "1",
    "returnCode": "NOTE_DELETED",
    "returnMessage": "The note has been deleted."
}

Example: Delete a note that's already been deleted

{
    "success": "0",
    "returnCode": "NOTE_NOT_FOUND",
    "returnMessage": "The note was not found."
}