Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added deliverables/1 search offers/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions deliverables/1 search offers/search-offers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Search Offers Request - delivery

_Required items_

| object | description |
| --- | --- |
| SEARCH OFFERS REQUEST | The search request |
| SEARCH OFFERS DELIVERY | The accompaning response |

## SEARCH OFFERS REQUEST DETAILS

| field | type | optional/conditions | description |
| --- | --- | --- | --- |
| requestId | string | condition: a-sync | a unique ID, the response to this request MUST have the same ID (in case of a-sync call) |
| travellers | List of travellingEntities | required | See the 'Who' part |
| trip | Trip | required | See the 'What' part |
| filters | List of Filters | optional | See the PR of the 'What' part |
| amendingOfferedPackageRef | string | conditional | (policy) only to be used in the 'amend' phase, where additional offers can be searched |

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stalled, until the BUC comes in

| contentLanguage | string | optional | (policy) The language/localization of user-facing content, One IETF BCP 47 (RFC 5646) language tag. If missing, the local accepted language |

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clemens: This should be a list.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarification: it should be a list of values.
The admitted values is the ISO code for languages (2-letters)

| currency | string | optional | (policy) The currency to be used in the response. If the requested currency is not available, return the local valuta |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: usually, only one currency (the one of the distributor) is allowed. However, some systems can have other currencies displayed

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the other displayed currency is for information and additionaly to the main one from the distributor.
change to "The additional currency to be used in the response"


### Example (indicative)

```json
{
"requestId": "32490-df324",
"trip": {
... see the 'what' part ...
},
"travellers": [
{ ... see the 'who' part ... }
],
"filters": [
{ "exclude": false,
"filterType": "distribution",
"fulfillmentMethod": "mobile"
}
]
}
```

## SEARCH OFFER DELIVERY DETAILS

See the 'Search offers - Delivery' part