POST api/Public/SaveDocumentURL

Request Information

URI Parameters

None.

Body Parameters

W_DocumentURL
NameDescriptionTypeAdditional information
DocumentURL

string

Required

DocumentDescription

string

Required

Matching regular expression pattern: ^[^\%\/\\\&\@\#\$\*\?\,\'\;\:\!\-]+$

String length: inclusive between 4 and 100

DocumentType

DocumentType

Required

Request Formats

application/json, text/json

Sample:
{
  "documentURL": "sample string 1",
  "documentDescription": "sample string 2",
  "documentType": "LICENSE"
}

application/xml, text/xml

Sample:
<W_DocumentURL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures">
  <DocumentDescription>sample string 2</DocumentDescription>
  <DocumentType>LICENSE</DocumentType>
  <DocumentURL>sample string 1</DocumentURL>
</W_DocumentURL>

multipart/form-data

Sample:
<W_DocumentURL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures"><DocumentDescription>sample string 2</DocumentDescription><DocumentType>LICENSE</DocumentType><DocumentURL>sample string 1</DocumentURL></W_DocumentURL>

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

Response Information

Resource Description

DBStatusWithLastKey
NameDescriptionTypeAdditional information
LastUpdatedKey

string

None.

Type

DBOperation

None.

Message

Collection of DBMessageType

None.

InnerException

Collection of string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<DBStatusWithLastKey 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>
  <LastUpdatedKey>sample string 1</LastUpdatedKey>
</DBStatusWithLastKey>

multipart/form-data

Sample:
<DBStatusWithLastKey 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><LastUpdatedKey>sample string 1</LastUpdatedKey></DBStatusWithLastKey>