GET api/stateProvince/{id}/description

Gets the description of a state-province.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The state-province id.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A LocationDescriptionViewModel object.

Cyberlogic.eTourism.Domain.ViewModels.Location.LocationDescriptionViewModel
NameDescriptionTypeAdditional information
LocationId

integer

None.

LocationType

string

None.

Name

string

None.

Overview

Collection of Cyberlogic.eTourism.Domain.ViewModels.Location.LocationOverviewViewModel

None.

Media

Cyberlogic.eTourism.Domain.ViewModels.Shared.MediaViewModel

None.

Position

Cyberlogic.eTourism.Domain.ViewModels.Shared.PositionViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "LocationId": 1,
  "LocationType": "sample string 2",
  "Name": "sample string 3",
  "Overview": [
    {
      "Language": {
        "Id": 1,
        "Name": "sample string 2",
        "InternetCode": "sample string 3"
      },
      "Description": {
        "Name": "sample string 1",
        "MainDescription": "sample string 2"
      }
    },
    {
      "Language": {
        "Id": 1,
        "Name": "sample string 2",
        "InternetCode": "sample string 3"
      },
      "Description": {
        "Name": "sample string 1",
        "MainDescription": "sample string 2"
      }
    }
  ],
  "Media": {
    "DefaultImage": {
      "MainUrl": "sample string 1",
      "ThumbUrl": "sample string 2"
    },
    "DefaultVideo": "sample string 1",
    "Images": [
      {
        "MainUrl": "sample string 1",
        "ThumbUrl": "sample string 2",
        "Tags": [
          "sample string 1",
          "sample string 2"
        ],
        "Description": [
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          },
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          }
        ]
      },
      {
        "MainUrl": "sample string 1",
        "ThumbUrl": "sample string 2",
        "Tags": [
          "sample string 1",
          "sample string 2"
        ],
        "Description": [
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          },
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          }
        ]
      }
    ],
    "Videos": [
      {
        "MainUrl": "sample string 1",
        "Description": [
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          },
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          }
        ]
      },
      {
        "MainUrl": "sample string 1",
        "Description": [
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          },
          {
            "Language": {
              "Id": 1,
              "Name": "sample string 2",
              "InternetCode": "sample string 3"
            },
            "Description": "sample string 1"
          }
        ]
      }
    ]
  },
  "Position": {
    "Longitude": 1.1,
    "Latitude": 2.1
  }
}

text/html

Sample:
{"LocationId":1,"LocationType":"sample string 2","Name":"sample string 3","Overview":[{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":{"Name":"sample string 1","MainDescription":"sample string 2"}},{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":{"Name":"sample string 1","MainDescription":"sample string 2"}}],"Media":{"DefaultImage":{"MainUrl":"sample string 1","ThumbUrl":"sample string 2"},"DefaultVideo":"sample string 1","Images":[{"MainUrl":"sample string 1","ThumbUrl":"sample string 2","Tags":["sample string 1","sample string 2"],"Description":[{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"},{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"}]},{"MainUrl":"sample string 1","ThumbUrl":"sample string 2","Tags":["sample string 1","sample string 2"],"Description":[{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"},{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"}]}],"Videos":[{"MainUrl":"sample string 1","Description":[{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"},{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"}]},{"MainUrl":"sample string 1","Description":[{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"},{"Language":{"Id":1,"Name":"sample string 2","InternetCode":"sample string 3"},"Description":"sample string 1"}]}]},"Position":{"Longitude":1.1,"Latitude":2.1}}

application/xml, text/xml

Sample:
<LocationDescriptionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Domain.ViewModels.Location">
  <LocationId>1</LocationId>
  <LocationType>sample string 2</LocationType>
  <Media xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Domain.ViewModels.Shared">
    <d2p1:DefaultImage>
      <d2p1:MainUrl>sample string 1</d2p1:MainUrl>
      <d2p1:ThumbUrl>sample string 2</d2p1:ThumbUrl>
    </d2p1:DefaultImage>
    <d2p1:DefaultVideo>sample string 1</d2p1:DefaultVideo>
    <d2p1:Images>
      <d2p1:ImageViewModel>
        <d2p1:Description>
          <d2p1:ImageDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:ImageDescriptionViewModel>
          <d2p1:ImageDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:ImageDescriptionViewModel>
        </d2p1:Description>
        <d2p1:MainUrl>sample string 1</d2p1:MainUrl>
        <d2p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Tags>
        <d2p1:ThumbUrl>sample string 2</d2p1:ThumbUrl>
      </d2p1:ImageViewModel>
      <d2p1:ImageViewModel>
        <d2p1:Description>
          <d2p1:ImageDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:ImageDescriptionViewModel>
          <d2p1:ImageDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:ImageDescriptionViewModel>
        </d2p1:Description>
        <d2p1:MainUrl>sample string 1</d2p1:MainUrl>
        <d2p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Tags>
        <d2p1:ThumbUrl>sample string 2</d2p1:ThumbUrl>
      </d2p1:ImageViewModel>
    </d2p1:Images>
    <d2p1:Videos>
      <d2p1:VideoViewModel>
        <d2p1:Description>
          <d2p1:VideoDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:VideoDescriptionViewModel>
          <d2p1:VideoDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:VideoDescriptionViewModel>
        </d2p1:Description>
        <d2p1:MainUrl>sample string 1</d2p1:MainUrl>
      </d2p1:VideoViewModel>
      <d2p1:VideoViewModel>
        <d2p1:Description>
          <d2p1:VideoDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:VideoDescriptionViewModel>
          <d2p1:VideoDescriptionViewModel>
            <d2p1:Description>sample string 1</d2p1:Description>
            <d2p1:Language>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:InternetCode>sample string 3</d2p1:InternetCode>
              <d2p1:Name>sample string 2</d2p1:Name>
            </d2p1:Language>
          </d2p1:VideoDescriptionViewModel>
        </d2p1:Description>
        <d2p1:MainUrl>sample string 1</d2p1:MainUrl>
      </d2p1:VideoViewModel>
    </d2p1:Videos>
  </Media>
  <Name>sample string 3</Name>
  <Overview>
    <LocationOverviewViewModel>
      <Description>
        <MainDescription>sample string 2</MainDescription>
        <Name>sample string 1</Name>
      </Description>
      <Language xmlns:d4p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Domain.ViewModels.Shared">
        <d4p1:Id>1</d4p1:Id>
        <d4p1:InternetCode>sample string 3</d4p1:InternetCode>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Language>
    </LocationOverviewViewModel>
    <LocationOverviewViewModel>
      <Description>
        <MainDescription>sample string 2</MainDescription>
        <Name>sample string 1</Name>
      </Description>
      <Language xmlns:d4p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Domain.ViewModels.Shared">
        <d4p1:Id>1</d4p1:Id>
        <d4p1:InternetCode>sample string 3</d4p1:InternetCode>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Language>
    </LocationOverviewViewModel>
  </Overview>
  <Position xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Domain.ViewModels.Shared">
    <d2p1:Latitude>2.1</d2p1:Latitude>
    <d2p1:Longitude>1.1</d2p1:Longitude>
  </Position>
</LocationDescriptionViewModel>