GET api/BookingTemplates/GetBrochure?id={id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

BookingTemplateViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

Title

string

None.

PackageType

string

None.

Destination

string

None.

City

SimpleCity

None.

Country

LocationAddress

None.

Company

SimpleCompany

None.

StartDate

date

Data type: Date

EndDate

date

Data type: Date

TourCategory

TourCategoryViewModel

None.

TourPaxType

PaxTypeViewModel

None.

GroupType

string

None.

ExpiredOn

date

Data type: DateTime

FixedPackage

SimpleFixedPackageView

None.

MinPax

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Title": "sample string 2",
  "PackageType": "sample string 3",
  "Destination": "sample string 4",
  "City": {
    "UTC": 1,
    "ImageUrl": "sample string 1",
    "Id": "sample string 2",
    "Name": "sample string 3"
  },
  "Country": {
    "ImageUrl": "sample string 1",
    "Id": "sample string 2",
    "Name": "sample string 3"
  },
  "Company": {
    "Code": "sample string 1",
    "Name": "sample string 2"
  },
  "StartDate": "2025-06-26T13:59:04.0100075+00:00",
  "EndDate": "2025-06-26T13:59:04.0100075+00:00",
  "TourCategory": {
    "Id": 1,
    "Name": "sample string 2",
    "ImageName": "sample string 3",
    "ImageUrl": "sample string 4",
    "TinyImageUrl": "sample string 5"
  },
  "TourPaxType": {
    "Id": 1,
    "Name": "sample string 2",
    "ImageName": "sample string 3",
    "ImageUrl": "sample string 4",
    "TinyImageUrl": "sample string 5"
  },
  "GroupType": "sample string 7",
  "ExpiredOn": "2025-06-26T13:59:04.0100075+00:00",
  "FixedPackage": {
    "BookingCommission": {
      "TotalPriceForCustomer": 1.0,
      "AgentCommission": {
        "TotalPax": 1,
        "UnitPrice": 2.0,
        "TotalPrice": 2.0
      },
      "StaffCommission": {
        "TotalPax": 1,
        "UnitPrice": 2.0,
        "TotalPrice": 2.0
      },
      "ApplicableCommission": [
        {
          "Description": "sample string 1",
          "TotalPax": 2,
          "UnitPrice": 3.0,
          "TotalPrice": 6.0
        },
        {
          "Description": "sample string 1",
          "TotalPax": 2,
          "UnitPrice": 3.0,
          "TotalPrice": 6.0
        }
      ]
    },
    "RegisteringGuest": 1,
    "MinimumGuest": 2,
    "MaximumGuest": 3,
    "ConfirmedGuest": 4,
    "PaxLeft": 5,
    "ReferenceId": "sample string 6",
    "MinPax": 7,
    "PaymentTerms": [
      {
        "Id": 1,
        "PaymentPercentage": 2.0,
        "DueDate": "2025-06-26T13:59:04.0100075+00:00",
        "PayDate": "2025-06-26T13:59:04.0100075+00:00",
        "PaymentValue": 4.0,
        "PaymentValueEndCustomer": 5.0,
        "CurrencyId": "sample string 6",
        "Description": "sample string 7",
        "IsPayed": true,
        "PaidValue": 9.0,
        "IsLockGuest": true,
        "Sequence": 11,
        "IntervalDays": 12,
        "IsAfterBookingBased": true
      },
      {
        "Id": 1,
        "PaymentPercentage": 2.0,
        "DueDate": "2025-06-26T13:59:04.0100075+00:00",
        "PayDate": "2025-06-26T13:59:04.0100075+00:00",
        "PaymentValue": 4.0,
        "PaymentValueEndCustomer": 5.0,
        "CurrencyId": "sample string 6",
        "Description": "sample string 7",
        "IsPayed": true,
        "PaidValue": 9.0,
        "IsLockGuest": true,
        "Sequence": 11,
        "IntervalDays": 12,
        "IsAfterBookingBased": true
      }
    ],
    "Suppements": [
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsMandatory": true,
        "UnitCost": 4.0,
        "UomId": "sample string 5",
        "CurrencyId": "sample string 6",
        "BookingTemplateId": 7,
        "BookingTemplateSupplementId": 8,
        "IsInfantCount": true
      },
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsMandatory": true,
        "UnitCost": 4.0,
        "UomId": "sample string 5",
        "CurrencyId": "sample string 6",
        "BookingTemplateId": 7,
        "BookingTemplateSupplementId": 8,
        "IsInfantCount": true
      }
    ]
  },
  "MinPax": 9
}

application/xml, text/xml

