GET api/v7/RestrictionDetail/{restrictionCode}

Retrieve the products and hierarchies related to a given Restriction Code

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
restrictionCode *

the Restriction Code to search for

string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

Restriction Products and Hierarchies

RestrictionDetailDto
NameDescriptionType
RestrictionCode

Restriction code

string
ProductList

Restriction product list

Collection of RestrictionProductDto
HierarchyList

Hierarchy product list

Collection of RestrictionHierarchyDto

Response Formats

application/json, text/json

Sample:
{
  "RestrictionCode": "sample string 1",
  "ProductList": [
    {
      "OrgUnitName": "sample string 1",
      "ProductCode": "sample string 2"
    },
    {
      "OrgUnitName": "sample string 1",
      "ProductCode": "sample string 2"
    }
  ],
  "HierarchyList": [
    {
      "OrgUnitName": "sample string 1",
      "HierarchyCode": "sample string 2"
    },
    {
      "OrgUnitName": "sample string 1",
      "HierarchyCode": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<RestrictionDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <RestrictionCode>sample string 1</RestrictionCode>
  <ProductList>
    <RestrictionProductDto>
      <OrgUnitName>sample string 1</OrgUnitName>
      <ProductCode>sample string 2</ProductCode>
    </RestrictionProductDto>
    <RestrictionProductDto>
      <OrgUnitName>sample string 1</OrgUnitName>
      <ProductCode>sample string 2</ProductCode>
    </RestrictionProductDto>
  </ProductList>
  <HierarchyList>
    <RestrictionHierarchyDto>
      <OrgUnitName>sample string 1</OrgUnitName>
      <HierarchyCode>sample string 2</HierarchyCode>
    </RestrictionHierarchyDto>
    <RestrictionHierarchyDto>
      <OrgUnitName>sample string 1</OrgUnitName>
      <HierarchyCode>sample string 2</HierarchyCode>
    </RestrictionHierarchyDto>
  </HierarchyList>
</RestrictionDetail>