POST api/FareHarbour
Request Information
URI Parameters
None.
Body Parameters
DataReceived| Name | Description | Type | Additional information |
|---|---|---|---|
| booking | Booking |
None. |
Request Formats
application/json, text/json
Sample:
{
"booking": {
"pk": 1,
"uuid": "sample string 2",
"company": {
"name": "sample string 1",
"shortname": "sample string 2",
"currency": "sample string 3"
},
"affiliate_company": {},
"contact": {
"name": "sample string 1",
"phone": "sample string 2",
"phone_country": "sample string 3",
"normalized_phone": "sample string 4",
"language": "sample string 5",
"email": "sample string 6",
"is_subscribed_for_email_updates": true
},
"display_id": "sample string 4",
"external_id": "sample string 5",
"order": {},
"status": "sample string 7",
"rebooked_from": {},
"rebooked_to": {},
"dashboard_url": "sample string 10",
"availability": {
"pk": 1,
"item": {
"pk": 1,
"name": "sample string 2"
},
"start_at": "2025-04-03T23:48:09.8909728+01:00",
"end_at": "2025-04-03T23:48:09.8909728+01:00"
},
"customers": [
{
"pk": 1,
"checkin_url": "sample string 2",
"checkin_status": {},
"invoice_cost": {
"price": {},
"tax": 2,
"taxable": 3,
"feeable": 4,
"tax_by_type": {
"85876": 1
},
"total": 5
},
"total_cost": {
"price": 1,
"tax": 2,
"taxable": 3,
"feeable": 4,
"tax_by_type": {
"85876": 1
},
"total": 5
},
"customer_type_rate": {
"pk": 1,
"customer_type": {
"pk": 1,
"singular": "sample string 2",
"plural": "sample string 3"
},
"customer_prototype": {
"pk": 1,
"display_name": "sample string 2"
}
},
"custom_field_values": [
{},
{}
]
},
{
"pk": 1,
"checkin_url": "sample string 2",
"checkin_status": {},
"invoice_cost": {
"price": {},
"tax": 2,
"taxable": 3,
"feeable": 4,
"tax_by_type": {
"85876": 1
},
"total": 5
},
"total_cost": {
"price": 1,
"tax": 2,
"taxable": 3,
"feeable": 4,
"tax_by_type": {
"85876": 1
},
"total": 5
},
"customer_type_rate": {
"pk": 1,
"customer_type": {
"pk": 1,
"singular": "sample string 2",
"plural": "sample string 3"
},
"customer_prototype": {
"pk": 1,
"display_name": "sample string 2"
}
},
"custom_field_values": [
{},
{}
]
}
],
"custom_field_values": [
{
"pk": 1,
"custom_field": {
"modifier_kind": "sample string 1",
"modifier_type": "sample string 2",
"offset": 3,
"percentage": 4.1,
"is_taxable": true,
"is_always_per_customer": true,
"pk": 7,
"type": "sample string 8",
"is_required": true,
"description": "sample string 10",
"description_safe_html": "sample string 11",
"name": "sample string 12",
"title": "sample string 13",
"booking_notes": "sample string 14",
"booking_notes_safe_html": "sample string 15"
},
"name": "sample string 2",
"value": "sample string 3",
"display_value": "sample string 4"
},
{
"pk": 1,
"custom_field": {
"modifier_kind": "sample string 1",
"modifier_type": "sample string 2",
"offset": 3,
"percentage": 4.1,
"is_taxable": true,
"is_always_per_customer": true,
"pk": 7,
"type": "sample string 8",
"is_required": true,
"description": "sample string 10",
"description_safe_html": "sample string 11",
"name": "sample string 12",
"title": "sample string 13",
"booking_notes": "sample string 14",
"booking_notes_safe_html": "sample string 15"
},
"name": "sample string 2",
"value": "sample string 3",
"display_value": "sample string 4"
}
],
"invoice_price": 11,
"invoice_price_display": "sample string 12",
"confirmation_url": "sample string 13",
"voucher_number": "sample string 14",
"receipt_subtotal": 15,
"receipt_subtotal_display": "sample string 16",
"receipt_taxes": 17,
"receipt_taxes_display": "sample string 18",
"receipt_total": 19,
"receipt_total_display": "sample string 20",
"amount_paid": 21,
"amount_paid_display": "sample string 22",
"note": "sample string 23",
"note_safe_html": "sample string 24",
"pickup": {},
"arrival": {},
"is_eligible_for_cancellation": true,
"effective_cancellation_policy": {
"type": "sample string 1",
"cutoff": "2025-04-03T23:48:09.8909728+01:00"
},
"is_subscribed_for_sms_updates": true,
"agent": {},
"desk": {},
"customer_count": 31,
"external_api_url": "sample string 32"
}
}
application/xml, text/xml
Sample:
<DataReceived xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FareHarbour_Integration.Models">
<booking>
<affiliate_company />
<agent />
<amount_paid>21</amount_paid>
<amount_paid_display>sample string 22</amount_paid_display>
<arrival />
<availability>
<end_at>2025-04-03T23:48:09.8909728+01:00</end_at>
<item>
<name>sample string 2</name>
<pk>1</pk>
</item>
<pk>1</pk>
<start_at>2025-04-03T23:48:09.8909728+01:00</start_at>
</availability>
<company>
<currency>sample string 3</currency>
<name>sample string 1</name>
<shortname>sample string 2</shortname>
</company>
<confirmation_url>sample string 13</confirmation_url>
<contact>
<email>sample string 6</email>
<is_subscribed_for_email_updates>true</is_subscribed_for_email_updates>
<language>sample string 5</language>
<name>sample string 1</name>
<normalized_phone>sample string 4</normalized_phone>
<phone>sample string 2</phone>
<phone_country>sample string 3</phone_country>
</contact>
<custom_field_values>
<CustomFieldValue>
<custom_field>
<booking_notes>sample string 14</booking_notes>
<booking_notes_safe_html>sample string 15</booking_notes_safe_html>
<description>sample string 10</description>
<description_safe_html>sample string 11</description_safe_html>
<is_always_per_customer>true</is_always_per_customer>
<is_required>true</is_required>
<is_taxable>true</is_taxable>
<modifier_kind>sample string 1</modifier_kind>
<modifier_type>sample string 2</modifier_type>
<name>sample string 12</name>
<offset>3</offset>
<percentage>4.1</percentage>
<pk>7</pk>
<title>sample string 13</title>
<type>sample string 8</type>
</custom_field>
<display_value>sample string 4</display_value>
<name>sample string 2</name>
<pk>1</pk>
<value>sample string 3</value>
</CustomFieldValue>
<CustomFieldValue>
<custom_field>
<booking_notes>sample string 14</booking_notes>
<booking_notes_safe_html>sample string 15</booking_notes_safe_html>
<description>sample string 10</description>
<description_safe_html>sample string 11</description_safe_html>
<is_always_per_customer>true</is_always_per_customer>
<is_required>true</is_required>
<is_taxable>true</is_taxable>
<modifier_kind>sample string 1</modifier_kind>
<modifier_type>sample string 2</modifier_type>
<name>sample string 12</name>
<offset>3</offset>
<percentage>4.1</percentage>
<pk>7</pk>
<title>sample string 13</title>
<type>sample string 8</type>
</custom_field>
<display_value>sample string 4</display_value>
<name>sample string 2</name>
<pk>1</pk>
<value>sample string 3</value>
</CustomFieldValue>
</custom_field_values>
<customer_count>31</customer_count>
<customers>
<Customer>
<checkin_status />
<checkin_url>sample string 2</checkin_url>
<custom_field_values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
<d5p1:anyType />
</custom_field_values>
<customer_type_rate>
<customer_prototype>
<display_name>sample string 2</display_name>
<pk>1</pk>
</customer_prototype>
<customer_type>
<pk>1</pk>
<plural>sample string 3</plural>
<singular>sample string 2</singular>
</customer_type>
<pk>1</pk>
</customer_type_rate>
<invoice_cost>
<feeable>4</feeable>
<price />
<tax>2</tax>
<tax_by_type>
<_85876>1</_85876>
</tax_by_type>
<taxable>3</taxable>
<total>5</total>
</invoice_cost>
<pk>1</pk>
<total_cost>
<feeable>4</feeable>
<price>1</price>
<tax>2</tax>
<tax_by_type>
<_85876>1</_85876>
</tax_by_type>
<taxable>3</taxable>
<total>5</total>
</total_cost>
</Customer>
<Customer>
<checkin_status />
<checkin_url>sample string 2</checkin_url>
<custom_field_values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
<d5p1:anyType />
</custom_field_values>
<customer_type_rate>
<customer_prototype>
<display_name>sample string 2</display_name>
<pk>1</pk>
</customer_prototype>
<customer_type>
<pk>1</pk>
<plural>sample string 3</plural>
<singular>sample string 2</singular>
</customer_type>
<pk>1</pk>
</customer_type_rate>
<invoice_cost>
<feeable>4</feeable>
<price />
<tax>2</tax>
<tax_by_type>
<_85876>1</_85876>
</tax_by_type>
<taxable>3</taxable>
<total>5</total>
</invoice_cost>
<pk>1</pk>
<total_cost>
<feeable>4</feeable>
<price>1</price>
<tax>2</tax>
<tax_by_type>
<_85876>1</_85876>
</tax_by_type>
<taxable>3</taxable>
<total>5</total>
</total_cost>
</Customer>
</customers>
<dashboard_url>sample string 10</dashboard_url>
<desk />
<display_id>sample string 4</display_id>
<effective_cancellation_policy>
<cutoff>2025-04-03T23:48:09.8909728+01:00</cutoff>
<type>sample string 1</type>
</effective_cancellation_policy>
<external_api_url>sample string 32</external_api_url>
<external_id>sample string 5</external_id>
<invoice_price>11</invoice_price>
<invoice_price_display>sample string 12</invoice_price_display>
<is_eligible_for_cancellation>true</is_eligible_for_cancellation>
<is_subscribed_for_sms_updates>true</is_subscribed_for_sms_updates>
<note>sample string 23</note>
<note_safe_html>sample string 24</note_safe_html>
<order />
<pickup />
<pk>1</pk>
<rebooked_from />
<rebooked_to />
<receipt_subtotal>15</receipt_subtotal>
<receipt_subtotal_display>sample string 16</receipt_subtotal_display>
<receipt_taxes>17</receipt_taxes>
<receipt_taxes_display>sample string 18</receipt_taxes_display>
<receipt_total>19</receipt_total>
<receipt_total_display>sample string 20</receipt_total_display>
<status>sample string 7</status>
<uuid>sample string 2</uuid>
<voucher_number>sample string 14</voucher_number>
</booking>
</DataReceived>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Output| Name | Description | Type | Additional information |
|---|---|---|---|
| Response | boolean |
None. |
|
| Error | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Response": true,
"Error": "sample string 2"
}
application/xml, text/xml
Sample:
<Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FareHarbour_Integration.Models"> <Error>sample string 2</Error> <Response>true</Response> </Output>