The user is able to retrieve holidays using this call in 2 ways
- The user can enter a token and retrieve the holidays for a country. This requires the input of the following fields
| Field | Field description | Type of field |
| countryCode | ISO Country Code | xs:string |
| token | Security token | xs:string |
This will give a default of 3 months holiday from today. The user also has the option of entering the dates they would like the holiday for which are
| Field | Field description | Type of field |
| startDate | Start date of the holiday that you want. IF blank then todays date is used | xs:string |
| endDate | End date of holiday, if left blank then we will give 3 months | xs:string |
2. The holiday can be requested for a specific payment. This requires the user to enter the bankToken and the freeToken from a payment which will give the holidays that relate to the initial search.
| Field | Field description | Type of field |
| bankToken | Token relating to the bank you searched for | xs:string |
| freeToken | Token relating to the bank you searched for | xs:string |
This will give a default of 3 months holiday from today. The user also has the option of entering the dates they would like the holiday for which are
| Field | Field description | Type of field |
| startDate | Start date of the holiday that you want. IF blank then todays date is used | xs:string |
| endDate | End date of holiday, if left blank then we will give 3 months | xs:string |
METHOD
GET command, in “application/json” format
URL Endpoint
https://validate.bankersalmanac.com/validate-api/rest/convert/4.6.1
REQUEST
| Field | Field description | Type of field |
| countryCode | ISO Country Code | xs:string |
| holidayType | Type of holiday requested | xs:string |
| startDate | Start date of the holiday that you want. IF blank then todays date is used | xs:string |
| endDate | End date of holiday, if left blank then we will give 3 months | xs:string |
| bankToken | Token relating to the bank you searched for | xs:string |
| freeToken | Token relating to the bank you searched for | xs:string |
| ref | Payment reference | xs:string |
| errorComment | No input required | xs:string |
Response
| Field | Field description | Type of field |
| countryCode | ISO Country Code | “GB”, |
| holidays | Label | [ |
| id | Unique holiday ID | “CH00086882”, |
| title | Name of holiday | “Weekend holiday”, |
| start | Start date and time of holiday | “23/11/19 00 |
| end | End date and time of holiday | “23/11/19 23 |
| code | Code for type of holiday | “W” |