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
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Journeys |
requestmethod | GetJourneys |
"details" element
Field Name | |
user (Required) | User ID |
Successful Response:
"response" element
Field Name | Description |
status | Will 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 Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |