GET api/Products/GetProductByName/{securityCode}/{storeCode}

Returns an UpProduct JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities)

Request Information

URI Parameters

Name	Description	Type	Additional information
securityCode	Used for authorization	globally unique identifier	Required
storeCode	Used to specify target database	string	Required

Body Parameters

Mandatory body field(s): Name

ApiRequestObject

Name	Type	Additional information
Guid	globally unique identifier	None.
IgnoreCache	boolean	None.
Clean	boolean	None.
Range	integer	None.
Filter	string	None.
DataContractName	string	None.
Name	string	None.
DataSheetName	string	None.
TemplateName	string	None.
TemplateGroupName	string	None.
Variables	string	None.
SubDirectories	string	None.
Channel	string	None.
View	string	None.
Search	string	None.
Configuration	string	None.
Type	string	None.
Delimiter	string	None.
City	string	None.
Country	string	None.
Latitude	string	None.
Longitude	string	None.
PropertyTypes	string	None.
EntityTypes	string	None.
StateApproved	ExpressionFilterState	None.
StatePublished	ExpressionFilterState	None.
StateReferenceDate	ExpressionFilterState	None.

Request Formats

application/json, text/json

Sample:

{
  "Guid": "00b82f4e-bcd9-4edf-bb02-7e456c5ac0c6",
  "IgnoreCache": true,
  "Clean": true,
  "Range": 4,
  "Filter": "sample string 5",
  "DataContractName": "sample string 6",
  "Name": "sample string 7",
  "DataSheetName": "sample string 8",
  "TemplateName": "sample string 9",
  "TemplateGroupName": "sample string 10",
  "Variables": "sample string 11",
  "SubDirectories": "sample string 12",
  "Channel": "sample string 13",
  "View": "sample string 14",
  "Search": "sample string 15",
  "Configuration": "sample string 16",
  "Type": "sample string 17",
  "Delimiter": "sample string 18",
  "City": "sample string 19",
  "Country": "sample string 20",
  "Latitude": "sample string 21",
  "Longitude": "sample string 22",
  "PropertyTypes": "sample string 23",
  "EntityTypes": "sample string 24",
  "StateApproved": 0,
  "StatePublished": 0,
  "StateReferenceDate": 0
}

text/html, application/octet-stream

Sample:

{"Guid":"00b82f4e-bcd9-4edf-bb02-7e456c5ac0c6","IgnoreCache":true,"Clean":true,"Range":4,"Filter":"sample string 5","DataContractName":"sample string 6","Name":"sample string 7","DataSheetName":"sample string 8","TemplateName":"sample string 9","TemplateGroupName":"sample string 10","Variables":"sample string 11","SubDirectories":"sample string 12","Channel":"sample string 13","View":"sample string 14","Search":"sample string 15","Configuration":"sample string 16","Type":"sample string 17","Delimiter":"sample string 18","City":"sample string 19","Country":"sample string 20","Latitude":"sample string 21","Longitude":"sample string 22","PropertyTypes":"sample string 23","EntityTypes":"sample string 24","StateApproved":0,"StatePublished":0,"StateReferenceDate":0}

application/xml, text/xml

Sample:

<ApiRequestObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Up.Engine.Service.WebAPI.Models">
  <Channel>sample string 13</Channel>
  <City>sample string 19</City>
  <Clean>true</Clean>
  <Configuration>sample string 16</Configuration>
  <Country>sample string 20</Country>
  <DataContractName>sample string 6</DataContractName>
  <DataSheetName>sample string 8</DataSheetName>
  <Delimiter>sample string 18</Delimiter>
  <EntityTypes>sample string 24</EntityTypes>
  <Filter>sample string 5</Filter>
  <Guid>00b82f4e-bcd9-4edf-bb02-7e456c5ac0c6</Guid>
  <IgnoreCache>true</IgnoreCache>
  <Latitude>sample string 21</Latitude>
  <Longitude>sample string 22</Longitude>
  <Name>sample string 7</Name>
  <PropertyTypes>sample string 23</PropertyTypes>
  <Range>4</Range>
  <Search>sample string 15</Search>
  <StateApproved>True</StateApproved>
  <StatePublished>True</StatePublished>
  <StateReferenceDate>True</StateReferenceDate>
  <SubDirectories>sample string 12</SubDirectories>
  <TemplateGroupName>sample string 10</TemplateGroupName>
  <TemplateName>sample string 9</TemplateName>
  <Type>sample string 17</Type>
  <Variables>sample string 11</Variables>
  <View>sample string 14</View>
</ApiRequestObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UpProduct

Name	Type	Additional information
Guid	globally unique identifier	None.
CallName	string	None.
Name	string	None.
Description	string	None.
ModifyDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "Guid": "91290cdb-cf1d-4476-8db3-25cbe2c4ac71",
  "CallName": "sample string 2",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "ModifyDate": "2026-01-13T19:02:06.5549129+01:00"
}

text/html, application/octet-stream

Sample:

{"Guid":"91290cdb-cf1d-4476-8db3-25cbe2c4ac71","CallName":"sample string 2","Name":"sample string 3","Description":"sample string 4","ModifyDate":"2026-01-13T19:02:06.5549129+01:00"}

application/xml, text/xml

Sample:

<UpProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Up.Engine.Service.Data.Model">
  <CallName>sample string 2</CallName>
  <Description>sample string 4</Description>
  <Guid>91290cdb-cf1d-4476-8db3-25cbe2c4ac71</Guid>
  <ModifyDate>2026-01-13T19:02:06.5549129+01:00</ModifyDate>
  <Name>sample string 3</Name>
</UpProduct>