POST api/NTSummary/PostMedicalNote

Request Information

URI Parameters

None.

Body Parameters

MedicalNoteDTO
NameDescriptionTypeAdditional information
Id

integer

None.

CaseNumber

integer

None.

EncounterId

integer

None.

MedicalSequence

integer

None.

NoteType

integer

None.

NoteText

string

String length: inclusive between 0 and 4000

insertUserName

string

String length: inclusive between 0 and 61

RelativeDateTime

string

String length: inclusive between 0 and 50

NoteTypeId

integer

None.

EntityTypeId

integer

None.

ECCCaseTypeId

integer

None.

ValidFlag

boolean

None.

DateCreated

date

None.

DateUpdated

date

None.

UserIDCreated

integer

None.

UserIDUpdated

integer

None.

CompanyCode

string

String length: inclusive between 0 and 20

IsExcludeDiscount

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "CaseNumber": 2,
  "EncounterId": 1,
  "MedicalSequence": 3,
  "NoteType": 4,
  "NoteText": "sample string 5",
  "insertUserName": "sample string 6",
  "RelativeDateTime": "sample string 7",
  "NoteTypeId": 8,
  "EntityTypeId": 1,
  "ECCCaseTypeId": 1,
  "ValidFlag": true,
  "DateCreated": "2025-04-04T23:25:53.025932-07:00",
  "DateUpdated": "2025-04-04T23:25:53.025932-07:00",
  "UserIDCreated": 12,
  "UserIDUpdated": 13,
  "CompanyCode": "sample string 14",
  "IsExcludeDiscount": true
}

application/xml, text/xml

Sample:
<MedicalNoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
  <CompanyCode>sample string 14</CompanyCode>
  <DateCreated>2025-04-04T23:25:53.025932-07:00</DateCreated>
  <DateUpdated>2025-04-04T23:25:53.025932-07:00</DateUpdated>
  <IsExcludeDiscount>true</IsExcludeDiscount>
  <UserIDCreated>12</UserIDCreated>
  <UserIDUpdated>13</UserIDUpdated>
  <ValidFlag>true</ValidFlag>
  <CaseNumber>2</CaseNumber>
  <ECCCaseTypeId>1</ECCCaseTypeId>
  <EncounterId>1</EncounterId>
  <EntityTypeId>1</EntityTypeId>
  <Id>1</Id>
  <MedicalSequence>3</MedicalSequence>
  <NoteText>sample string 5</NoteText>
  <NoteType>4</NoteType>
  <NoteTypeId>8</NoteTypeId>
  <RelativeDateTime>sample string 7</RelativeDateTime>
  <insertUserName>sample string 6</insertUserName>
</MedicalNoteDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfMedicalNoteDTO
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

message

string

None.

jsonObj

MedicalNoteDTO

None.

totalCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "Id": 1,
    "CaseNumber": 2,
    "EncounterId": 1,
    "MedicalSequence": 3,
    "NoteType": 4,
    "NoteText": "sample string 5",
    "insertUserName": "sample string 6",
    "RelativeDateTime": "sample string 7",
    "NoteTypeId": 8,
    "EntityTypeId": 1,
    "ECCCaseTypeId": 1,
    "ValidFlag": true,
    "DateCreated": "2025-04-04T23:25:53.025932-07:00",
    "DateUpdated": "2025-04-04T23:25:53.025932-07:00",
    "UserIDCreated": 12,
    "UserIDUpdated": 13,
    "CompanyCode": "sample string 14",
    "IsExcludeDiscount": true
  },
  "totalCount": 3
}

application/xml, text/xml

Sample:
<AsapResponseOfMedicalNoteDTO3NYuOdgi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.Common">
  <isSuccess>true</isSuccess>
  <jsonObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
    <d2p1:CompanyCode>sample string 14</d2p1:CompanyCode>
    <d2p1:DateCreated>2025-04-04T23:25:53.025932-07:00</d2p1:DateCreated>
    <d2p1:DateUpdated>2025-04-04T23:25:53.025932-07:00</d2p1:DateUpdated>
    <d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
    <d2p1:UserIDCreated>12</d2p1:UserIDCreated>
    <d2p1:UserIDUpdated>13</d2p1:UserIDUpdated>
    <d2p1:ValidFlag>true</d2p1:ValidFlag>
    <d2p1:CaseNumber>2</d2p1:CaseNumber>
    <d2p1:ECCCaseTypeId>1</d2p1:ECCCaseTypeId>
    <d2p1:EncounterId>1</d2p1:EncounterId>
    <d2p1:EntityTypeId>1</d2p1:EntityTypeId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:MedicalSequence>3</d2p1:MedicalSequence>
    <d2p1:NoteText>sample string 5</d2p1:NoteText>
    <d2p1:NoteType>4</d2p1:NoteType>
    <d2p1:NoteTypeId>8</d2p1:NoteTypeId>
    <d2p1:RelativeDateTime>sample string 7</d2p1:RelativeDateTime>
    <d2p1:insertUserName>sample string 6</d2p1:insertUserName>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfMedicalNoteDTO3NYuOdgi>