GET api/Product/{id}?mediaChannelId={mediaChannelId}

Returns a product if available in the system based on API user permissions.

Note that only products with status online are returned.

If mediaChannelId is specified then a product is only returned if it belongs to that media channel.

Test

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the product.	integer	Required
mediaChannelId	Media channel id to filter result by. Optional.	integer	None.

Body Parameters

None.

Response Information

Resource Description

Product

Name	Description	Type	Additional information
Id	The id of the product.	integer	None.
Created	The time the product was created.	date	None.
CreatedBy	The user who created the product.	string	None.
Modified	The latest time the product was modified.	date	None.
ModifiedBy	THe latest user who modified the product.	string	None.
Serialized	The time this product was serialized to output format. Products may be serialized without a user touching it, eg. because a related product was updated.	date	None.
Online	Specifies whether the product is online. A product is online IF a user has marked it with status online AND the product isn't deleted. If Online=false then the product shouldn't be displayed or returned in search results.	boolean	None.
Language	The two-letter language code of the product.	string	None.
Name	The localized name of the product.	string	None.
CanonicalUrl	The canonical url for the product.	string	None.
Owner	The office that owns the product.	Office	None.
Category	The sub-category of the product.	ProductCategory	None.
MainCategory	The main category of the product.	ProductCategory	None.
Address	The address of the product.	Address	None.
ContactInformation	Contact information for the product.	ContactInformation	None.
Descriptions	Localized descriptions of the product.	Collection of Description	None.
Files	Images and files associated with the product.	Collection of File	None.
SocialMediaLinks	Social media links for the product.	Collection of Link	None.
BookingLinks	Booking links for the product.	Collection of Link	None.
ExternalLinks	Other external links for the product.	Collection of ExternalLink	None.
MetaTags	A list of meta tags that describe the product.	Collection of ProductMetaTag	None.
RelatedProducts	A list of other products related to this product.	Collection of RelatedProduct	None.
Places	A list of places ("search words") that the product is related to.	Collection of Place	None.
MediaChannels	A list of media channels that can access this product.	Collection of MediaChannel	None.
Distances	A list of distances from this product to other places.	Collection of Distance	None.
Priority	The product's priority. May possibly be used to order search results.	integer	None.
Periods	A list of periods that describe the product's opening dates and hours.	Collection of Period	None.
PeriodsLink	A link pointing to information about periods.	Link	None.
PriceGroups	A list of price groups for the product.	Collection of PriceGroup	None.
PriceGroupsLink	A link pointing to information about price groups.	Link	None.
Routes	A list of geographic routes attached to the product.	Collection of Route	None.
Rooms	A list of rooms contained in this product	Collection of Room	None.
Capacity	Capacity.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Created": "2020-11-26T14:26:33.3383487+01:00",
  "CreatedBy": "sample string 3",
  "Modified": "2020-11-26T14:26:33.3383487+01:00",
  "ModifiedBy": "sample string 5",
  "Serialized": "2020-11-26T14:26:33.3383487+01:00",
  "Online": true,
  "Language": "sample string 8",
  "Name": "sample string 9",
  "CanonicalUrl": "sample string 10",
  "Owner": {
    "Id": 1,
    "Name": "sample string 2",
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "PostalCode": "sample string 3",
      "City": "sample string 4",
      "Municipality": {
        "Id": 1,
        "Name": "sample string 2"
      },
      "Region": {
        "Id": 1,
        "Name": "sample string 2"
      },
      "GeoCoordinate": {
        "Latitude": 1.1,
        "Longitude": 2.1
      }
    },
    "Email": "sample string 3"
  },
  "Category": {
    "Id": 1,
    "Name": "sample string 2"
  },
  "MainCategory": {
    "Id": 1,
    "Name": "sample string 2"
  },
  "Address": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "PostalCode": "sample string 3",
    "City": "sample string 4",
    "Municipality": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "Region": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "GeoCoordinate": {
      "Latitude": 1.1,
      "Longitude": 2.1
    }
  },
  "ContactInformation": {
    "Phone": "sample string 1",
    "Mobile": "sample string 2",
    "Fax": "sample string 3",
    "Email": "sample string 4",
    "Link": {
      "Url": "sample string 1",
      "Name": "sample string 2"
    }
  },
  "Descriptions": [
    {
      "DescriptionTypeID": 1,
      "DescriptionType": "sample string 2",
      "Text": "sample string 3",
      "Html": "sample string 4"
    },
    {
      "DescriptionTypeID": 1,
      "DescriptionType": "sample string 2",
      "Text": "sample string 3",
      "Html": "sample string 4"
    }
  ],
  "Files": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "FileType": "sample string 3",
      "Uri": "sample string 4",
      "Copyright": "sample string 5",
      "Photographer": "sample string 6",
      "AltText": "sample string 7",
      "Description": "sample string 8",
      "MetaTag": {
        "Id": 1,
        "Name": "sample string 2"
      }
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "FileType": "sample string 3",
      "Uri": "sample string 4",
      "Copyright": "sample string 5",
      "Photographer": "sample string 6",
      "AltText": "sample string 7",
      "Description": "sample string 8",
      "MetaTag": {
        "Id": 1,
        "Name": "sample string 2"
      }
    }
  ],
  "SocialMediaLinks": [
    {
      "Url": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Url": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "BookingLinks": [
    {
      "Url": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Url": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "ExternalLinks": [
    {
      "LinkType": "sample string 1",
      "Url": "sample string 2",
      "Name": "sample string 3"
    },
    {
      "LinkType": "sample string 1",
      "Url": "sample string 2",
      "Name": "sample string 3"
    }
  ],
  "MetaTags": [
    {
      "MetaTagGroup": {
        "Id": 1,
        "CategoryId": 2,
        "Name": "sample string 3",
        "CanonicalName": "sample string 4",
        "UseInSearch": true,
        "ShowOnWeb": true
      },
      "Id": 1,
      "Name": "sample string 2",
      "Comment": "sample string 3"
    },
    {
      "MetaTagGroup": {
        "Id": 1,
        "CategoryId": 2,
        "Name": "sample string 3",
        "CanonicalName": "sample string 4",
        "UseInSearch": true,
        "ShowOnWeb": true
      },
      "Id": 1,
      "Name": "sample string 2",
      "Comment": "sample string 3"
    }
  ],
  "RelatedProducts": [
    {
      "Id": 1,
      "OfficeId": 2,
      "Name": "sample string 3"
    },
    {
      "Id": 1,
      "OfficeId": 2,
      "Name": "sample string 3"
    }
  ],
  "Places": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ],
  "MediaChannels": [
    {
      "Id": 1,
      "ChannelName": "sample string 2"
    },
    {
      "Id": 1,
      "ChannelName": "sample string 2"
    }
  ],
  "Distances": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Priority": 11,
  "Periods": [
    {
      "Id": 1,
      "StartDate": "2020-11-26T14:26:33.3383487+01:00",
      "EndDate": "2020-11-26T14:26:33.3383487+01:00",
      "StartTime": "00:00:00.1234567",
      "EndTime": "00:00:00.1234567",
      "Monday": true,
      "Tuesday": true,
      "Wednesday": true,
      "Thursday": true,
      "Friday": true,
      "Saturday": true,
      "Sunday": true,
      "PriceGroupIds": [
        1,
        2
      ]
    },
    {
      "Id": 1,
      "StartDate": "2020-11-26T14:26:33.3383487+01:00",
      "EndDate": "2020-11-26T14:26:33.3383487+01:00",
      "StartTime": "00:00:00.1234567",
      "EndTime": "00:00:00.1234567",
      "Monday": true,
      "Tuesday": true,
      "Wednesday": true,
      "Thursday": true,
      "Friday": true,
      "Saturday": true,
      "Sunday": true,
      "PriceGroupIds": [
        1,
        2
      ]
    }
  ],
  "PeriodsLink": {
    "Url": "sample string 1",
    "Name": "sample string 2"
  },
  "PriceGroups": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "PriceFrom": 1.0,
      "PriceTo": 1.0,
      "Free": true,
      "PriceLevel": "sample string 3",
      "PeriodIds": [
        1,
        2
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "PriceFrom": 1.0,
      "PriceTo": 1.0,
      "Free": true,
      "PriceLevel": "sample string 3",
      "PeriodIds": [
        1,
        2
      ]
    }
  ],
  "PriceGroupsLink": {
    "Url": "sample string 1",
    "Name": "sample string 2"
  },
  "Routes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "GeoCoordinates": [
        {
          "Latitude": 1.1,
          "Longitude": 2.1
        },
        {
          "Latitude": 1.1,
          "Longitude": 2.1
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "GeoCoordinates": [
        {
          "Latitude": 1.1,
          "Longitude": 2.1
        },
        {
          "Latitude": 1.1,
          "Longitude": 2.1
        }
      ]
    }
  ],
  "Rooms": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Features": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Value": "sample string 3"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Features": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Value": "sample string 3"
        }
      ]
    }
  ],
  "Capacity": 1
}

