View as Markdown OpenAPI spec

Test endpoint

GET /api/v1/test operationId: test

Base: https://portal.watcheye.com.au/api/v1/test

Test endpoint which just returns a message indicating the API is connected and working.

Responses

200

Test response

application/json

Field Description

Field	Description
`message`	string A message indicating the result of the request. This will be `Ok` if the request was successful. Example: `Ok`
`api_reference`	string (uuid) A unique identifier for this request. This can be used to track the request in the logs and audit trail. Example: `123e4567-e89b-12d3-a456-426614174000`

message

string

A message indicating the result of the request. This will be Ok if the request was successful.

Example: Ok

api_reference

string (uuid)

A unique identifier for this request. This can be used to track the request in the logs and audit trail.

Example: 123e4567-e89b-12d3-a456-426614174000

Standard error responses: 400 401 402 403 429 5XX See common error responses

Previous Delete a relationship Next List users

Response

200 Test response

{
    "message": "Ok",
    "api_reference": "123e4567-e89b-12d3-a456-426614174000"
}

400 Bad Request - The request is invalid shared error response

{
    "message": "Bad Request",
    "api_reference": "00000000-0000-0000-0000-000000000000",
    "errors": {
        "data.passport_number": [
            "The passport number format is invalid."
        ]
    }
}

401 Unauthorized - the API key or account is inactive, expired, or not permitted from this IP address shared error response

{
    "message": "API Key Inactive",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

402 Insufficient Credit - Insufficient credit to process this request shared error response

{
    "message": "Insufficient Credit",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

403 No access - No permission to process this request shared error response

{
    "message": "No access",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

429 Rate limited - The request rate limit has been reached shared error response

{
    "message": "Rate limited",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

5XX Internal error - Internal system error shared error response

{
    "message": "Internal error",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}