portfolio API reference | AppointmentTrader

Search all endpoints

/v1/portfolio/

Manages all portfolio related functions

GET

/v1/portfolio/get_last_order_list_id

Returns the order list that has been used last by the api user

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_last_order_list_id' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_get_last_order_list_id_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_last_order_list_id",
    "RequestUserAlias": "example-user",
    "Payload": "00000000-0000-4000-8000-000000900001"
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_listings

Returns all listings in the users portfolio.

Parameters

Name	Type	Required	Default	Description
`getPopularityScoreBracket`	`bool`	`No`	`false`	if true, the popularity score for all listings will be returned
`dateTimeRangeStart`	`string`	`No`	`""`	Time Range Start Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS
`dateTimeRangeEnd`	`string`	`No`	`""`	Time Range End Date, will be ignored if empty format: YYYY-MM-DD HH:MM:SS

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_listings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'getPopularityScoreBracket={{getPopularityScoreBracket}}' \
  --data-urlencode 'dateTimeRangeStart={{dateTimeRangeStart}}' \
  --data-urlencode 'dateTimeRangeEnd={{dateTimeRangeEnd}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_get_listings_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.Name`	`= "Portfolio Listing Items"`	`Yes`
`$.oneOf[0].allOf[1].Payload.MetaInformation`	`= []`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].Name`	`string ["AppointmentDrafts","ApprovedAppointments","PrivateAppointments","UnlockedAppointments","SubmittedListings_Rejections","SubmittedListings_InReview","SubmittedListings_WaitingForReview"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].MetaInformation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].MetaInformation.ListingCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingID`	`string \| null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingRespondByTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingRespondByTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingRespondByTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationCitySlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationCitySlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].locationCitySlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].creatorUserAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].creatorUserAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].creatorUserAlias.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeName`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].inventoryTypeName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStartHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStartHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStartHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingCurrentAskingPrice`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingCurrentAskingPrice.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingCurrentAskingPrice.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].bid-communityPostID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingDetailStatement`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingStatus`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPublicConfirmationNumber`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].orderListID`		`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].orderListID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].orderListID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket`		`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket.anyOf[0]`	`number`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket.anyOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingPopularityScoreBracket.anyOf[2]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsOneDay`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsOneDay.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsOneDay.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsAllTime`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsAllTime.oneOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueList[].listingViewsAllTime.oneOf[1]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.KeyValueList[].KeyValueFieldList[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.KeyValueFieldList`	`= []`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_listings",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Name": "Portfolio Listing Items",
        "MetaInformation": [],
        "KeyValueList": [],
        "KeyValueFieldList": []
    }
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_my_appointments_grouped_by_city

Returns the authenticated viewer's appointments grouped by city, with separate counts for upcoming (Date >= today) and past (Date < today) rows. Powers the v2 sidebar's "My Bookings" block. Each group carries the city's IATA-style group code, display name, and emoji from ATAirport (joined via ATLocation.ATAirport_CityGroupCode, which is a denormalized cache column on ATLocation — no extra join to ATAirport in the count query). Filters applied (always): - CurrentOwner-ATUser_ID = the authenticated viewer (self-only; no peer-user param by design). - DeletedDate IS NULL on ATAppointment and ATLocation. - Status is one of the active My Bookings appointment states returned by Appointment::GetMyPlansAppointmentStatuses(). - ATAirport_CityGroupCode populated (rows without a city are dropped silently — they cannot be grouped meaningfully). Sort: groups are returned in the requested order. "upcoming" puts cities with the most upcoming appointments first (ties broken by total count). "name" sorts alphabetically by city display name.

Parameters

Name	Type	Required	Default	Description
`sortBy`	`string`	`No`	`"upcoming"`	Sort mode: "upcoming" (default) or "name".

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_my_appointments_grouped_by_city' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sortBy={{sortBy}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_get_my_appointments_grouped_by_city_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload[].cityCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].cityName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].emoji`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].citySlug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].upcomingCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].pastCount`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_my_appointments_grouped_by_city",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_my_calendar_items

Returns every time-bound item belonging to the viewer that falls in the window [from, to], normalized into the CalendarItem shape consumed by /modules/v2/travel_plans/?view=calendar. P1 covers bids and appointments — the two types backed by an existing per-user fetcher. Location events, transactions, livestreams and contract deadlines plug in as additional foreach-blocks once their helpers exist (see CALENDAR_DESIGN.md §5).

Parameters

Name	Type	Required	Default	Description
`from`	`string`	`Yes`	`—`	inclusive lower bound, format YYYY-MM-DD
`to`	`string`	`Yes`	`—`	inclusive upper bound, format YYYY-MM-DD
`types`	`array`	`No`	`[]`	optional allowlist of item types, e.g. ['listing','bid','appointment','sold']
`limit`	`int`	`No`	`500`	cap on total items returned after merge

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_my_calendar_items' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'from={{from}}' \
  --data-urlencode 'to={{to}}' \
  --data-urlencode 'types={{types}}' \
  --data-urlencode 'limit={{limit}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: types

Field	Type	Required	Description
`types`	`string (application/json)`	`No`	JSON-encoded array. Empty includes every implemented source. event, transaction, livestream and contract currently return no items.
`types`	`array (decoded JSON)`	`No`
`types[]`	`string ["listing","bid","appointment","sold","event","transaction","livestream","contract"]`	`No`

Response fields

Field	Type	Required
`$`	`portfolio_get_my_calendar_items_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[]`	`MyCalendarItem`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].startDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].endDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].colorToken`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].startTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].startTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].startTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].endTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].endTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].endTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].isAllDay`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].location`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].location.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].sourceID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].type`	`= "bid"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].status`	`= "pending"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].ownerRole`	`= "buyer"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].discussionPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].discussionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].startDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].endDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].colorToken`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].startTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].startTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].startTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].endTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].endTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].endTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].isAllDay`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].sourceID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].type`	`string ["appointment","listing"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].status`	`string ["confirmed","listed"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].ownerRole`	`string ["owner","shared"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].listingID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].hint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].id`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].startDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].endDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].colorToken`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].startTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].startTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].startTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].endTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].endTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].endTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].isAllDay`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].location`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].location.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].sourceID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].type`	`= "sold"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].status`	`= "sold"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].ownerRole`	`= "seller"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].saleType`	`string ["request_filled","listing_sold"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].transactionID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].amountLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].hint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].buyerIdentityHidden`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].buyerIdentityHiddenUntil`		`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].buyerIdentityHiddenUntil.anyOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].buyerIdentityHiddenUntil.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.meta`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.from`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.to`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.listing`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.bid`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.appointment`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.sold`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.event`	`= 0`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.transaction`	`= 0`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.livestream`	`= 0`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.counts.contract`	`= 0`	`Yes`
`$.oneOf[0].allOf[1].Payload.meta.generatedAt`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_my_calendar_items",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "meta": {
            "from": "synthetic-example",
            "to": "synthetic-example",
            "counts": {
                "listing": 0,
                "bid": 0,
                "appointment": 0,
                "sold": 0,
                "event": 0,
                "transaction": 0,
                "livestream": 0,
                "contract": 0
            },
            "generatedAt": "synthetic-example"
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_my_travel_plan_archived

