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"
    }
  }
}
JavaScript


"json_request" element 

Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeapi
requestmethodTest


"details" element 


Field NameDescription
somethingFor "content" child parameter, user can leave the default value or enter their own valid json value

 

Successful Response:


"response" element


Field NameDescription
statusWill return "SUCCESS" if the call was successful
data(See example below)


Example of successful call returned payload:



Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageDependent of reason for failure