Read Product Category

Parameters

Path Params
yourCompany:	string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/ProductsCategory will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/ProductsCategory

Query Params
filter:	string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. CategoryName,eq,Laptop 1) To fetch Products Category with CategoryName equal to Laptop https://xyzcompany.agiliron.net/agiliron/api-40/Products?filter=CategoryName,eq,Laptop&key=xyzkey 2) To fetch Category with CategoryName 'Brands' OR 'Hardware' (Use OR between two values), the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/ProductsCategory?filter=CategoryName,eq,Brands OR Hardware&key=xyzkey List of condition abbrevations to be used: "cs": contain string (string contains value) "sw": start with (string starts with value) "ew": end with (string end with value) "neq": not equal (string or number should not match) "eq": equal (string or number matches exactly) "lt": lower than (number is lower than value) "le": lower or equal (number is lower than or equal to value) "ge": greater or equal (number is higher than or equal to value) "gt": greater than (number is higher than value) "bt": between (number is between two comma separated values)
showImageData:	string In this parameter yes or no value needs to be passed respectively to fetch image data or to skip image data in response.for eg. showImageData=No (By default value for showImageData will be Yes) 1) To fetch Products Category with CategoryName equal to Laptop and without image data, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/ProductsCategory?filter=CategoryName,eq,Laptop&key=xyzkey&showImageData=No
page:	int Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch Products Category with CategoryName equal to Laptop and page equal to 10 https://xyzcompany.agiliron.net/agiliron/api-40/Products?filter=CategoryName,eq,Laptop&page=10&key=xyzkey
pageSize:	int In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch Products Category with CategoryName equal to Laptop and page size equal to 10 https://xyzcompany.agiliron.net/agiliron/api-40/Products?filter=CategoryName,eq,Laptop&pageSize=10&key=xyzkey

Header Params
Accept:	string Response header need to be passed for eg. application/json or application/xml.

Query Auth
key:	string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth
apiKey:	string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code

{
	"Categories": {
		"Category": [{
			"CategoryId": "924",
			"SortOrderId": "924",
			"CategoryName": "HP",
			"ChannelDisplayOrder": "924",
			"ParentCategory": "Laptop",
			"CategoryDescription": "Category description goes here",
			"SeoTitle": "Seo title goes here",
			"SeoDescription": "Seo description goes here",
			"SeoKeywords": "Seo keywords goes here"
		}
	}],
		"TotalRecords": "1",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}

<Categories>
    <Category>
        <CategoryId>924</CategoryId>
        <SortOrderId>924</SortOrderId>
        <CategoryName>HP</CategoryName>
        <ChannelDisplayOrder>924</ChannelDisplayOrder>
        <ParentCategory>Laptop</ParentCategory>
        <CategoryDescription>Category description goes here</CategoryDescription>
        <SeoTitle>Seo title goes here</SeoTitle>
        <SeoDescription>Seo description goes here</SeoDescription>
        <SeoKeywords>Seo keywords goes here</SeoKeywords>
    </Category>
    <TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</Categories>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="ProductsCategory"> 
       <method name="GET">
	   <resource path="{CategoryName}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>