Operations related to User's custom guidebooks. OAuth required. GET is used to get the current guidebooks to view and download.
POST used to create new custom routes on new guidebook. PUT is used to edit existing guidebooks.
Resource URI
/Accounts/7440532/Guidebooks/1234
Resource Properties
| Parameter | Format | Description | Allows Null |
|---|
| acctID |
long |
User account ID |
no |
| guidebookID |
string |
Guidebook ID |
no |
| guidebookName |
string |
Guidebook Name |
no |
| createDate |
date |
Creation date of Guidebook |
no |
Error Responses
HTTP GET
Returns guidebooks created by user if any. OAuth required
JSON Request:
{
"acctID": 9317004,
"createDate": "2018-12-11 19:54:23Z",
"guidebookID": 32261,
"guidebookName": "Guidebook test2"
}
JSON Response:
XML Request:
XML Response:
HTTP POST
Creates guidebook where user chooses trails to add.
JSON Request:
{
"acctID": 9317004,
"createDate": "2017-03-29 13:48:46Z",
"guidebookID": 999999,
"guidebookName": "Guidebook test2"
}
JSON Response:
1234
XML Request:
XML Response:
HTTP PUT
Allows user to edit specific guidebook
JSON Request:
JSON Response:
XML Request:
XML Response:
HTTP DELETE
Deletes an existing guidebook created by user.
JSON Request:
{
"acctID": 9317004,
"guidebookID": 999999
}
JSON Response:
XML Request:
true
XML Response:
REST API: Accounts/Guidebooks Set
Guidebooks featuring existing trails created by user
Resource URI
Accounts/7440532/Guidebooks/
Set Filters
| Parameter | Format | Description | Allows Null |
|---|
| acctID |
long |
User account ID |
no |
| guidebookID |
string |
Guidebook ID |
no |
| guidebookName |
string |
Guidebook Name |
no |
| createDate |
date |
Creation date of Guidebook |
no
|
HTTP GET
Gets all guidebooks related to user
JSON Request:
[
{
"acctID": 9317004,
"createDate": "2017-03-29 13:48:46Z",
"guidebookID": 23664,
"guidebookName": "Guidebook test1"
},
{
"acctID": 9317004,
"createDate": "2018-12-11 19:54:23Z",
"guidebookID": 32261,
"guidebookName": "Guidebook test2"
}
]
JSON Response:
XML Request:
Body empty
XML Response:
HTTP POST
Create new guidebook
JSON Request:
JSON Response:
XML Request:
XML Response:
HTTP PUT
Body empty
JSON Request:
JSON Response:
XML Request:
XML Response:
HTTP DELETE
Deletes existing guidebook from list
JSON Request:
{
"acctID": 9317004,
"guidebookID": 29841
}
JSON Response:
true
XML Request:
XML Response: