A simple call to verify the user can connect to Pinpointe's endpoint.
JSON Request Example:
{
"username": "john.doe",
"usertoken": "abc123abc123abc123abc123abc123",
"requesttype": "API",
"requestmethod": "Test",
"details": {
"something": {
"content": "any valid json -- returned in response"
}
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | api |
| requestmethod | Test |
"details" element
| Field Name | Description |
| something | For "content" child parameter, user can leave the default value or enter their own valid json value |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return "SUCCESS" if the call was successful |
| data | (See example below) |
Example of successful call returned payload:
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Dependent of reason for failure |