POST api/possettingheaders/store/{storeID}/import

Imports POS setting headers from a store; processes the headers async

Request Information

URI Parameters

Name	Description	Type	Additional information
storeID	store to save the POS setting headers at	integer	Required

Body Parameters

List of POS setting headers to import

Collection of POSSettingHeader

Name	Description	Type	Additional information
Type	Type that this setting is (bool, enum, json, ect)	CheckoutSettingType	None.
PossibleValues	JSON that Defines the possible values that 'Value' can be. Excluded if the type is self-expanatory (E.G a bool has possible values of 'true' and 'false')	string	None.
DefaultValue	The default value of this setting	string	None.
Description	User-readable description of what this setting does	string	None.
Section	Section under which this setting is saved	string	None.
SubSection	Sub section / tab under which this setting is displayed in the UI	string	None.
KeyName	Keyname under which this setting is saved. Combo of Section + KeyName is unique per setting	string	None.
Scope	Defines the level/scope that this setting applies at	CheckoutSettingScope	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "type": 0,
    "possibleValues": "sample string 1",
    "defaultValue": "sample string 2",
    "description": "sample string 3",
    "section": "sample string 4",
    "subSection": "sample string 5",
    "keyName": "sample string 6",
    "scope": 0
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPOSSettingHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager">
  <POSSettingHeader>
    <DefaultValue>sample string 2</DefaultValue>
    <Description>sample string 3</Description>
    <KeyName>sample string 6</KeyName>
    <PossibleValues>sample string 1</PossibleValues>
    <Scope>Terminal</Scope>
    <Section>sample string 4</Section>
    <SubSection>sample string 5</SubSection>
    <Type>Long</Type>
  </POSSettingHeader>
  <POSSettingHeader>
    <DefaultValue>sample string 2</DefaultValue>
    <Description>sample string 3</Description>
    <KeyName>sample string 6</KeyName>
    <PossibleValues>sample string 1</PossibleValues>
    <Scope>Terminal</Scope>
    <Section>sample string 4</Section>
    <SubSection>sample string 5</SubSection>
    <Type>Long</Type>
  </POSSettingHeader>
</ArrayOfPOSSettingHeader>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.