GET api/IR/GetIRData?userId={userId}&categoryId={categoryId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId | integer |
Required |
|
| categoryId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
IRReturnVm| Name | Description | Type | Additional information |
|---|---|---|---|
| PredictionKey | string |
None. |
|
| PredictionUrl | string |
None. |
|
| ShareOfShelfMethod | string |
None. |
|
| SKUs | Collection of IRSKU |
None. |
|
| Brands | Collection of IRBrand |
None. |
|
| Branches | Collection of IRBranch |
None. |
|
| Channels | Collection of IRChannel |
None. |
Response Formats
application/json, text/json
Sample:
{
"PredictionKey": "sample string 1",
"PredictionUrl": "sample string 2",
"ShareOfShelfMethod": "sample string 3",
"SKUs": [
{
"Id": 1,
"Name": "sample string 2",
"Tags": "sample string 3",
"IsCompetition": true,
"BrandId": 5,
"BrandName": "sample string 6",
"SubCategoryId": 7,
"SubCategoryName": "sample string 8",
"Width": 9.0,
"Height": 10.0
},
{
"Id": 1,
"Name": "sample string 2",
"Tags": "sample string 3",
"IsCompetition": true,
"BrandId": 5,
"BrandName": "sample string 6",
"SubCategoryId": 7,
"SubCategoryName": "sample string 8",
"Width": 9.0,
"Height": 10.0
}
],
"Brands": [
{
"Id": 1,
"Name": "sample string 2",
"Target": 3.0,
"IsCompetition": true,
"ChannelId": 5,
"ChannelName": "sample string 6",
"Logo": "sample string 7",
"SubCategories": [
{
"Id": 1,
"Name": "sample string 2",
"Target": 3.0,
"ChannelId": 4,
"ChannelName": "sample string 5"
},
{
"Id": 1,
"Name": "sample string 2",
"Target": 3.0,
"ChannelId": 4,
"ChannelName": "sample string 5"
}
]
},
{
"Id": 1,
"Name": "sample string 2",
"Target": 3.0,
"IsCompetition": true,
"ChannelId": 5,
"ChannelName": "sample string 6",
"Logo": "sample string 7",
"SubCategories": [
{
"Id": 1,
"Name": "sample string 2",
"Target": 3.0,
"ChannelId": 4,
"ChannelName": "sample string 5"
},
{
"Id": 1,
"Name": "sample string 2",
"Target": 3.0,
"ChannelId": 4,
"ChannelName": "sample string 5"
}
]
}
],
"Branches": [
{
"ChannelId": 1,
"CustomerId": 2,
"BranchId": 3,
"ChannelName": "sample string 4",
"CustomerName": "sample string 5",
"BranchName": "sample string 6",
"Latitude": "sample string 7",
"Longitude": "sample string 8"
},
{
"ChannelId": 1,
"CustomerId": 2,
"BranchId": 3,
"ChannelName": "sample string 4",
"CustomerName": "sample string 5",
"BranchName": "sample string 6",
"Latitude": "sample string 7",
"Longitude": "sample string 8"
}
],
"Channels": [
{
"Id": 1,
"Name": "sample string 2"
},
{
"Id": 1,
"Name": "sample string 2"
}
]
}
text/xml
Sample:
<IRReturnVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EYE2Api.Models">
<Branches>
<IRBranch>
<BranchId>3</BranchId>
<BranchName>sample string 6</BranchName>
<ChannelId>1</ChannelId>
<ChannelName>sample string 4</ChannelName>
<CustomerId>2</CustomerId>
<CustomerName>sample string 5</CustomerName>
<Latitude>sample string 7</Latitude>
<Longitude>sample string 8</Longitude>
</IRBranch>
<IRBranch>
<BranchId>3</BranchId>
<BranchName>sample string 6</BranchName>
<ChannelId>1</ChannelId>
<ChannelName>sample string 4</ChannelName>
<CustomerId>2</CustomerId>
<CustomerName>sample string 5</CustomerName>
<Latitude>sample string 7</Latitude>
<Longitude>sample string 8</Longitude>
</IRBranch>
</Branches>
<Brands>
<IRBrand>
<ChannelId>5</ChannelId>
<ChannelName>sample string 6</ChannelName>
<Id>1</Id>
<IsCompetition>true</IsCompetition>
<Logo>sample string 7</Logo>
<Name>sample string 2</Name>
<SubCategories>
<IRSubCategory>
<ChannelId>4</ChannelId>
<ChannelName>sample string 5</ChannelName>
<Id>1</Id>
<Name>sample string 2</Name>
<Target>3</Target>
</IRSubCategory>
<IRSubCategory>
<ChannelId>4</ChannelId>
<ChannelName>sample string 5</ChannelName>
<Id>1</Id>
<Name>sample string 2</Name>
<Target>3</Target>
</IRSubCategory>
</SubCategories>
<Target>3</Target>
</IRBrand>
<IRBrand>
<ChannelId>5</ChannelId>
<ChannelName>sample string 6</ChannelName>
<Id>1</Id>
<IsCompetition>true</IsCompetition>
<Logo>sample string 7</Logo>
<Name>sample string 2</Name>
<SubCategories>
<IRSubCategory>
<ChannelId>4</ChannelId>
<ChannelName>sample string 5</ChannelName>
<Id>1</Id>
<Name>sample string 2</Name>
<Target>3</Target>
</IRSubCategory>
<IRSubCategory>
<ChannelId>4</ChannelId>
<ChannelName>sample string 5</ChannelName>
<Id>1</Id>
<Name>sample string 2</Name>
<Target>3</Target>
</IRSubCategory>
</SubCategories>
<Target>3</Target>
</IRBrand>
</Brands>
<Channels>
<IRChannel>
<Id>1</Id>
<Name>sample string 2</Name>
</IRChannel>
<IRChannel>
<Id>1</Id>
<Name>sample string 2</Name>
</IRChannel>
</Channels>
<PredictionKey>sample string 1</PredictionKey>
<PredictionUrl>sample string 2</PredictionUrl>
<SKUs>
<IRSKU>
<BrandId>5</BrandId>
<BrandName>sample string 6</BrandName>
<Height>10</Height>
<Id>1</Id>
<IsCompetition>true</IsCompetition>
<Name>sample string 2</Name>
<SubCategoryId>7</SubCategoryId>
<SubCategoryName>sample string 8</SubCategoryName>
<Tags>sample string 3</Tags>
<Width>9</Width>
</IRSKU>
<IRSKU>
<BrandId>5</BrandId>
<BrandName>sample string 6</BrandName>
<Height>10</Height>
<Id>1</Id>
<IsCompetition>true</IsCompetition>
<Name>sample string 2</Name>
<SubCategoryId>7</SubCategoryId>
<SubCategoryName>sample string 8</SubCategoryName>
<Tags>sample string 3</Tags>
<Width>9</Width>
</IRSKU>
</SKUs>
<ShareOfShelfMethod>sample string 3</ShareOfShelfMethod>
</IRReturnVm>