Sample:
<BookingTemplateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TripPlannerAPI.Models.DTO">
  <City>
    <Id>sample string 2</Id>
    <Name>sample string 3</Name>
    <ImageUrl>sample string 1</ImageUrl>
    <UTC>1</UTC>
  </City>
  <Company>
    <Code>sample string 1</Code>
    <Name>sample string 2</Name>
  </Company>
  <Country>
    <Id>sample string 2</Id>
    <Name>sample string 3</Name>
    <ImageUrl>sample string 1</ImageUrl>
  </Country>
  <Destination>sample string 4</Destination>
  <EndDate>2025-06-26T13:59:04.0100075+00:00</EndDate>
  <ExpiredOn>2025-06-26T13:59:04.0100075+00:00</ExpiredOn>
  <FixedPackage>
    <BookingCommission>
      <AgentCommission>
        <TotalPax>1</TotalPax>
        <UnitPrice>2</UnitPrice>
      </AgentCommission>
      <ApplicableCommission>
        <DescriptiveBookingCommission>
          <TotalPax>2</TotalPax>
          <UnitPrice>3</UnitPrice>
          <Description>sample string 1</Description>
        </DescriptiveBookingCommission>
        <DescriptiveBookingCommission>
          <TotalPax>2</TotalPax>
          <UnitPrice>3</UnitPrice>
          <Description>sample string 1</Description>
        </DescriptiveBookingCommission>
      </ApplicableCommission>
      <StaffCommission>
        <TotalPax>1</TotalPax>
        <UnitPrice>2</UnitPrice>
      </StaffCommission>
      <TotalPriceForCustomer>1</TotalPriceForCustomer>
    </BookingCommission>
    <ConfirmedGuest>4</ConfirmedGuest>
    <MaximumGuest>3</MaximumGuest>
    <MinPax>7</MinPax>
    <MinimumGuest>2</MinimumGuest>
    <PaxLeft>5</PaxLeft>
    <PaymentTerms>
      <PaymentTermsOfCustomer>
        <CurrencyId>sample string 6</CurrencyId>
        <Description>sample string 7</Description>
        <DueDate>2025-06-26T13:59:04.0100075+00:00</DueDate>
        <Id>1</Id>
        <IntervalDays>12</IntervalDays>
        <IsAfterBookingBased>true</IsAfterBookingBased>
        <IsLockGuest>true</IsLockGuest>
        <IsPayed>true</IsPayed>
        <PaidValue>9</PaidValue>
        <PayDate>2025-06-26T13:59:04.0100075+00:00</PayDate>
        <PaymentPercentage>2</PaymentPercentage>
        <PaymentValue>4</PaymentValue>
        <PaymentValueEndCustomer>5</PaymentValueEndCustomer>
        <Sequence>11</Sequence>
      </PaymentTermsOfCustomer>
      <PaymentTermsOfCustomer>
        <CurrencyId>sample string 6</CurrencyId>
        <Description>sample string 7</Description>
        <DueDate>2025-06-26T13:59:04.0100075+00:00</DueDate>
        <Id>1</Id>
        <IntervalDays>12</IntervalDays>
        <IsAfterBookingBased>true</IsAfterBookingBased>
        <IsLockGuest>true</IsLockGuest>
        <IsPayed>true</IsPayed>
        <PaidValue>9</PaidValue>
        <PayDate>2025-06-26T13:59:04.0100075+00:00</PayDate>
        <PaymentPercentage>2</PaymentPercentage>
        <PaymentValue>4</PaymentValue>
        <PaymentValueEndCustomer>5</PaymentValueEndCustomer>
        <Sequence>11</Sequence>
      </PaymentTermsOfCustomer>
    </PaymentTerms>
    <ReferenceId>sample string 6</ReferenceId>
    <RegisteringGuest>1</RegisteringGuest>
    <Suppements>
      <BookingSupplementViewModel>
        <BookingTemplateId>7</BookingTemplateId>
        <BookingTemplateSupplementId>8</BookingTemplateSupplementId>
        <CurrencyId>sample string 6</CurrencyId>
        <Description>sample string 2</Description>
        <IsInfantCount>true</IsInfantCount>
        <IsMandatory>true</IsMandatory>
        <Name>sample string 1</Name>
        <UnitCost>4</UnitCost>
        <UomId>sample string 5</UomId>
      </BookingSupplementViewModel>
      <BookingSupplementViewModel>
        <BookingTemplateId>7</BookingTemplateId>
        <BookingTemplateSupplementId>8</BookingTemplateSupplementId>
        <CurrencyId>sample string 6</CurrencyId>
        <Description>sample string 2</Description>
        <IsInfantCount>true</IsInfantCount>
        <IsMandatory>true</IsMandatory>
        <Name>sample string 1</Name>
        <UnitCost>4</UnitCost>
        <UomId>sample string 5</UomId>
      </BookingSupplementViewModel>
    </Suppements>
  </FixedPackage>
  <GroupType>sample string 7</GroupType>
  <Id>1</Id>
  <MinPax>9</MinPax>
  <PackageType>sample string 3</PackageType>
  <StartDate>2025-06-26T13:59:04.0100075+00:00</StartDate>
  <Title>sample string 2</Title>
  <TourCategory>
    <Id>1</Id>
    <ImageName>sample string 3</ImageName>
    <ImageUrl>sample string 4</ImageUrl>
    <Name>sample string 2</Name>
    <TinyImageUrl>sample string 5</TinyImageUrl>
  </TourCategory>
  <TourPaxType>
    <Id>1</Id>
    <ImageName>sample string 3</ImageName>
    <ImageUrl>sample string 4</ImageUrl>
    <Name>sample string 2</Name>
    <TinyImageUrl>sample string 5</TinyImageUrl>
  </TourPaxType>
</BookingTemplateViewModel>