Archived travel plans for the v2 "My Bookings" archive view. Returns a newest-first list of the viewer's archived appointments, each carrying the city payload used by the normal My Bookings landing page.

Parameters

Name	Type	Required	Default	Description
`limit`	`int`	`No`	`25`	Maximum archived plans to include.
`offset`	`int`	`No`	`0`	Number of archived plans to skip.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_my_travel_plan_archived' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'limit={{limit}}' \
  --data-urlencode 'offset={{offset}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_get_my_travel_plan_archived_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].kind`	`= "appointment"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].sortDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ListingUUID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ListingUUID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ListingUUID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.RespondByTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.RespondByTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.RespondByTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationInventoryType_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationInventoryType_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationInventoryType_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Time`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Cache-StartHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.Cache-StartHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Cache-StartHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Status`	`= "Archived"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Creator-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.Creator-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Creator-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Cache-CurrentAskingPrice`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.Cache-CurrentAskingPrice.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Cache-CurrentAskingPrice.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.TransferType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.AccessCode`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.AccessCode.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.AccessCode.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.CurrentOwner-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.CurrentOwner-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.CurrentOwner-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LastTransferServiceFee-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LatestTransfer-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.SellerCustomerChat-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.NoShow-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.NoShow-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.NoShow-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.NoShow-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.NoShow-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Refund-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Timezone`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_CloseByCitySlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_CloseByCitySlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_CloseByCitySlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_City`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_CityGroupCode`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_CityGroupCode.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocation_CityGroupCode.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_AppointmentTypeDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.AppointmentDescriptor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_AllowTransferServiceAddOn`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_AllowTransferServiceAddOn.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_AllowTransferServiceAddOn.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_TimeRangeUnit`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_StandardTransferFeeBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_StandardTransferFeeBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_StandardTransferFeeBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_LegacyTransferServiceFeeBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_LegacyTransferServiceFeeBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationCategory_LegacyTransferServiceFeeBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationInventoryType_Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationInventoryType_Name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATLocationInventoryType_Name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Headcount`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Headcount.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.Headcount.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Headcount.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Headcount.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Price`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Price.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.items[].data.Price.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Price.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.Price.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATOrderLists_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATOrderLists_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATOrderLists_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATOrderLists_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATOrderLists_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATTransaction_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATTransaction_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATTransaction_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATTransaction_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATTransaction_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATBids_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATBids_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATBids_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATBids_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATBids_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATDiscussionPosts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].data.ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.ATDiscussionPosts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.MyPlansAccessRole`	`string ["owner","shared"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.DetailStatement`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.DetailStatement.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.DetailStatement.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.lastListedPriceHistoryID`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.items[].data.lastListedAmountCents`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.items[].data.lastListedAmountLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.items[].data.lastListedAt`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.items[].data.lastListedDateLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.items[].data.MyPlansArchivedDate`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.MyPlansArchivedDate.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].data.MyPlansArchivedDate.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.emoji`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.emoji.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.emoji.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].city.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.page`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.page.limit`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.page.offset`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.page.returned`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.page.hasMore`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.page.nextOffset`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_my_travel_plan_archived",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "page": {
            "limit": 1,
            "offset": 0,
            "returned": 0,
            "hasMore": false,
            "nextOffset": 0
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_my_travel_plan_detail

Per-city travel plan detail — the v2 city detail page's data source. Returns the city's display data plus the viewer's appointments and active bids in that city. Appointment windows: upcoming = from two calendar days ago onward, past = before today, archived = archived plans. The recent cutoff uses the app timezone; approved reservations retain their existing 48-hour visibility rule. Active bids and seller-sold reservations retain their existing current/future windows. Locked reservation rows expose safe relisting metadata in reservationActions; reservationDetail remains false to protect booking details and exact time. Both lists are returned in the row shape that templates/portfolio/ _card_appointment.html and _card_active_bid.html expect, so the v2 page can call those partials directly with no field translation. Scale: per-user row counts are small. Both legacy library calls (`Bids::GetBidsByUserID`, `Appointment::GetAppointmentsByUserID`) scan only the user's rows; the per-city + per-window filter runs in PHP. Hard-capped at 200 rows per source.

Parameters

