POST api/pos/toggleplu

Enable or disable a PLU, or a list of PLU's. A site id, PLU Id/'s is required, as well as a show in menu/POS flag.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
pluIds	string	None.
showInMenu	boolean	None.
showInPOS	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "pluIds": "sample string 1",
  "showInMenu": true,
  "showInPOS": true
}

application/xml, text/xml

Sample:

<TogglePLU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.POS">
  <ShowInMenu>true</ShowInMenu>
  <ShowInPOS>true</ShowInPOS>
  <PLUIds>sample string 1</PLUIds>
</TogglePLU>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TogglePLU'.

multipart/form-data

Sample:

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

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ResponseOfListOfPLU

Name	Type	Additional information
Message	string	None.
Success	boolean	None.
StatusCode	HttpStatusCode	None.
Data	Collection of PLU	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": [
    {
      "pluId": 1,
      "siteId": 2,
      "pluName": "sample string 3",
      "posButtonText": "sample string 4",
      "showInMenu": true,
      "showInPOS": true
    },
    {
      "pluId": 1,
      "siteId": 2,
      "pluName": "sample string 3",
      "posButtonText": "sample string 4",
      "showInMenu": true,
      "showInPOS": true
    }
  ],
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfPLU175RJIq4 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:PLU>
      <d2p1:PLU_Id>1</d2p1:PLU_Id>
      <d2p1:PLU_Name>sample string 3</d2p1:PLU_Name>
      <d2p1:POS_Button_Text>sample string 4</d2p1:POS_Button_Text>
      <d2p1:Publish_To_Menu>true</d2p1:Publish_To_Menu>
      <d2p1:Publish_To_POS>true</d2p1:Publish_To_POS>
      <d2p1:Site_Id>2</d2p1:Site_Id>
    </d2p1:PLU>
    <d2p1:PLU>
      <d2p1:PLU_Id>1</d2p1:PLU_Id>
      <d2p1:PLU_Name>sample string 3</d2p1:PLU_Name>
      <d2p1:POS_Button_Text>sample string 4</d2p1:POS_Button_Text>
      <d2p1:Publish_To_Menu>true</d2p1:Publish_To_Menu>
      <d2p1:Publish_To_POS>true</d2p1:Publish_To_POS>
      <d2p1:Site_Id>2</d2p1:Site_Id>
    </d2p1:PLU>
  </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>
</ResponseOfArrayOfPLU175RJIq4>

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].PLU_Id"

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

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

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

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

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

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

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

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

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

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

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

True
--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--