POST GetTaxSettingByChannelProperty?SID={SID}&bCacheRefresh={bCacheRefresh}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SID

integer

Required

bCacheRefresh

boolean

Default value is False

Body Parameters

TaxChannelProperty
NameDescriptionTypeAdditional information
ChannelNames

Collection of string

None.

ChannelIds

Collection of integer

None.

PropertyId

Collection of integer

None.

Request Formats

application/json, text/json

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

text/html

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

application/xml, text/xml

Sample:
<TaxChannelProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Settings">
  <ChannelIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ChannelIds>
  <ChannelNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ChannelNames>
  <PropertyId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PropertyId>
</TaxChannelProperty>

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 'TaxChannelProperty'.

Response Information

Resource Description

ResponseOfListOfTaxSetting
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

Collection of TaxSetting

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "SID": 1,
      "TaxSettingId": 2,
      "Channels": [
        {
          "ChannelId": 1,
          "ChannelName": "sample string 2"
        },
        {
          "ChannelId": 1,
          "ChannelName": "sample string 2"
        }
      ],
      "Properties": [
        {
          "PropertyId": 1,
          "PropertyName": "sample string 2"
        },
        {
          "PropertyId": 1,
          "PropertyName": "sample string 2"
        }
      ],
      "Currency": "sample string 3",
      "Action": "sample string 4",
      "CreatedById": 1,
      "CreatedByName": "sample string 5",
      "CreatedOn": "2025-04-28T16:38:59.9572252+00:00",
      "UpdatedById": 1,
      "UpdatedByName": "sample string 6",
      "UpdatedOn": "2025-04-28T16:38:59.9572252+00:00",
      "TaxValue": "sample string 7",
      "CreatedByPGHUserName": "sample string 8"
    },
    {
      "SID": 1,
      "TaxSettingId": 2,
      "Channels": [
        {
          "ChannelId": 1,
          "ChannelName": "sample string 2"
        },
        {
          "ChannelId": 1,
          "ChannelName": "sample string 2"
        }
      ],
      "Properties": [
        {
          "PropertyId": 1,
          "PropertyName": "sample string 2"
        },
        {
          "PropertyId": 1,
          "PropertyName": "sample string 2"
        }
      ],
      "Currency": "sample string 3",
      "Action": "sample string 4",
      "CreatedById": 1,
      "CreatedByName": "sample string 5",
      "CreatedOn": "2025-04-28T16:38:59.9572252+00:00",
      "UpdatedById": 1,
      "UpdatedByName": "sample string 6",
      "UpdatedOn": "2025-04-28T16:38:59.9572252+00:00",
      "TaxValue": "sample string 7",
      "CreatedByPGHUserName": "sample string 8"
    }
  ]
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":[{"SID":1,"TaxSettingId":2,"Channels":[{"ChannelId":1,"ChannelName":"sample string 2"},{"ChannelId":1,"ChannelName":"sample string 2"}],"Properties":[{"PropertyId":1,"PropertyName":"sample string 2"},{"PropertyId":1,"PropertyName":"sample string 2"}],"Currency":"sample string 3","Action":"sample string 4","CreatedById":1,"CreatedByName":"sample string 5","CreatedOn":"2025-04-28T16:38:59.9572252+00:00","UpdatedById":1,"UpdatedByName":"sample string 6","UpdatedOn":"2025-04-28T16:38:59.9572252+00:00","TaxValue":"sample string 7","CreatedByPGHUserName":"sample string 8"},{"SID":1,"TaxSettingId":2,"Channels":[{"ChannelId":1,"ChannelName":"sample string 2"},{"ChannelId":1,"ChannelName":"sample string 2"}],"Properties":[{"PropertyId":1,"PropertyName":"sample string 2"},{"PropertyId":1,"PropertyName":"sample string 2"}],"Currency":"sample string 3","Action":"sample string 4","CreatedById":1,"CreatedByName":"sample string 5","CreatedOn":"2025-04-28T16:38:59.9572252+00:00","UpdatedById":1,"UpdatedByName":"sample string 6","UpdatedOn":"2025-04-28T16:38:59.9572252+00:00","TaxValue":"sample string 7","CreatedByPGHUserName":"sample string 8"}]}