Name	Type	Required	Default	Description
`cityCode`	`string`	`Yes`	`—`	IATA-style city group code (e.g. 'NYC').
`window`	`string`	`No`	`"upcoming"`	'upcoming' (default), 'past', or 'archived'.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_my_travel_plan_detail' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'cityCode={{cityCode}}' \
  --data-urlencode 'window={{window}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_get_my_travel_plan_detail_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.city.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.city.emoji`		`Yes`
`$.oneOf[0].allOf[1].Payload.city.emoji.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.city.emoji.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.city.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.city.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ListingUUID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ListingUUID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ListingUUID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].RespondByTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].RespondByTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].RespondByTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationInventoryType_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationInventoryType_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationInventoryType_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Time`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Cache-StartHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].Cache-StartHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Cache-StartHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Creator-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].Creator-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Creator-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Cache-CurrentAskingPrice`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].Cache-CurrentAskingPrice.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Cache-CurrentAskingPrice.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].TransferType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].AccessCode`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].AccessCode.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].AccessCode.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].CurrentOwner-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].CurrentOwner-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].CurrentOwner-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LastTransferServiceFee-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LastTransferServiceFee-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LatestTransfer-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].SellerCustomerChat-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].NoShow-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].NoShow-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].NoShow-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].NoShow-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].NoShow-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Refund-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Timezone`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_CloseByCitySlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_CloseByCitySlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_CloseByCitySlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_City`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_CityGroupCode`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_CityGroupCode.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocation_CityGroupCode.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_AppointmentTypeDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].AppointmentDescriptor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_AllowTransferServiceAddOn`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_AllowTransferServiceAddOn.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_AllowTransferServiceAddOn.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_TimeRangeUnit`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_StandardTransferFeeBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_StandardTransferFeeBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_StandardTransferFeeBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_LegacyTransferServiceFeeBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_LegacyTransferServiceFeeBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationCategory_LegacyTransferServiceFeeBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationInventoryType_Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationInventoryType_Name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATLocationInventoryType_Name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Headcount`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Headcount.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].Headcount.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Headcount.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Headcount.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Price`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Price.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.appointments[].Price.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Price.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].Price.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATOrderLists_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATOrderLists_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATOrderLists_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATOrderLists_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATOrderLists_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATTransaction_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATTransaction_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATTransaction_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATTransaction_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATTransaction_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATBids_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATBids_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATBids_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATBids_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATBids_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATDiscussionPosts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.appointments[].ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].ATDiscussionPosts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].MyPlansAccessRole`	`string ["owner","shared"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].DetailStatement`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].DetailStatement.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].DetailStatement.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].lastListedPriceHistoryID`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].lastListedAmountCents`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].lastListedAmountLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].lastListedAt`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].lastListedDateLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].mode`	`= "detail"`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].customerSurveys`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].customerSurveys.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].customerSurveys.anyOf[0].total`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].customerSurveys.anyOf[0].submitted`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].customerSurveys.anyOf[0].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].customerSurveys.anyOf[0].transactionID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].customerSurveys.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.role`	`string ["owner","shared","reviewer","guest","transfer-agent","submission"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.canViewFull`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.isOwner`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.isSharedGuest`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.isReviewer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.isUnlockedDetail`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.authorizedByShareCode`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].access.readOnly`	`= true`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.address`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.googleMapsURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.cityLine`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.timezone`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].location.imageURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.refundStatusLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.descriptor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.inventoryName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.time`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.dateTimeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.partySizeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.checkInName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.email`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.phone`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.detailStatement`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.purchaseSummary`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.purchaseAmountFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.status`	`string ["Draft","Submitted","In Review","Rejected","Private","Unlocked","Approved","Refunded","Transfer Requested","Transfer Failed","Transfer Failed But Unlocked","Standard Failed","Archived","In Transfer"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.headcount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.customFields`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.customFields[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.customFields[].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.customFields[].label`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.customFields[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.customFields[].type`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.customFields[].value`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].reservation.isPast`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].people`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].people.ownerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].people.creatorAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests`	`ReservationGuests`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].shareURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].headcount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].confirmedCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].pendingSlots`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].items`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].items[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].items[].kind`	`string ["owner","shared"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].items[].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].items[].alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].items[].status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].guests.anyOf[1].items[].lastSeenLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review`	`ReservationReview`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[0]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[1].canReview`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[1].isActive`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].revision`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].canReview`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].isActive`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].needsBegin`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].isInProgress`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].isSelfReview`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].reviewRewardEligible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].reviewRewardPoints`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].askingPriceSmallestUnit`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].reviewRewardFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].askingPriceFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].question`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].respondByDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].respondByTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].respondByLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].legacyReviewURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].bid`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].bid.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].bid.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].bid.anyOf[0].amountFormatted`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].bid.anyOf[0].discussionURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].bid.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].history`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].history[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].history[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].history[].status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].history[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].history[].descriptionHTML`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].review.anyOf[2].history[].reviewerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions`	`ReservationActions`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].shareURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addTransferServiceCheckoutURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addTransferServicePriceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addTransferServiceLocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addTransferServiceInventoryName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addTransferServiceDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addTransferServiceTimeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reportProblemURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].refundChatURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].refundChatV2URL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].sellerChatURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].sellerChatV2URL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].absoluteShareURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addServiceAppointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addTransferServicePriceSmallestUnit`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].refundChatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].sellerChatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].addServiceAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].manageAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reportInfractionAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.visible`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.requestAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.cancelAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.isRequested`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.isInTransfer`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.isCompleted`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.isFailed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.type`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.listingUUID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.currentName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.requestedName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.requestedGivenName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.requestedFamilyName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.requestedByAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.requestedAt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.requestEndpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].transferService.cancelEndpoint`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].reviewRequestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetLocationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetType`	`string ["user","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetRole`	`string ["buyer","seller","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].count`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].intent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].callback`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].unitLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPost`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].routingEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[0].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].selectedBoard.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetDisplayName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].subtitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].prompt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].ctaLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].targetProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].completedPostURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[0].viewURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].reviewRequest.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0]`	`LocationReviewAction`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].reviewRequestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetLocationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetType`	`string ["user","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetRole`	`string ["buyer","seller","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].count`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].intent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].callback`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].unitLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].createsRegularBoardPost`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultRequestBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].isDefaultListingBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].routingEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[0].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].selectedBoard.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetDisplayName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].subtitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].prompt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].ctaLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].targetProfileURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].completedPostURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[0].viewURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].reviewRequestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetLocationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetType`	`string ["user","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetRole`	`string ["buyer","seller","location"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard`		`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].id`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].count`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].intent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].callback`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].unitLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].createsRegularBoardPost`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultRequestBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].isDefaultListingBoard`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].routingEnabled`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[0].selected`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].selectedBoard.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].targetDisplayName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].subtitle`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].prompt`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].ctaLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[0].anyOf[1].completed`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].locationReview.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellEndpoint`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellListingID`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellLocationName`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellInventoryName`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellDateLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellTimeLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellAppointmentID`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellCurrentPriceSmallestUnit`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellMinPrice`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellMaxPrice`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellTransferFeeBasisPoints`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellRequiresReview`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellSelfReviewAvailable`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellRelistOriginal`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellSameDayOffers`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellSameDayOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellSameDayOffers[].timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellSameDayOffers[].priceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[0].resellSameDayOffers[].inventoryType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].actions.anyOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].copy`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].copy.title`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[0].copy.description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationDetail.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellAvailable`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellEndpoint`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellListingID`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellLocationName`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellInventoryName`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellDateLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellTimeLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellAppointmentID`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellCurrentPriceSmallestUnit`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellMinPrice`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellMaxPrice`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellTransferFeeBasisPoints`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellRequiresReview`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellSelfReviewAvailable`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellRelistOriginal`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellSameDayOffers`	`array`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellSameDayOffers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellSameDayOffers[].timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellSameDayOffers[].priceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].reservationActions.resellSameDayOffers[].inventoryType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.isShared`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.sharePlanAttachmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState`	`SharedPlanJoinState`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[0].status`	`= "Unavailable"`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[0].canRequest`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[0].canManage`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].status`	`string ["Unavailable","Host","Joined","Pending","Accepted","Declined","None"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].canRequest`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].canManage`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].pendingCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].joiningCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].requestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].planURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.joinState.anyOf[1].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.postID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.postURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.shareAttendees`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.boardName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointments[].sharePlan.boardURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.listings[].listingID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].outlineColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].hoverColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].inventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].priceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].priceCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].status`	`= "Approved"`	`Yes`
`$.oneOf[0].allOf[1].Payload.listings[].canEditListing`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.soldItems[].saleTypeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].locationURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].inventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].time`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].amountLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].soldDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].soldDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].buyerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].transactionID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].buyerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].kind`	`= "sold"`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].saleType`	`string ["request_filled","listing_sold"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.soldItems[].buyerIdentityHidden`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.soldItems[].buyerIdentityHiddenUntil`		`No`
`$.oneOf[0].allOf[1].Payload.soldItems[].buyerIdentityHiddenUntil.anyOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.soldItems[].buyerIdentityHiddenUntil.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.bids`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.bids[].ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Amount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].Amount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Amount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].StartDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].EndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].StartTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].EndTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATDiscussionPosts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATDiscussionPosts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationCustomSearchRequests_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationCustomSearchRequests_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationCustomSearchRequests_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationCustomSearchRequests_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationCustomSearchRequests_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationName`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationPhoneNumber`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationPhoneNumber.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationPhoneNumber.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationEmailAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationEmailAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ReservationEmailAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-StartHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].Cache-StartHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-StartHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-EndHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].Cache-EndHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-EndHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].IsPremium`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].IsPremium.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].IsPremium.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATAppointment_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATAppointment_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ATAppointment_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATAppointment_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATAppointment_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Seller-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Seller-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Seller-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Seller-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Seller-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Buyer-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Buyer-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Cache-Buyer-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Seller-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Seller-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].Seller-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Seller-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Seller-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Buyer-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Buyer-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].Buyer-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Buyer-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Buyer-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATTransaction_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ATTransaction_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATTransaction_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Price`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Price.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.bids[].Price.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Price.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].Price.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_CloseByCitySlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_CloseByCitySlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_CloseByCitySlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocation_City`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationCategory_AppointmentTypeDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationCategory_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_Name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].ATLocationInventoryType_Name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].CustomSearchRequestText`		`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].CustomSearchRequestText.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].CustomSearchRequestText.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.bids[].textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.dateRange`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.dateRange.earliest`		`Yes`
`$.oneOf[0].allOf[1].Payload.dateRange.earliest.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.dateRange.earliest.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.dateRange.latest`		`Yes`
`$.oneOf[0].allOf[1].Payload.dateRange.latest.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.dateRange.latest.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.window`	`string ["upcoming","past","archived"]`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_my_travel_plan_detail",
    "RequestUserAlias": "example-user",
    "Payload": {
        "city": {
            "code": "synthetic-example",
            "name": "synthetic-example",
            "emoji": "synthetic-example",
            "slug": "synthetic-example",
            "imageURL256": "synthetic-example",
            "imageURL512": "synthetic-example"
        },
        "appointments": [],
        "listings": [],
        "soldItems": [],
        "bids": [],
        "dateRange": {
            "earliest": "synthetic-example",
            "latest": "synthetic-example"
        },
        "window": "upcoming"
    }
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_my_travel_plan_upcoming

Travel plans by time window — the v2 "My Bookings" landing page data. Returns a flat chronological list of the viewer's recent and upcoming appointments/listings, plus active bids and upcoming seller-sold sales through the next $days, each carrying the city it belongs to so the SSR view can group-render by city. With window=past, returns reservations and listings dated before today, newest first, with no historical start cutoff. Archived plans are separate. Per-user bounded; at most 500 appointments, 500 upcoming seller sales, and 200 active bids. Past includes only the appointment source. Past horizon starts at null and ends yesterday. The default upcoming window starts two calendar days ago in the app timezone and retains its future horizon. Approved reservations retain their existing 48-hour visibility rule.

Parameters

Name	Type	Required	Default	Description
`days`	`int`	`No`	`365`	How many days into the future to include (1-1825); ignored for past.
`window`	`string`	`No`	`"upcoming"`	'upcoming' (default) or 'past'. Unrecognized values use upcoming.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_my_travel_plan_upcoming' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'days={{days}}' \
  --data-urlencode 'window={{window}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_get_my_travel_plan_upcoming_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[]`	`MyPlansOverviewItem`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].kind`	`= "appointment"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].sortDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ListingUUID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ListingUUID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ListingUUID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.RespondByTime`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.RespondByTime.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.RespondByTime.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationInventoryType_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationInventoryType_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationInventoryType_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Time`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Cache-StartHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Cache-StartHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Cache-StartHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Creator-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Creator-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Creator-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Cache-CurrentAskingPrice`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Cache-CurrentAskingPrice.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Cache-CurrentAskingPrice.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.TransferType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.AccessCode`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.AccessCode.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.AccessCode.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.CurrentOwner-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.CurrentOwner-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.CurrentOwner-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LastTransferServiceFee-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LastTransferServiceFee-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LatestTransfer-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LatestTransfer-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.SellerCustomerChat-ATNotificationIntelligentTags_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.SellerCustomerChat-ATNotificationIntelligentTags_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.NoShow-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.NoShow-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.NoShow-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.NoShow-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.NoShow-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Refund-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LocationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Timezone`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_CloseByCitySlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_CloseByCitySlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_CloseByCitySlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_City`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_CityGroupCode`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_CityGroupCode.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocation_CityGroupCode.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_AppointmentTypeDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.AppointmentDescriptor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_AllowTransferServiceAddOn`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_AllowTransferServiceAddOn.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_AllowTransferServiceAddOn.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_TimeRangeUnit`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_StandardTransferFeeBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_StandardTransferFeeBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_StandardTransferFeeBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_LegacyTransferServiceFeeBasisPoints`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_LegacyTransferServiceFeeBasisPoints.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationCategory_LegacyTransferServiceFeeBasisPoints.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationInventoryType_Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationInventoryType_Name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATLocationInventoryType_Name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Headcount`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Headcount.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Headcount.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Headcount.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Headcount.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Price`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Price.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Price.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Price.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.Price.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATOrderLists_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATOrderLists_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATOrderLists_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATOrderLists_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATOrderLists_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATTransaction_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATTransaction_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATTransaction_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATTransaction_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATTransaction_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATBids_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATBids_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATBids_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATBids_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATBids_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATDiscussionPosts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.ATDiscussionPosts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.MyPlansAccessRole`	`string ["owner","shared"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.CategoryReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.LocationReview-ATDiscussionBoards_ID_TraderPointsPerThread.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.DetailStatement`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.DetailStatement.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.DetailStatement.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.lastListedPriceHistoryID`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.lastListedAmountCents`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.lastListedAmountLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.lastListedAt`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].data.lastListedDateLabel`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.emoji`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.emoji.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.emoji.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].kind`	`= "listing"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].sortDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.listingID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.outlineColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.hoverColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.inventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.priceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.priceCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.status`	`= "Approved"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].data.canEditListing`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.emoji`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.emoji.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.emoji.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].city.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].kind`	`= "bid"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].sortDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.CreatedDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.LastUpdateDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Amount`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Amount.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Amount.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.StartDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.EndDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.StartTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.EndTime`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATDiscussionPosts_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATDiscussionPosts_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationCustomSearchRequests_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationCustomSearchRequests_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationCustomSearchRequests_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationCustomSearchRequests_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationCustomSearchRequests_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationName`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationName.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationName.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationPhoneNumber`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationPhoneNumber.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationPhoneNumber.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationEmailAddress`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationEmailAddress.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ReservationEmailAddress.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-StartHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-StartHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-StartHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-EndHour`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-EndHour.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-EndHour.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.IsPremium`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.IsPremium.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.IsPremium.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATAppointment_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATAppointment_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATAppointment_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATAppointment_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATAppointment_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Status`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Seller-ATUser_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Seller-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Seller-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Seller-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Seller-ATUser_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Buyer-ATUser_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Buyer-ATUser_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Cache-Buyer-ATUser_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Seller-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Seller-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Seller-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Seller-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Seller-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Buyer-ATAccountsLedger_ID`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Buyer-ATAccountsLedger_ID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Buyer-ATAccountsLedger_ID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Buyer-ATAccountsLedger_ID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Buyer-ATAccountsLedger_ID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATTransaction_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATTransaction_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATTransaction_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Price`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Price.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Price.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Price.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.Price.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_Alias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_ID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_ID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_ID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_CloseByCitySlug`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_CloseByCitySlug.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_CloseByCitySlug.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocation_City`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationCategory_AppointmentTypeDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationCategory_Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_Name`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_Name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.ATLocationInventoryType_Name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.CustomSearchRequestText`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.CustomSearchRequestText.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.CustomSearchRequestText.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].data.textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.emoji`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.emoji.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.emoji.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].city.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].kind`	`= "sold"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].sortDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.saleTypeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.locationName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.locationAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.locationURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.cityGroupCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.inventoryTypeName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.date`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.dateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.time`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.timeLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.amountLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.soldDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.soldDateLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.buyerAlias`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.imageUrl`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.primaryColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.textColor`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.transactionID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.bidID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.locationID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.amountCents`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.buyerUserID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.kind`	`= "sold"`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.saleType`	`string ["request_filled","listing_sold"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.buyerIdentityHidden`	`boolean`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.buyerIdentityHiddenUntil`		`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.buyerIdentityHiddenUntil.anyOf[0]`	`integer`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].data.buyerIdentityHiddenUntil.anyOf[1]`	`null`	`No`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.code`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.emoji`		`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.emoji.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.emoji.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.slug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.imageURL256`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].city.imageURL512`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.horizon`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.horizon.start`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.horizon.end`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_my_travel_plan_upcoming",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "horizon": {
            "start": "synthetic-example",
            "end": "synthetic-example"
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_my_travel_plans

Travel plans by city — the v2 sidebar's "My Bookings" data source. Returns one group per city the viewer has activity in, where activity is the union of: - My Bookings appointments owned by or shared with the viewer (ATAppointment.Status IN ('Approved','Private','Unlocked','In Transfer')). - Active bids placed by the viewer (ATTransaction.Status='PENDING' with a non-null ATBids_ID). - Upcoming reservations the viewer sold, sourced from completed ATTransaction rows where the viewer was the cached seller. Each group's `upcomingCount` / `pastCount` are the sum of appointment and bid counts; the per-source breakdown is also returned so the UI can render "2 trips · 3 bids" without another call. Scale: at hundreds of thousands of bids/appointments globally, both subqueries must seek by user-leading indexes: - ATAppointment(`CurrentOwner-ATUser_ID`) — singleton index. - ATTransaction(`Cache-Buyer-ATUser_ID`) — singleton index. The bid count runs against ATTransaction alone (no ATBids/ATLocation join) by reading the denormalized `Cache-ATAirport_CityGroupCode` column. Per-user row counts are small, so the post-seek filter and GROUP BY are cheap.

Parameters

Name	Type	Required	Default	Description
`sortBy`	`string`	`No`	`"upcoming"`	Sort mode: "upcoming" (default) or "name".

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_my_travel_plans' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sortBy={{sortBy}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_get_my_travel_plans_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload[].cityCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].cityName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].emoji`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].citySlug`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload[].upcomingCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].pastCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].upcomingAppointments`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].pastAppointments`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].upcomingBids`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].pastBids`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].upcomingSoldSales`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload[].pastSoldSales`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_my_travel_plans",
    "RequestUserAlias": "example-user",
    "Payload": []
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_order_list_items

Returns the order list items for $orderListID

Parameters

Name	Type	Required	Default	Description
`orderListID`	`string`	`No`	`""`	If parameter is not set or set to _last_, value of /v1/portfolio/get_last_order_list_id will be used
`addLinksInHumanReadableDescription`	`bool`	`No`	`false`	If this is parameter is set to true the return field humanReadableLineItemDescription will include hyperlinks
`pageSize`	`int`	`No`	`750`	Defines how many results will be return per request
`pageNumber`	`int`	`No`	`0`	Defines which page should be returned

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_order_list_items' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'orderListID={{orderListID}}' \
  --data-urlencode 'addLinksInHumanReadableDescription={{addLinksInHumanReadableDescription}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_get_order_list_items_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.numberLineItems`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.pageNumber`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.pageSize`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.orderListID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.orderListID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.orderListID.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.numberProposedTransactions`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalProposedTransactionsAmount`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].orderListItemID`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].orderListItemID.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].orderListItemID.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidQuantity`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidQuantity.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidQuantity.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidQuantity.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].bidQuantity.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].amount`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].amount.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].amount.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].amount.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].amount.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0]`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].inventoryTypeID.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].dateTimeRangeStart`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].dateTimeRangeStart.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].dateTimeRangeStart.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].dateTimeRangeEnd`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].dateTimeRangeEnd.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].dateTimeRangeEnd.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingID`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingID.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].listingID.anyOf[1]`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].individualAmount`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].individualAmount.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].individualAmount.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].individualAmount.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].individualAmount.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].grossAmount`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].grossAmount.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].grossAmount.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].grossAmount.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].grossAmount.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].humanReadableLineItemDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_order_list_items",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": {
                "numberLineItems": 0,
                "pageNumber": 0,
                "pageSize": 0,
                "orderListID": "synthetic-example",
                "numberProposedTransactions": 0,
                "totalProposedTransactionsAmount": 0
            },
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_order_lists