application/xml, text/xml

Sample:

<Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GuideDenmark.External.Data.Model">
  <Address>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <City>sample string 4</City>
    <GeoCoordinate>
      <Latitude>1.1</Latitude>
      <Longitude>2.1</Longitude>
    </GeoCoordinate>
    <Municipality>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Municipality>
    <PostalCode>sample string 3</PostalCode>
    <Region>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Region>
  </Address>
  <BookingLinks>
    <Link>
      <Name>sample string 2</Name>
      <Url>sample string 1</Url>
    </Link>
    <Link>
      <Name>sample string 2</Name>
      <Url>sample string 1</Url>
    </Link>
  </BookingLinks>
  <CanonicalUrl>sample string 10</CanonicalUrl>
  <Capacity>1</Capacity>
  <Category>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Category>
  <ContactInformation>
    <Email>sample string 4</Email>
    <Fax>sample string 3</Fax>
    <Link>
      <Name>sample string 2</Name>
      <Url>sample string 1</Url>
    </Link>
    <Mobile>sample string 2</Mobile>
    <Phone>sample string 1</Phone>
  </ContactInformation>
  <Created>2020-11-26T14:26:33.3383487+01:00</Created>
  <CreatedBy>sample string 3</CreatedBy>
  <Descriptions>
    <Description>
      <DescriptionType>sample string 2</DescriptionType>
      <DescriptionTypeID>1</DescriptionTypeID>
      <Html>sample string 4</Html>
      <Text>sample string 3</Text>
    </Description>
    <Description>
      <DescriptionType>sample string 2</DescriptionType>
      <DescriptionTypeID>1</DescriptionTypeID>
      <Html>sample string 4</Html>
      <Text>sample string 3</Text>
    </Description>
  </Descriptions>
  <Distances>
    <Distance>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Distance>
    <Distance>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Distance>
  </Distances>
  <ExternalLinks>
    <ExternalLink>
      <Name>sample string 3</Name>
      <Url>sample string 2</Url>
      <LinkType>sample string 1</LinkType>
    </ExternalLink>
    <ExternalLink>
      <Name>sample string 3</Name>
      <Url>sample string 2</Url>
      <LinkType>sample string 1</LinkType>
    </ExternalLink>
  </ExternalLinks>
  <Files>
    <File>
      <AltText>sample string 7</AltText>
      <Copyright>sample string 5</Copyright>
      <Description>sample string 8</Description>
      <FileType>sample string 3</FileType>
      <Id>1</Id>
      <MetaTag>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </MetaTag>
      <Name>sample string 2</Name>
      <Photographer>sample string 6</Photographer>
      <Uri>sample string 4</Uri>
    </File>
    <File>
      <AltText>sample string 7</AltText>
      <Copyright>sample string 5</Copyright>
      <Description>sample string 8</Description>
      <FileType>sample string 3</FileType>
      <Id>1</Id>
      <MetaTag>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </MetaTag>
      <Name>sample string 2</Name>
      <Photographer>sample string 6</Photographer>
      <Uri>sample string 4</Uri>
    </File>
  </Files>
  <Id>1</Id>
  <Language>sample string 8</Language>
  <MainCategory>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </MainCategory>
  <MediaChannels>
    <MediaChannel>
      <ChannelName>sample string 2</ChannelName>
      <Id>1</Id>
    </MediaChannel>
    <MediaChannel>
      <ChannelName>sample string 2</ChannelName>
      <Id>1</Id>
    </MediaChannel>
  </MediaChannels>
  <MetaTags>
    <ProductMetaTag>
      <Comment>sample string 3</Comment>
      <Id>1</Id>
      <MetaTagGroup>
        <CanonicalName>sample string 4</CanonicalName>
        <CategoryId>2</CategoryId>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ShowOnWeb>true</ShowOnWeb>
        <UseInSearch>true</UseInSearch>
      </MetaTagGroup>
      <Name>sample string 2</Name>
    </ProductMetaTag>
    <ProductMetaTag>
      <Comment>sample string 3</Comment>
      <Id>1</Id>
      <MetaTagGroup>
        <CanonicalName>sample string 4</CanonicalName>
        <CategoryId>2</CategoryId>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ShowOnWeb>true</ShowOnWeb>
        <UseInSearch>true</UseInSearch>
      </MetaTagGroup>
      <Name>sample string 2</Name>
    </ProductMetaTag>
  </MetaTags>
  <Modified>2020-11-26T14:26:33.3383487+01:00</Modified>
  <ModifiedBy>sample string 5</ModifiedBy>
  <Name>sample string 9</Name>
  <Online>true</Online>
  <Owner>
    <Address>
      <AddressLine1>sample string 1</AddressLine1>
      <AddressLine2>sample string 2</AddressLine2>
      <City>sample string 4</City>
      <GeoCoordinate>
        <Latitude>1.1</Latitude>
        <Longitude>2.1</Longitude>
      </GeoCoordinate>
      <Municipality>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Municipality>
      <PostalCode>sample string 3</PostalCode>
      <Region>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </Region>
    </Address>
    <Email>sample string 3</Email>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Owner>
  <Periods>
    <Period>
      <EndDate>2020-11-26T14:26:33.3383487+01:00</EndDate>
      <EndTime>PT0.1234567S</EndTime>
      <Friday>true</Friday>
      <Id>1</Id>
      <Monday>true</Monday>
      <PriceGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </PriceGroupIds>
      <Saturday>true</Saturday>
      <StartDate>2020-11-26T14:26:33.3383487+01:00</StartDate>
      <StartTime>PT0.1234567S</StartTime>
      <Sunday>true</Sunday>
      <Thursday>true</Thursday>
      <Tuesday>true</Tuesday>
      <Wednesday>true</Wednesday>
    </Period>
    <Period>
      <EndDate>2020-11-26T14:26:33.3383487+01:00</EndDate>
      <EndTime>PT0.1234567S</EndTime>
      <Friday>true</Friday>
      <Id>1</Id>
      <Monday>true</Monday>
      <PriceGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </PriceGroupIds>
      <Saturday>true</Saturday>
      <StartDate>2020-11-26T14:26:33.3383487+01:00</StartDate>
      <StartTime>PT0.1234567S</StartTime>
      <Sunday>true</Sunday>
      <Thursday>true</Thursday>
      <Tuesday>true</Tuesday>
      <Wednesday>true</Wednesday>
    </Period>
  </Periods>
  <PeriodsLink>
    <Name>sample string 2</Name>
    <Url>sample string 1</Url>
  </PeriodsLink>
  <Places>
    <Place>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Place>
    <Place>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Place>
  </Places>
  <PriceGroups>
    <PriceGroup>
      <Free>true</Free>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <PeriodIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </PeriodIds>
      <PriceFrom>1</PriceFrom>
      <PriceLevel>sample string 3</PriceLevel>
      <PriceTo>1</PriceTo>
    </PriceGroup>
    <PriceGroup>
      <Free>true</Free>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <PeriodIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </PeriodIds>
      <PriceFrom>1</PriceFrom>
      <PriceLevel>sample string 3</PriceLevel>
      <PriceTo>1</PriceTo>
    </PriceGroup>
  </PriceGroups>
  <PriceGroupsLink>
    <Name>sample string 2</Name>
    <Url>sample string 1</Url>
  </PriceGroupsLink>
  <Priority>11</Priority>
  <RelatedProducts>
    <RelatedProduct>
      <Id>1</Id>
      <Name>sample string 3</Name>
      <OfficeId>2</OfficeId>
    </RelatedProduct>
    <RelatedProduct>
      <Id>1</Id>
      <Name>sample string 3</Name>
      <OfficeId>2</OfficeId>
    </RelatedProduct>
  </RelatedProducts>
  <Rooms>
    <Room>
      <Features>
        <RoomFeature>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </RoomFeature>
        <RoomFeature>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </RoomFeature>
      </Features>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Room>
    <Room>
      <Features>
        <RoomFeature>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </RoomFeature>
        <RoomFeature>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Value>sample string 3</Value>
        </RoomFeature>
      </Features>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Room>
  </Rooms>
  <Routes>
    <Route>
      <Description>sample string 3</Description>
      <GeoCoordinates>
        <GeoCoordinate>
          <Latitude>1.1</Latitude>
          <Longitude>2.1</Longitude>
        </GeoCoordinate>
        <GeoCoordinate>
          <Latitude>1.1</Latitude>
          <Longitude>2.1</Longitude>
        </GeoCoordinate>
      </GeoCoordinates>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Route>
    <Route>
      <Description>sample string 3</Description>
      <GeoCoordinates>
        <GeoCoordinate>
          <Latitude>1.1</Latitude>
          <Longitude>2.1</Longitude>
        </GeoCoordinate>
        <GeoCoordinate>
          <Latitude>1.1</Latitude>
          <Longitude>2.1</Longitude>
        </GeoCoordinate>
      </GeoCoordinates>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </Route>
  </Routes>
  <Serialized>2020-11-26T14:26:33.3383487+01:00</Serialized>
  <SocialMediaLinks>
    <Link>
      <Name>sample string 2</Name>
      <Url>sample string 1</Url>
    </Link>
    <Link>
      <Name>sample string 2</Name>
      <Url>sample string 1</Url>
    </Link>
  </SocialMediaLinks>
</Product>