REST API: Accounts/HistoricPlaces

GET, POST, DELETE Favorite or completed historic places for a specific account

Resource URI

Accounts/11892944/HistoricPlaces/

Resource Properties

Error Responses

HTTP GET

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP POST

POST historic place favorite or completed for account

JSON Request:

{
"expireDate": "",
"relation": "FAV",
"relationDate": "2021-05-09 09:54:59Z",
"historicPlaceID": "11892925"
}

JSON Response:

true

XML Request:

XML Response:

HTTP PUT

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP DELETE

DELETE - remove historic place for a specific account from their favorited or completed list

JSON Request:

JSON Response:

true

XML Request:

XML Response:


REST API: Accounts/HistoricPlaces Set

GET list of historic places for a specific account. Must use relation={FAV' or 'CMP'} to show which list will be displayed.

Resource URI

Accounts/11892944/HistoricPlaces/?relation={}

Set Filters

ParameterFormatDescriptionAllows Null
expireDate Date Expire date yes
historicPlaceID int Historic Place ID no
relation string Either FAV for favorite or CMP for completed historic place no
relationDate Date Date relation was added no

HTTP GET

GET a list of historic places

JSON Request:

JSON Response:

[
{
"expireDate": "",
"historicPlaceID": 11892924,
"relation": "FAV",
"relationDate": ""
},
{
"expireDate": "",
"historicPlaceID": 11892925,
"relation": "FAV",
"relationDate": "2021-05-09 13:54:59Z"
}
]

XML Request:

XML Response:

HTTP POST

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP PUT

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP DELETE

N/A

JSON Request:

JSON Response:

XML Request:

XML Response: