POST api/Public/UpdateDocument

Request Information

URI Parameters

None.

Body Parameters

nU_Document
NameDescriptionTypeAdditional information
DocumentID

integer

Required

DocumentName

string

Required

DocumentURL

string

Required

Matching regular expression pattern: ^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:/?#[\]@!\$&'\(\)\*\+,;=.]+$

StartDate

date

None.

EndDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "documentID": 1,
  "documentName": "sample string 2",
  "documentURL": "sample string 3",
  "startDate": "2020-09-22T17:50:25.3581703-07:00",
  "endDate": "2020-09-22T17:50:25.3581703-07:00"
}

application/xml, text/xml

Sample:
<nU_Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures">
  <DocumentName>sample string 2</DocumentName>
  <DocumentURL>sample string 3</DocumentURL>
  <EndDate>2020-09-22T17:50:25.3581703-07:00</EndDate>
  <StartDate>2020-09-22T17:50:25.3581703-07:00</StartDate>
  <DocumentID>1</DocumentID>
</nU_Document>

multipart/form-data

Sample:
<nU_Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures"><DocumentName>sample string 2</DocumentName><DocumentURL>sample string 3</DocumentURL><EndDate>2020-09-22T17:50:25.3581703-07:00</EndDate><StartDate>2020-09-22T17:50:25.3581703-07:00</StartDate><DocumentID>1</DocumentID></nU_Document>

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

Response Information

Resource Description

DBStatus
NameDescriptionTypeAdditional information
Type

DBOperation

None.

Message

Collection of DBMessageType

None.

InnerException

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "type": "ERROR",
  "message": [
    "SUCCESSFULLY_DATA_INSERTED",
    "SUCCESSFULLY_DATA_INSERTED"
  ],
  "innerException": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<DBStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures">
  <InnerException xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </InnerException>
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/DBEnumStructure">
    <d2p1:DBMessageType>SUCCESSFULLY_DATA_INSERTED</d2p1:DBMessageType>
    <d2p1:DBMessageType>SUCCESSFULLY_DATA_INSERTED</d2p1:DBMessageType>
  </Message>
  <Type>ERROR</Type>
</DBStatus>

multipart/form-data

Sample:
<DBStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures"><InnerException xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></InnerException><Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/DBEnumStructure"><d2p1:DBMessageType>SUCCESSFULLY_DATA_INSERTED</d2p1:DBMessageType><d2p1:DBMessageType>SUCCESSFULLY_DATA_INSERTED</d2p1:DBMessageType></Message><Type>ERROR</Type></DBStatus>