Returns all available orderlists

Parameters

Name	Type	Required	Default	Description
`pageSize`	`int`	`No`	`250`	Defines how many results will be return per request
`pageNumber`	`int`	`No`	`0`	Defines which page should be returned

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_order_lists' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_get_order_lists_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`		`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ATResponseObjectType`	`= "NestedKeyValueList"`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.MetaInformation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.MetaInformation.numberLineItems`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.MetaInformation.pageNumber`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.MetaInformation.pageSize`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[].orderListID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[].listName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[].listDescription`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[].numberListItems`	`DatabaseInteger`	`Yes`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[].numberListItems.oneOf[0]`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueList[].numberListItems.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.anyOf[0].ResponseBody.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.anyOf[1]`	`= false`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_order_lists",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": {
                "numberLineItems": 0,
                "pageNumber": 0,
                "pageSize": 0
            },
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}

Machine-readable endpoint documentation

GET

/v1/portfolio/get_valid_location_identifiers

Searches available location identifiers for purposes of creating a buy order

Parameters

Name	Type	Required	Default	Description
`searchFilter`	`string`	`No`	`""`	filter criteria
`pageSize`	`int`	`No`	`50`	Defines how many results will be return per request
`pageNumber`	`int`	`No`	`0`	Defines which page should be returned

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/portfolio/get_valid_location_identifiers' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_get_valid_location_identifiers_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].identifierCode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].identifierName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/get_valid_location_identifiers",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}