application/xml, text/xml

Sample:
<ResponseOfArrayOfTaxSettinghxVPT35K 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.Settings">
    <d2p1:TaxSetting>
      <d2p1:Action>sample string 4</d2p1:Action>
      <d2p1:Channels>
        <d2p1:Channel>
          <d2p1:ChannelId>1</d2p1:ChannelId>
          <d2p1:ChannelName>sample string 2</d2p1:ChannelName>
        </d2p1:Channel>
        <d2p1:Channel>
          <d2p1:ChannelId>1</d2p1:ChannelId>
          <d2p1:ChannelName>sample string 2</d2p1:ChannelName>
        </d2p1:Channel>
      </d2p1:Channels>
      <d2p1:CreatedById>1</d2p1:CreatedById>
      <d2p1:CreatedByName>sample string 5</d2p1:CreatedByName>
      <d2p1:CreatedByPGHUserName>sample string 8</d2p1:CreatedByPGHUserName>
      <d2p1:CreatedOn>2025-04-28T16:38:59.9572252+00:00</d2p1:CreatedOn>
      <d2p1:Currency>sample string 3</d2p1:Currency>
      <d2p1:Properties>
        <d2p1:Property>
          <d2p1:PropertyId>1</d2p1:PropertyId>
          <d2p1:PropertyName>sample string 2</d2p1:PropertyName>
        </d2p1:Property>
        <d2p1:Property>
          <d2p1:PropertyId>1</d2p1:PropertyId>
          <d2p1:PropertyName>sample string 2</d2p1:PropertyName>
        </d2p1:Property>
      </d2p1:Properties>
      <d2p1:SID>1</d2p1:SID>
      <d2p1:TaxSettingId>2</d2p1:TaxSettingId>
      <d2p1:TaxValue>sample string 7</d2p1:TaxValue>
      <d2p1:UpdatedById>1</d2p1:UpdatedById>
      <d2p1:UpdatedByName>sample string 6</d2p1:UpdatedByName>
      <d2p1:UpdatedOn>2025-04-28T16:38:59.9572252+00:00</d2p1:UpdatedOn>
    </d2p1:TaxSetting>
    <d2p1:TaxSetting>
      <d2p1:Action>sample string 4</d2p1:Action>
      <d2p1:Channels>
        <d2p1:Channel>
          <d2p1:ChannelId>1</d2p1:ChannelId>
          <d2p1:ChannelName>sample string 2</d2p1:ChannelName>
        </d2p1:Channel>
        <d2p1:Channel>
          <d2p1:ChannelId>1</d2p1:ChannelId>
          <d2p1:ChannelName>sample string 2</d2p1:ChannelName>
        </d2p1:Channel>
      </d2p1:Channels>
      <d2p1:CreatedById>1</d2p1:CreatedById>
      <d2p1:CreatedByName>sample string 5</d2p1:CreatedByName>
      <d2p1:CreatedByPGHUserName>sample string 8</d2p1:CreatedByPGHUserName>
      <d2p1:CreatedOn>2025-04-28T16:38:59.9572252+00:00</d2p1:CreatedOn>
      <d2p1:Currency>sample string 3</d2p1:Currency>
      <d2p1:Properties>
        <d2p1:Property>
          <d2p1:PropertyId>1</d2p1:PropertyId>
          <d2p1:PropertyName>sample string 2</d2p1:PropertyName>
        </d2p1:Property>
        <d2p1:Property>
          <d2p1:PropertyId>1</d2p1:PropertyId>
          <d2p1:PropertyName>sample string 2</d2p1:PropertyName>
        </d2p1:Property>
      </d2p1:Properties>
      <d2p1:SID>1</d2p1:SID>
      <d2p1:TaxSettingId>2</d2p1:TaxSettingId>
      <d2p1:TaxValue>sample string 7</d2p1:TaxValue>
      <d2p1:UpdatedById>1</d2p1:UpdatedById>
      <d2p1:UpdatedByName>sample string 6</d2p1:UpdatedByName>
      <d2p1:UpdatedOn>2025-04-28T16:38:59.9572252+00:00</d2p1:UpdatedOn>
    </d2p1:TaxSetting>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfTaxSettinghxVPT35K>