GET api/pos/modifiers?showMenuItems={showMenuItems}&showPOSItems={showPOSItems}&modifierIds={modifierIds}

Get Modifiers for a specified site. Optional parameters to fiter by a Modifier Id List formatted as a comma separated string.

Request Information

URI Parameters

Name	Type	Additional information
showMenuItems	boolean	None.
showPOSItems	boolean	None.
modifierIds	string	None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfPOSModifier

Name	Type	Additional information
Message	string	None.
Success	boolean	None.
StatusCode	HttpStatusCode	None.
Data	Collection of POSModifier	None.
Errors	Dictionary of string [key] and Collection of string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "success": true,
  "statusCode": 100,
  "data": [
    {
      "modifierId": 1,
      "modifierName": "sample string 2",
      "shortName": "sample string 3",
      "multiplier": 4.0
    },
    {
      "modifierId": 1,
      "modifierName": "sample string 2",
      "shortName": "sample string 3",
      "multiplier": 4.0
    }
  ],
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfPOSModifier175RJIq4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response.POS">
    <d2p1:POSModifier>
      <d2p1:Modifier_Id>1</d2p1:Modifier_Id>
      <d2p1:Modifier_Menu_Name>sample string 3</d2p1:Modifier_Menu_Name>
      <d2p1:Multiplier>4</d2p1:Multiplier>
      <d2p1:POS_Modifier_Name>sample string 2</d2p1:POS_Modifier_Name>
      <d2p1:Price_Tiers>
        <d2p1:ModifierPriceTier>
          <d2p1:Amount>3</d2p1:Amount>
          <d2p1:Modifier_Id>1</d2p1:Modifier_Id>
          <d2p1:Price_Tier_Id>2</d2p1:Price_Tier_Id>
        </d2p1:ModifierPriceTier>
        <d2p1:ModifierPriceTier>
          <d2p1:Amount>3</d2p1:Amount>
          <d2p1:Modifier_Id>1</d2p1:Modifier_Id>
          <d2p1:Price_Tier_Id>2</d2p1:Price_Tier_Id>
        </d2p1:ModifierPriceTier>
      </d2p1:Price_Tiers>
    </d2p1:POSModifier>
    <d2p1:POSModifier>
      <d2p1:Modifier_Id>1</d2p1:Modifier_Id>
      <d2p1:Modifier_Menu_Name>sample string 3</d2p1:Modifier_Menu_Name>
      <d2p1:Multiplier>4</d2p1:Multiplier>
      <d2p1:POS_Modifier_Name>sample string 2</d2p1:POS_Modifier_Name>
      <d2p1:Price_Tiers>
        <d2p1:ModifierPriceTier>
          <d2p1:Amount>3</d2p1:Amount>
          <d2p1:Modifier_Id>1</d2p1:Modifier_Id>
          <d2p1:Price_Tier_Id>2</d2p1:Price_Tier_Id>
        </d2p1:ModifierPriceTier>
        <d2p1:ModifierPriceTier>
          <d2p1:Amount>3</d2p1:Amount>
          <d2p1:Modifier_Id>1</d2p1:Modifier_Id>
          <d2p1:Price_Tier_Id>2</d2p1:Price_Tier_Id>
        </d2p1:ModifierPriceTier>
      </d2p1:Price_Tiers>
    </d2p1:POSModifier>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </Errors>
  <Message>sample string 1</Message>
  <StatusCode>Continue</StatusCode>
  <Success>true</Success>
</ResponseOfArrayOfPOSModifier175RJIq4>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Success"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

Continue
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Modifier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].POS_Modifier_Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Modifier_Menu_Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Multiplier"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Price_Tiers[0].Modifier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Price_Tiers[0].Price_Tier_Id"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Price_Tiers[0].Amount"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Price_Tiers[1].Modifier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Price_Tiers[1].Price_Tier_Id"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Price_Tiers[1].Amount"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Modifier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].POS_Modifier_Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Modifier_Menu_Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Multiplier"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Price_Tiers[0].Modifier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Price_Tiers[0].Price_Tier_Id"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Price_Tiers[0].Amount"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Price_Tiers[1].Modifier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Price_Tiers[1].Price_Tier_Id"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Price_Tiers[1].Amount"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--