POST api/Document

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

AsapResponseOfDocumentDTO
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

message

string

None.

jsonObj

DocumentDTO

None.

totalCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "RecordID": "15d383cb-74de-4767-9d8f-4936e6be5e49",
    "EntityID": "sample string 2",
    "EntityTypeID": 3,
    "DocTypeID": 4,
    "DocTypeDescription": "sample string 5",
    "FileByteArray": "QEA=",
    "FilePath": "sample string 6",
    "FileName": "sample string 7",
    "FileExtension": "sample string 8",
    "UserID": 9,
    "UserName": "sample string 10",
    "TimeCreated": "2025-04-03T19:02:23.1128749-07:00",
    "RelativeDateTime": "sample string 12",
    "IsValid": true,
    "DocumentName": "sample string 5",
    "Notes": "sample string 14",
    "HasNotes": true,
    "IsAWSS3": true,
    "AWSBucketName": "sample string 16",
    "IsOverridable": true
  },
  "totalCount": 3
}

application/xml, text/xml

Sample:
<AsapResponseOfDocumentDTO9DQd0Pqc 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.DTO">
    <d2p1:AWSBucketName>sample string 16</d2p1:AWSBucketName>
    <d2p1:DocTypeDescription>sample string 5</d2p1:DocTypeDescription>
    <d2p1:DocTypeID>4</d2p1:DocTypeID>
    <d2p1:EntityID>sample string 2</d2p1:EntityID>
    <d2p1:EntityTypeID>3</d2p1:EntityTypeID>
    <d2p1:FileByteArray>QEA=</d2p1:FileByteArray>
    <d2p1:FileExtension>sample string 8</d2p1:FileExtension>
    <d2p1:FileName>sample string 7</d2p1:FileName>
    <d2p1:FilePath>sample string 6</d2p1:FilePath>
    <d2p1:IsAWSS3>true</d2p1:IsAWSS3>
    <d2p1:IsOverridable>true</d2p1:IsOverridable>
    <d2p1:IsValid>true</d2p1:IsValid>
    <d2p1:Notes>sample string 14</d2p1:Notes>
    <d2p1:RecordID>15d383cb-74de-4767-9d8f-4936e6be5e49</d2p1:RecordID>
    <d2p1:RelativeDateTime>sample string 12</d2p1:RelativeDateTime>
    <d2p1:TimeCreated>2025-04-03T19:02:23.1128749-07:00</d2p1:TimeCreated>
    <d2p1:UserID>9</d2p1:UserID>
    <d2p1:UserName>sample string 10</d2p1:UserName>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfDocumentDTO9DQd0Pqc>