The primary purpose of this call is to allow the user to retrieve all ACTIVE journeys found for the specified user ID. 


JSON Request Example


{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Journeys",
  "requestmethod": "ChangeJourneyStatus",
  "details": {
    "user": "{*user_id*}"
  }
}


Null

"json_request" element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeJourneys
requestmethodGetJourneys


"details" element


Field Name
user
(Required)
User ID 


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if the journey(s) has been successfully retrieved.
data: journeys (in array format)id: the ID of each journey found to "belong" to the specified user ID.
name: the name of the journey associated the respective journey ID.
ownerid
listid: list each respective journey ID is associated with.


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed