POST api/Document/SaveDocument

Request Information

URI Parameters

None.

Body Parameters

HW_PATIENT_DOCUMENTS
NameDescriptionTypeAdditional information
patient_document_id

integer

None.

user_id

string

None.

appointment_no

string

None.

document_text

string

None.

document_type

string

None.

document_image

string

None.

document_file_name

string

None.

document_format

string

None.

document_file_path

string

None.

document_note_text

string

None.

document_note_image

string

None.

deleted

boolean

None.

created_at

date

None.

created_by

string

None.

modify_at

date

None.

modify_by

string

None.

Request Formats

application/json, text/json

Sample:
{
  "patient_document_id": 1,
  "user_id": "sample string 2",
  "appointment_no": "sample string 3",
  "document_text": "sample string 4",
  "document_type": "sample string 5",
  "document_image": "sample string 6",
  "document_file_name": "sample string 7",
  "document_format": "sample string 8",
  "document_file_path": "sample string 9",
  "document_note_text": "sample string 10",
  "document_note_image": "sample string 11",
  "deleted": true,
  "created_at": "2026-03-04T03:44:50.6672764+05:00",
  "created_by": "sample string 13",
  "modify_at": "2026-03-04T03:44:50.6672764+05:00",
  "modify_by": "sample string 14"
}

text/html, multipart/form-data

Sample:
{"patient_document_id":1,"user_id":"sample string 2","appointment_no":"sample string 3","document_text":"sample string 4","document_type":"sample string 5","document_image":"sample string 6","document_file_name":"sample string 7","document_format":"sample string 8","document_file_path":"sample string 9","document_note_text":"sample string 10","document_note_image":"sample string 11","deleted":true,"created_at":"2026-03-04T03:44:50.6672764+05:00","created_by":"sample string 13","modify_at":"2026-03-04T03:44:50.6672764+05:00","modify_by":"sample string 14"}

application/xml, text/xml

Sample:
<HW_PATIENT_DOCUMENTS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Humwell_DALL.Dto">
  <appointment_no>sample string 3</appointment_no>
  <created_at>2026-03-04T03:44:50.6672764+05:00</created_at>
  <created_by>sample string 13</created_by>
  <deleted>true</deleted>
  <document_file_name>sample string 7</document_file_name>
  <document_file_path>sample string 9</document_file_path>
  <document_format>sample string 8</document_format>
  <document_image>sample string 6</document_image>
  <document_note_image>sample string 11</document_note_image>
  <document_note_text>sample string 10</document_note_text>
  <document_text>sample string 4</document_text>
  <document_type>sample string 5</document_type>
  <modify_at>2026-03-04T03:44:50.6672764+05:00</modify_at>
  <modify_by>sample string 14</modify_by>
  <patient_document_id>1</patient_document_id>
  <user_id>sample string 2</user_id>
</HW_PATIENT_DOCUMENTS>

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

Response Information

Resource Description

JsonResponse
NameDescriptionTypeAdditional information
response

response

None.

result

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "response": {
    "responseCode": 1,
    "responseMessage": "sample string 2"
  },
  "result": {}
}

text/html, multipart/form-data

Sample:
{"response":{"responseCode":1,"responseMessage":"sample string 2"},"result":{}}

application/xml, text/xml

Sample:
<JsonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Humwell_DALL.Json">
  <response>
    <responseCode>1</responseCode>
    <responseMessage>sample string 2</responseMessage>
  </response>
  <result />
</JsonResponse>