Allows the user to test that their API user token is up to date and active. This call is usually used when a new user is doing initial tests with Pinpointe's API stack or has requested a new API token. No element parameter values required in <details> section.


JSON Request Example:  


{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Authentication",
  "requestmethod": "APITest",
  "details": {
    /* no parameters */
  }
}


"json_request" element  

Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeAuthentication
requestmethodAPITest


"details" element 

Please note: There are no required element inputs to run this call.   


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if call was successful
dataUser ID number and name


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageUnable to verify user credentials