Machine-readable endpoint documentation

POST

/v1/portfolio/mint_calendar_feed_token

Returns the viewer's iCalendar subscription URL, minting a token on first call. Idempotent — subsequent calls return the same URL until the user explicitly revokes via set_revoke_calendar_feed_tokens. The URL is intentionally returned as plain HTTPS; clients flip the scheme to webcal:// when they want to trigger a system "Subscribe?" prompt (iOS Safari, macOS Mail). See CALENDAR_DESIGN.md §6.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/mint_calendar_feed_token' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_mint_calendar_feed_token_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.token`	`string`	`Yes`	Secret feed token. The all-zero example is a deliberately fake placeholder.
`$.oneOf[0].allOf[1].Payload.url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.webcal`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/mint_calendar_feed_token",
    "RequestUserAlias": "example-user",
    "Payload": {
        "token": "0000000000000000000000000000000000000000000000000000000000000000",
        "url": "https://example.com/modules/v2/travel_plans/feed.ics.php?token=0000000000000000000000000000000000000000000000000000000000000000",
        "webcal": "webcal://example.com/modules/v2/travel_plans/feed.ics.php?token=0000000000000000000000000000000000000000000000000000000000000000"
    }
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_archive_my_travel_plan

Archives an owned reservation from v2 My Bookings. Archived plans are hidden from the upcoming/past city tabs and collected under the Archived Plans view.

Parameters

Name	Type	Required	Default	Description
`appointmentID`	`int`	`Yes`	`—`	Appointment ID to archive.
`isWritingRequest`	`bool`	`No`	`false`	Required true to archive.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_archive_my_travel_plan' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'appointmentID={{appointmentID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_archive_my_travel_plan_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.status`	`= "Archived"`	`Yes`
`$.oneOf[0].allOf[1].Payload.alreadyArchived`	`boolean`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_archive_my_travel_plan",
    "RequestUserAlias": "example-user",
    "Payload": {
        "appointmentID": 0,
        "status": "Archived",
        "alreadyArchived": false
    }
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_bulk_bid_order

