POST GetUnmappedDescriptions?sid={sid}&channelId={channelId}&count={count}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sid

integer

Required

channelId

integer

Required

count

integer

Required

Body Parameters

Collection of PropertyDescription
NameDescriptionTypeAdditional information
PropertyId

integer

None.

Description

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "PropertyId": 1,
    "Description": "sample string 2"
  },
  {
    "PropertyId": 1,
    "Description": "sample string 2"
  }
]

text/html

Sample:
[{"PropertyId":1,"Description":"sample string 2"},{"PropertyId":1,"Description":"sample string 2"}]

application/xml, text/xml

Sample:
<ArrayOfPropertyDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.TagMapping">
  <PropertyDescription>
    <Description>sample string 2</Description>
    <PropertyId>1</PropertyId>
  </PropertyDescription>
  <PropertyDescription>
    <Description>sample string 2</Description>
    <PropertyId>1</PropertyId>
  </PropertyDescription>
</ArrayOfPropertyDescription>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

ResponseOfListOfRoomDescriptionDetails
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

Collection of RoomDescriptionDetails

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "PropertyId": 1,
      "ChannelId": 2,
      "TaggingSidPropChannelId": 3,
      "RoomDescriptions": [
        {
          "Description": "sample string 1",
          "Hash": "sample string 2",
          "TaggingSidPropChannelDescriptionId": 3
        },
        {
          "Description": "sample string 1",
          "Hash": "sample string 2",
          "TaggingSidPropChannelDescriptionId": 3
        }
      ],
      "IsMore": true
    },
    {
      "PropertyId": 1,
      "ChannelId": 2,
      "TaggingSidPropChannelId": 3,
      "RoomDescriptions": [
        {
          "Description": "sample string 1",
          "Hash": "sample string 2",
          "TaggingSidPropChannelDescriptionId": 3
        },
        {
          "Description": "sample string 1",
          "Hash": "sample string 2",
          "TaggingSidPropChannelDescriptionId": 3
        }
      ],
      "IsMore": true
    }
  ]
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":[{"PropertyId":1,"ChannelId":2,"TaggingSidPropChannelId":3,"RoomDescriptions":[{"Description":"sample string 1","Hash":"sample string 2","TaggingSidPropChannelDescriptionId":3},{"Description":"sample string 1","Hash":"sample string 2","TaggingSidPropChannelDescriptionId":3}],"IsMore":true},{"PropertyId":1,"ChannelId":2,"TaggingSidPropChannelId":3,"RoomDescriptions":[{"Description":"sample string 1","Hash":"sample string 2","TaggingSidPropChannelDescriptionId":3},{"Description":"sample string 1","Hash":"sample string 2","TaggingSidPropChannelDescriptionId":3}],"IsMore":true}]}

application/xml, text/xml

Sample:
<ResponseOfArrayOfRoomDescriptionDetailsu_PXb4S2D xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.TagMapping">
    <d2p1:RoomDescriptionDetails>
      <d2p1:ChannelId>2</d2p1:ChannelId>
      <d2p1:IsMore>true</d2p1:IsMore>
      <d2p1:PropertyId>1</d2p1:PropertyId>
      <d2p1:RoomDescriptions>
        <d2p1:RoomDescription>
          <d2p1:Description>sample string 1</d2p1:Description>
          <d2p1:Hash>sample string 2</d2p1:Hash>
          <d2p1:TaggingSidPropChannelDescriptionId>3</d2p1:TaggingSidPropChannelDescriptionId>
        </d2p1:RoomDescription>
        <d2p1:RoomDescription>
          <d2p1:Description>sample string 1</d2p1:Description>
          <d2p1:Hash>sample string 2</d2p1:Hash>
          <d2p1:TaggingSidPropChannelDescriptionId>3</d2p1:TaggingSidPropChannelDescriptionId>
        </d2p1:RoomDescription>
      </d2p1:RoomDescriptions>
      <d2p1:TaggingSidPropChannelId>3</d2p1:TaggingSidPropChannelId>
    </d2p1:RoomDescriptionDetails>
    <d2p1:RoomDescriptionDetails>
      <d2p1:ChannelId>2</d2p1:ChannelId>
      <d2p1:IsMore>true</d2p1:IsMore>
      <d2p1:PropertyId>1</d2p1:PropertyId>
      <d2p1:RoomDescriptions>
        <d2p1:RoomDescription>
          <d2p1:Description>sample string 1</d2p1:Description>
          <d2p1:Hash>sample string 2</d2p1:Hash>
          <d2p1:TaggingSidPropChannelDescriptionId>3</d2p1:TaggingSidPropChannelDescriptionId>
        </d2p1:RoomDescription>
        <d2p1:RoomDescription>
          <d2p1:Description>sample string 1</d2p1:Description>
          <d2p1:Hash>sample string 2</d2p1:Hash>
          <d2p1:TaggingSidPropChannelDescriptionId>3</d2p1:TaggingSidPropChannelDescriptionId>
        </d2p1:RoomDescription>
      </d2p1:RoomDescriptions>
      <d2p1:TaggingSidPropChannelId>3</d2p1:TaggingSidPropChannelId>
    </d2p1:RoomDescriptionDetails>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfRoomDescriptionDetailsu_PXb4S2D>