POST Document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
selectedLoginType	Collection of integer	None.
UploadFile	HttpPostedFileBase	None.
DocFileName	string	None.
Active	boolean	None.
FriendlyName	string	None.
WEB_PortalKey	integer	None.
DocName	string	Required
DocDesc	string	Required
DocumentPath	string	None.
Category_G2001	integer	None.
DocumentType	integer	None.
DocumentTypeDescription	string	None.
DocumentTypeValueID	integer	None.
PBEntityKey	integer	None.
FileBytes	Collection of byte	None.
SecondaryCategory_G2001	integer	None.
CategoryDesc	string	None.
SecondaryCategoryDesc	string	None.
DocLocationDesc	string	None.
DocLocationValueId	DocumentLocation_G2002	None.
dtWhenLastChanged	date	None.
WhenLastChanged	string	None.
DisplayOrder	integer	Range: inclusive between 0 and 99
dtDisplayStartTime	date	None.
DisplayStartTime	string	None.
dtDisplayEndTime	date	None.
DisplayEndTime	string	None.
dtTimeUploaded	date	None.
TimeUploaded	string	None.
WhoLastChanged	string	None.
ContextType	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "selectedLoginType": [
    1,
    2
  ],
  "DisplayDateRange": "1/9/2025 - 1/9/2025",
  "UploadFile": null,
  "DocFileName": "sample string 2",
  "Active": true,
  "FriendlyName": "sample string 5",
  "WEB_PortalKey": 6,
  "DocName": "sample string 7",
  "DocDesc": "sample string 8",
  "DocumentPath": "sample string 9",
  "Category_G2001": 10,
  "DocumentType": 11,
  "DocumentTypeDescription": "sample string 12",
  "DocumentTypeValueID": 13,
  "PBEntityKey": 14,
  "FileBytes": "QEA=",
  "SecondaryCategory_G2001": 15,
  "CategoryDesc": "sample string 16",
  "SecondaryCategoryDesc": "sample string 17",
  "DocLocationDesc": "sample string 18",
  "DocLocationValueId": 0,
  "dtWhenLastChanged": "2025-01-09T14:01:34.5295116-06:00",
  "WhenLastChanged": "1/9/2025",
  "DisplayOrder": 21,
  "dtDisplayStartTime": "2025-01-09T14:01:34.5295116-06:00",
  "DisplayStartTime": "1/9/2025",
  "dtDisplayEndTime": "2025-01-09T14:01:34.5295116-06:00",
  "DisplayEndTime": "1/9/2025",
  "dtTimeUploaded": "2025-01-09T14:01:34.5295116-06:00",
  "TimeUploaded": "1/9/2025",
  "WhoLastChanged": "sample string 27",
  "ContextType": "sample string 28"
}

application/xml, text/xml

Sample:

<DocumentDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <Active>true</Active>
  <CategoryDesc>sample string 16</CategoryDesc>
  <Category_G2001>10</Category_G2001>
  <ContextType>sample string 28</ContextType>
  <DisplayEndTime>1/9/2025</DisplayEndTime>
  <DisplayOrder>21</DisplayOrder>
  <DisplayStartTime>1/9/2025</DisplayStartTime>
  <DocDesc>sample string 8</DocDesc>
  <DocFileName>sample string 2</DocFileName>
  <DocLocationDesc>sample string 18</DocLocationDesc>
  <DocLocationValueId>None</DocLocationValueId>
  <DocName>sample string 7</DocName>
  <DocumentPath>sample string 9</DocumentPath>
  <DocumentType>11</DocumentType>
  <DocumentTypeDescription>sample string 12</DocumentTypeDescription>
  <DocumentTypeValueID>13</DocumentTypeValueID>
  <FileBytes>QEA=</FileBytes>
  <FriendlyName>sample string 5</FriendlyName>
  <Id>1</Id>
  <PBEntityKey>14</PBEntityKey>
  <SecondaryCategoryDesc>sample string 17</SecondaryCategoryDesc>
  <SecondaryCategory_G2001>15</SecondaryCategory_G2001>
  <TimeUploaded>1/9/2025</TimeUploaded>
  <UploadFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web" i:nil="true" />
  <WEB_PortalKey>6</WEB_PortalKey>
  <WhenLastChanged>1/9/2025</WhenLastChanged>
  <WhoLastChanged>sample string 27</WhoLastChanged>
  <dtDisplayEndTime>2025-01-09T14:01:34.5295116-06:00</dtDisplayEndTime>
  <dtDisplayStartTime>2025-01-09T14:01:34.5295116-06:00</dtDisplayStartTime>
  <dtTimeUploaded>2025-01-09T14:01:34.5295116-06:00</dtTimeUploaded>
  <dtWhenLastChanged>2025-01-09T14:01:34.5295116-06:00</dtWhenLastChanged>
  <selectedLoginType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </selectedLoginType>
</DocumentDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.