Create a Bulk Buy Order IN BETA - NOT YET FUNCTIONAL Placeholder only: with isWritingRequest=true the current implementation returns true without creating an order or placing bids.

Parameters

Name	Type	Required	Default	Description
`locationIdentifier`	`string`	`Yes`	`—`	Ticker Code or Codes of Location or Index
`inventoryTypeDesignator`	`string`	`Yes`	`—`	Inventory Type In case of a buy order for restaurants, a Table for 2 would be 2
`popularityScoreBracketRangeOrTimeRange`	`string`	`Yes`	`—`	PopularityScore Bracket Range The range of Popularity Score that is acceptable for this buy order A time window can be selected too, for larger orders popularity score is highly recommended
`noticeOrDateRange`	`string`	`Yes`	`—`	Notice Bracket or Date Range How far in the future from the bid date should the aquired listings be
`minimumUnitPriceUSD`	`string`	`Yes`	`—`	Minimum Unit Price in full USD
`maximumUnitPriceUSD`	`string`	`Yes`	`—`	Maximum Unit Price in full USD
`fundingAccountID`	`string`	`Yes`	`—`	Which account should be used to fund this buy order? Attention: Buy order will execute until total amount available in funding account is used or the order is cancelled. To recirculate earnings select same deposit and funding account.
`salesProceedsAccountID`	`string`	`Yes`	`—`	Which account should resale proceeds of this buy order be deposited to?
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_bulk_bid_order' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationIdentifier={{locationIdentifier}}' \
  --data-urlencode 'inventoryTypeDesignator={{inventoryTypeDesignator}}' \
  --data-urlencode 'popularityScoreBracketRangeOrTimeRange={{popularityScoreBracketRangeOrTimeRange}}' \
  --data-urlencode 'noticeOrDateRange={{noticeOrDateRange}}' \
  --data-urlencode 'minimumUnitPriceUSD={{minimumUnitPriceUSD}}' \
  --data-urlencode 'maximumUnitPriceUSD={{maximumUnitPriceUSD}}' \
  --data-urlencode 'fundingAccountID={{fundingAccountID}}' \
  --data-urlencode 'salesProceedsAccountID={{salesProceedsAccountID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_bulk_bid_order_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_bulk_bid_order",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_delete_order_list

