POST api/Help/Update

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
Heading	string	None.
Image	string	None.
Description	string	None.
Icon	string	None.
IsActive	boolean	None.
HelpDetails	Collection of HelpDetailModel	None.
Attachment	ImageModel	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Heading": "sample string 2",
  "Image": "sample string 3",
  "Description": "sample string 4",
  "Icon": "sample string 5",
  "IsActive": true,
  "HelpDetails": [
    {
      "ID": 1,
      "HelpID": 1,
      "Description": "sample string 2",
      "DetailDescription": "sample string 3",
      "Image": "sample string 4",
      "Icon": "sample string 5",
      "Attachment": {
        "Base64String": "sample string 1",
        "Extention": "sample string 2"
      }
    },
    {
      "ID": 1,
      "HelpID": 1,
      "Description": "sample string 2",
      "DetailDescription": "sample string 3",
      "Image": "sample string 4",
      "Icon": "sample string 5",
      "Attachment": {
        "Base64String": "sample string 1",
        "Extention": "sample string 2"
      }
    }
  ],
  "Attachment": {
    "Base64String": "sample string 1",
    "Extention": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<HelpModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <Attachment>
    <Base64String>sample string 1</Base64String>
    <Extention>sample string 2</Extention>
  </Attachment>
  <Description>sample string 4</Description>
  <Heading>sample string 2</Heading>
  <HelpDetails>
    <HelpDetailModel>
      <Attachment>
        <Base64String>sample string 1</Base64String>
        <Extention>sample string 2</Extention>
      </Attachment>
      <Description>sample string 2</Description>
      <DetailDescription>sample string 3</DetailDescription>
      <HelpID>1</HelpID>
      <ID>1</ID>
      <Icon>sample string 5</Icon>
      <Image>sample string 4</Image>
    </HelpDetailModel>
    <HelpDetailModel>
      <Attachment>
        <Base64String>sample string 1</Base64String>
        <Extention>sample string 2</Extention>
      </Attachment>
      <Description>sample string 2</Description>
      <DetailDescription>sample string 3</DetailDescription>
      <HelpID>1</HelpID>
      <ID>1</ID>
      <Icon>sample string 5</Icon>
      <Image>sample string 4</Image>
    </HelpDetailModel>
  </HelpDetails>
  <ID>1</ID>
  <Icon>sample string 5</Icon>
  <Image>sample string 3</Image>
  <IsActive>true</IsActive>
</HelpModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HelpResponse

Name	Type	Additional information
Help	HelpModel	None.
ResponseCode	integer	None.
ResponseText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Help": {
    "ID": 1,
    "Heading": "sample string 2",
    "Image": "sample string 3",
    "Description": "sample string 4",
    "Icon": "sample string 5",
    "IsActive": true,
    "HelpDetails": [
      {
        "ID": 1,
        "HelpID": 1,
        "Description": "sample string 2",
        "DetailDescription": "sample string 3",
        "Image": "sample string 4",
        "Icon": "sample string 5",
        "Attachment": {
          "Base64String": "sample string 1",
          "Extention": "sample string 2"
        }
      },
      {
        "ID": 1,
        "HelpID": 1,
        "Description": "sample string 2",
        "DetailDescription": "sample string 3",
        "Image": "sample string 4",
        "Icon": "sample string 5",
        "Attachment": {
          "Base64String": "sample string 1",
          "Extention": "sample string 2"
        }
      }
    ],
    "Attachment": {
      "Base64String": "sample string 1",
      "Extention": "sample string 2"
    }
  },
  "ResponseCode": 1,
  "ResponseText": "sample string 2"
}

application/xml, text/xml

Sample:

<HelpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <ResponseCode>1</ResponseCode>
  <ResponseText>sample string 2</ResponseText>
  <Help>
    <Attachment>
      <Base64String>sample string 1</Base64String>
      <Extention>sample string 2</Extention>
    </Attachment>
    <Description>sample string 4</Description>
    <Heading>sample string 2</Heading>
    <HelpDetails>
      <HelpDetailModel>
        <Attachment>
          <Base64String>sample string 1</Base64String>
          <Extention>sample string 2</Extention>
        </Attachment>
        <Description>sample string 2</Description>
        <DetailDescription>sample string 3</DetailDescription>
        <HelpID>1</HelpID>
        <ID>1</ID>
        <Icon>sample string 5</Icon>
        <Image>sample string 4</Image>
      </HelpDetailModel>
      <HelpDetailModel>
        <Attachment>
          <Base64String>sample string 1</Base64String>
          <Extention>sample string 2</Extention>
        </Attachment>
        <Description>sample string 2</Description>
        <DetailDescription>sample string 3</DetailDescription>
        <HelpID>1</HelpID>
        <ID>1</ID>
        <Icon>sample string 5</Icon>
        <Image>sample string 4</Image>
      </HelpDetailModel>
    </HelpDetails>
    <ID>1</ID>
    <Icon>sample string 5</Icon>
    <Image>sample string 3</Image>
    <IsActive>true</IsActive>
  </Help>
</HelpResponse>