POST api/pos/togglecategory

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

Request Information

URI Parameters

None.

Body Parameters

ToggleCategory

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ToggleCategory 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>
  <CategoryIds>sample string 1</CategoryIds>
</ToggleCategory>

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 'ToggleCategory'.

multipart/form-data

Sample:

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

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ResponseOfListOfCategory

Name	Type	Additional information
Message	string	None.
Success	boolean	None.
StatusCode	HttpStatusCode	None.
Data	Collection of Category	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": [
    {
      "categoryId": 1,
      "categoryName": "sample string 2",
      "categoryTypeId": 1,
      "categoryType": "sample string 3",
      "parentCategoryId": 1,
      "showInMenu": true,
      "showInPOS": true,
      "posButtonName": "sample string 6",
      "menuName": "sample string 7",
      "menuDescription": "sample string 8"
    },
    {
      "categoryId": 1,
      "categoryName": "sample string 2",
      "categoryTypeId": 1,
      "categoryType": "sample string 3",
      "parentCategoryId": 1,
      "showInMenu": true,
      "showInPOS": true,
      "posButtonName": "sample string 6",
      "menuName": "sample string 7",
      "menuDescription": "sample string 8"
    }
  ],
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfCategory175RJIq4 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:Category>
      <d2p1:Category_Id>1</d2p1:Category_Id>
      <d2p1:Category_Name>sample string 2</d2p1:Category_Name>
      <d2p1:Category_Type>sample string 3</d2p1:Category_Type>
      <d2p1:Category_Type_Id>1</d2p1:Category_Type_Id>
      <d2p1:Menu_Description>sample string 8</d2p1:Menu_Description>
      <d2p1:Menu_Name>sample string 7</d2p1:Menu_Name>
      <d2p1:POS_Button_Name>sample string 6</d2p1:POS_Button_Name>
      <d2p1:Parent_Category_Id>1</d2p1:Parent_Category_Id>
      <d2p1:Publish_To_Menu>true</d2p1:Publish_To_Menu>
      <d2p1:Publish_To_POS>true</d2p1:Publish_To_POS>
    </d2p1:Category>
    <d2p1:Category>
      <d2p1:Category_Id>1</d2p1:Category_Id>
      <d2p1:Category_Name>sample string 2</d2p1:Category_Name>
      <d2p1:Category_Type>sample string 3</d2p1:Category_Type>
      <d2p1:Category_Type_Id>1</d2p1:Category_Type_Id>
      <d2p1:Menu_Description>sample string 8</d2p1:Menu_Description>
      <d2p1:Menu_Name>sample string 7</d2p1:Menu_Name>
      <d2p1:POS_Button_Name>sample string 6</d2p1:POS_Button_Name>
      <d2p1:Parent_Category_Id>1</d2p1:Parent_Category_Id>
      <d2p1:Publish_To_Menu>true</d2p1:Publish_To_Menu>
      <d2p1:Publish_To_POS>true</d2p1:Publish_To_POS>
    </d2p1:Category>
  </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>
</ResponseOfArrayOfCategory175RJIq4>

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

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

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

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

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

1
--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[0].POS_Button_Name"

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

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

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

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

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

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

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

1
--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="Data[1].POS_Button_Name"

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

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

sample string 8
--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--