Delete order list

Parameters

Name	Type	Required	Default	Description
`orderListID`	`string`	`Yes`	`—`	ID of the order list that should be deleted
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_delete_order_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'orderListID={{orderListID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_delete_order_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_delete_order_list",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_delete_order_list_item

Deletes an order list item

Parameters

Name	Type	Required	Default	Description
`orderListItemID`	`int`	`Yes`	`—`	ID of the order list item that should be deleted
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_delete_order_list_item' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'orderListItemID={{orderListItemID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_delete_order_list_item_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_delete_order_list_item",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_my_travel_plan_share_details

Updates or removes a community share for an owned My Bookings appointment.

Parameters

Name	Type	Required	Default	Description
`appointmentID`	`int`	`No`	`0`	ATAppointment.ID for the owned plan.
`postID`	`int`	`No`	`0`	Optional ATDiscussionPosts.ID for the existing shared plan post.
`shareAttendees`	`int`	`No`	`0`	1 to show AppointmentTrader guests on the public plan card, 0 to hide them.
`unshare`	`int`	`No`	`0`	1 to delete the shared plan post instead of saving detail changes.
`isWritingRequest`	`bool`	`No`	`false`	Required true to write.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_my_travel_plan_share_details' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'appointmentID={{appointmentID}}' \
  --data-urlencode 'postID={{postID}}' \
  --data-urlencode 'shareAttendees={{shareAttendees}}' \
  --data-urlencode 'unshare={{unshare}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_my_travel_plan_share_details_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan`		`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].isShared`	`= true`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].sharePlanAttachmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState`	`SharedPlanJoinState`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[0].status`	`= "Unavailable"`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[0].canRequest`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[0].canManage`	`= false`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].status`	`string ["Unavailable","Host","Joined","Pending","Accepted","Declined","None"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].canRequest`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].canManage`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].pendingCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].joiningCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].requestID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].planURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].joinState.anyOf[1].chatID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].postID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].postURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].shareAttendees`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].boardID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].boardName`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[0].boardURL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sharePlan.anyOf[1].isShared`	`boolean`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_my_travel_plan_share_details",
    "RequestUserAlias": "example-user",
    "Payload": {
        "appointmentID": 0,
        "sharePlan": {
            "isShared": true,
            "sharePlanAttachmentID": 0,
            "joinState": {
                "status": "Unavailable",
                "canRequest": false,
                "canManage": false
            },
            "appointmentID": 0,
            "postID": 0,
            "postURL": "synthetic-example",
            "shareAttendees": false,
            "boardID": 0,
            "boardName": "synthetic-example",
            "boardURL": "synthetic-example"
        }
    }
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_order_list

Create a new order list

Parameters

Name	Type	Required	Default	Description
`name`	`string`	`Yes`	`—`	Name of the new list
`description`	`string`	`No`	`""`	Short description of the new list
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_order_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'description={{description}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_order_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_order_list",
    "RequestUserAlias": "example-user",
    "Payload": "00000000-0000-4000-8000-000000900001"
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_order_list_item

