Version 1.0

deprecated
Base Information
Auth
Rate Limits
Root
References
Sandbox
Validation
Distribution Lists
Subscribers
Expand All Collapse All

Sandbox


Test GET method

GET /sandbox

Test GET method

Output parameters are just for example.

Example Request URL:
https://api.clevermonitor.com/v1.0/sandbox
Response Messages:
Code Status Example Body
200 OK 
{
    "message": "GET command was ok!"
}
Test POST method

POST /sandbox

Test POST method

Output parameters are just for example.

Request Parameters:
Name Example Value Default Value Description Type Data Type Required
body 
{
    "name": "John",
    "number": "12345"
}
 		Test input body json {name: string, number: numeric}
Example Request URL:
https://api.clevermonitor.com/v1.0/sandbox
Response Messages:
Code Status Example Body
201 Created 
{
    "message": "POST command was ok!",
    "name": "John",
    "number": "12345"
}
422 Unprocessable Entity 
{
    "code": 422,
    "status": "error",
    "message": "Validation Failed: Set parameter 'name'!",
    "errors": [
        {
            "field": "name",
            "message": "Set parameter 'name'!",
            "code": 0
        },
        {
            "field": "number",
            "message": "Parameter 'number' must be numeric!",
            "code": 0
        },
        {
            "field": "number",
            "message": "Set parameter 'number'!",
            "code": 0
        }
    ]
}
Test PUT method

PUT /sandbox/{id}

Test PUT method

Output parameters are just for example.

Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id 
12
 		Modifed record ID path integer
body 
{
    "name": "John",
    "number": "12345"
}
 		Test input body json {name: string, number: numeric}
Example Request URL:
https://api.clevermonitor.com/v1.0/sandbox/12
Response Messages:
Code Status Example Body
200 OK 
{
    "message": "PUT command was ok!",
    "updated_record_id": "12",
    "data": {
        "name": "John",
        "number": "12345"
    }
}
422 Unprocessable Entity 
{
    "code": 422,
    "status": "error",
    "message": "Set ID!"
}
422 Unprocessable Entity 
{
    "code": 422,
    "status": "error",
    "message": "Validation Failed: Set parameter 'name'!",
    "errors": [
        {
            "field": "name",
            "message": "Set parameter 'name'!",
            "code": 0
        },
        {
            "field": "number",
            "message": "Parameter 'number' must be numeric!",
            "code": 0
        },
        {
            "field": "number",
            "message": "Set parameter 'number'!",
            "code": 0
        }
    ]
}
Test PATCH method

PATCH /sandbox/{id}

Test PATCH method

Output parameters are just for example.

Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id 
12
 		Modifed record ID path integer
body 
{
    "name": "John",
    "number": "12345"
}
 		Test input body json {name: string, number: numeric}
Example Request URL:
https://api.clevermonitor.com/v1.0/sandbox/12
Response Messages:
Code Status Example Body
200 OK 
{
    "message": "PUT command was ok!",
    "updated_record_id": "12",
    "data": {
        "name": "John",
        "number": "12345"
    }
}
422 Unprocessable Entity 
{
    "code": 422,
    "status": "error",
    "message": "Set ID!"
}
422 Unprocessable Entity 
{
    "code": 422,
    "status": "error",
    "message": "Validation Failed: Set parameter 'name'!",
    "errors": [
        {
            "field": "name",
            "message": "Set parameter 'name'!",
            "code": 0
        },
        {
            "field": "number",
            "message": "Parameter 'number' must be numeric!",
            "code": 0
        },
        {
            "field": "number",
            "message": "Set parameter 'number'!",
            "code": 0
        }
    ]
}
Test DELETE method

DELETE /sandbox/{id}

Test DELETE method

Output parameters are just for example.

Request Parameters:
Name Example Value Default Value Description Type Data Type Required
id 
12
 		Deleted record ID path integer
Example Request URL:
https://api.clevermonitor.com/v1.0/sandbox/12
Response Messages:
Code Status Example Body
200 OK 
{
    "message": "DELETE command was ok!",
    "deleted_record_id": "12"
}
422 Unprocessable Entity 
{
    "code": 422,
    "status": "error",
    "message": "Set ID!"
}
Copyright © CleverMonitor, 2018