Amenities
Create Amenity
POST
/v1/amenities
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
"payload": {
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
}
Response
{
"result": {
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
}
Delete Amenity by UUID
DELETE
/v1/amenities/{uuid}
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
Empty
Response
Empty response
List Amenities
GET
/v1/data/amenities
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Query params:
Param | Description |
---|---|
page_size | Number value that represents number of returned results. |
current_page | Number value that represents offset of returned results |
uuid | Uuid of the amenity |
Request
Empty
Response
{
"total_records": "1",
"results": [
{
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
]
}
List single Amenity
GET
GET /v1/data/amenities/{uuid}
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
Update Amenity
PUT
PUT /v1/amenities/{uuid}
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
"payload": {
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
}
Response
{
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
Upsert Amenities
POST
/v1/amenities/upsert
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
"payload": {
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
}
Response
{
"result": {
"uuid": "24d5051c-52fc-454f-aeee-7d5c61d1edf4",
"id": 3,
"uuidCopiedFrom": "",
"moduleFor": "",
"moduleId": "",
"details": "",
"url": "",
"promoCode": "",
"milesFromTourney": 0,
"venue": "",
"streetAddress": "",
"countryId": 1,
"stateId": 1,
"city": "test",
"zip": "",
"latitude": "",
"longitude": "",
"dateCreated": "2023-09-11T19:28:58.244013984Z",
"createdByFullName": "",
"dateUpdated": "2023-09-11T19:28:58.244013984Z",
"updatedByFullName": "",
"dateDisabled": "2023-09-11T19:28:58.244013984Z",
"disabledByFullName": ""
}
}