Saves an order list item

Parameters

Name	Type	Required	Default	Description
`orderListID`	`string`	`No`	`""`	If parameter is not set, value of /v1/portfolio/get_last_order_list_id will be used
`listingID`	`string`	`No`	`""`	if this item is an existing appointment set the listingID
`locationAlias`	`string`	`No`	`""`	locationAlias if this item is a bid. Slug found after the slash when opening a location in the portal
`bidQuantity`	`int`	`No`	`1`	number of times the bid item should be placed
`inventoryTypeID`	`int`	`No`	`0`	inventoryTypeID found in /v1/location/get_inventory_types
`bidAmountInSmallestUnit`	`int`	`No`	`0`	Smallest possible currency unit, for example USD 100 would be 10000 (usd-cents), amounts will be rounded to next 5 increment. Refer to the MetaInformation of the return object of /v1/location/get_comparable_trades for pricing information. Endpoint will also return if there is an available bid - if available bid price is matched in your upload, bid will automatically be filled.
`currencyCode`	`string`	`No`	`"USD"`	3 digit currency code, currently all prices will be converted to USD and rounded
`dateTimeRangeStart`	`string`	`No`	`""`	Time Range Start Date format: YYYY-MM-DD HH:MM:SS
`dateTimeRangeEnd`	`string`	`No`	`""`	Time Range End Date format: YYYY-MM-DD HH:MM:SS
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_order_list_item' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'orderListID={{orderListID}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'bidQuantity={{bidQuantity}}' \
  --data-urlencode 'inventoryTypeID={{inventoryTypeID}}' \
  --data-urlencode 'bidAmountInSmallestUnit={{bidAmountInSmallestUnit}}' \
  --data-urlencode 'currencyCode={{currencyCode}}' \
  --data-urlencode 'dateTimeRangeStart={{dateTimeRangeStart}}' \
  --data-urlencode 'dateTimeRangeEnd={{dateTimeRangeEnd}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_order_list_item_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_order_list_item",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_rename_order_list

Rename order list

Parameters

Name	Type	Required	Default	Description
`orderListID`	`string`	`Yes`	`—`	ID of the order list that should be renamed
`newName`	`string`	`Yes`	`—`	The new name of the list
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_rename_order_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'orderListID={{orderListID}}' \
  --data-urlencode 'newName={{newName}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_rename_order_list_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_rename_order_list",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_revoke_calendar_feed_tokens

Revokes every active calendar-feed token for the viewer. Use this when the user clicks "Regenerate URL" in the Sync sheet — call mint after to issue a fresh one.

Parameters

Name	Type	Required	Default	Description
`isWritingRequest`	`bool`	`No`	`false`	Required by the apiv1 write contract.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_revoke_calendar_feed_tokens' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_revoke_calendar_feed_tokens_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.revoked`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_revoke_calendar_feed_tokens",
    "RequestUserAlias": "example-user",
    "Payload": {
        "revoked": 0
    }
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_suggest_list_to_user

Unimplemented list-suggestion endpoint. The dispatcher returns an internal-error envelope; no suggestion is sent.

Parameters

Name	Type	Required	Default	Description
`userAlias`	`string`	`Yes`	`—`	Intended recipient alias; currently unused.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_suggest_list_to_user' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_set_suggest_list_to_user_Response`	`Yes`

Response example

{
    "RequestStatus": "Failed",
    "ResponseCode": 402,
    "ResponseMessage": "Synthetic error example.",
    "RequestPath": "/v1/portfolio/set_suggest_list_to_user",
    "RequestUserAlias": "example-user"
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_unarchive_my_travel_plan

Restores an owned archived reservation from v2 My Bookings. The plan returns to its most recent non-archived status when that status is still supported by My Bookings; otherwise it falls back to Private.

Parameters

Name	Type	Required	Default	Description
`appointmentID`	`int`	`Yes`	`—`	Archived appointment ID to restore.
`isWritingRequest`	`bool`	`No`	`false`	Required true to restore.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_unarchive_my_travel_plan' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'appointmentID={{appointmentID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_unarchive_my_travel_plan_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.status`	`string ["Approved","Private","Unlocked","Transfer Failed But Unlocked"]`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_unarchive_my_travel_plan",
    "RequestUserAlias": "example-user",
    "Payload": {
        "appointmentID": 0,
        "status": "Approved"
    }
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_unlock_private_appointment

Unlocks a private reservation for personal use from v2 My Bookings. Unlocking reveals the exact start time and confirmation details. After a reservation is unlocked, resale must go through the regular offer and review process again.

Parameters

Name	Type	Required	Default	Description
`appointmentID`	`int`	`Yes`	`—`	Private appointment ID to unlock.
`isWritingRequest`	`bool`	`No`	`false`	Required true to unlock.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_unlock_private_appointment' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'appointmentID={{appointmentID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`portfolio_set_unlock_private_appointment_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.appointmentID`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.status`	`string ["Unlocked","Transfer Failed But Unlocked"]`	`Yes`
`$.oneOf[0].allOf[1].Payload.alreadyUnlocked`	`boolean`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_unlock_private_appointment",
    "RequestUserAlias": "example-user",
    "Payload": {
        "appointmentID": 0,
        "status": "Unlocked",
        "alreadyUnlocked": false
    }
}

Machine-readable endpoint documentation

POST

/v1/portfolio/set_update_order_list_item_quantity

Updates the quantity of an item

Parameters

Name	Type	Required	Default	Description
`orderListItemID`	`int`	`Yes`	`—`	ID of the order list item that should be deleted
`quantity`	`int`	`Yes`	`—`	the desired quantity of the order list item
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/portfolio/set_update_order_list_item_quantity' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'orderListItemID={{orderListItemID}}' \
  --data-urlencode 'quantity={{quantity}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`portfolio_set_update_order_list_item_quantity_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`number`	`Yes`	New subtotal: stored individual amount multiplied by requested quantity.
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/portfolio/set_update_order_list_item_quantity",
    "RequestUserAlias": "example-user",
    "Payload": 0
}

Machine-readable endpoint documentation