POST api/Library/AddDocument

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ReminderType	string	None.
ExpiryDate	date	None.
DocuemntName	string	Required
DocumentType	string	Required
DocumentLocationID	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "ReminderType": "sample string 1",
  "ExpiryDate": "2025-06-15T06:09:27.6163389+03:00",
  "DocuemntName": "sample string 2",
  "DocumentType": "sample string 3",
  "DocumentLocationID": 4
}

application/xml, text/xml

Sample:

<LibraryModels.SaveDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <DocuemntName>sample string 2</DocuemntName>
  <DocumentLocationID>4</DocumentLocationID>
  <DocumentType>sample string 3</DocumentType>
  <ExpiryDate>2025-06-15T06:09:27.6163389+03:00</ExpiryDate>
  <ReminderType>sample string 1</ReminderType>
</LibraryModels.SaveDocumentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetDocumentListRequest

Name	Type	Additional information
DocumentList	Collection of DocumentListModel	None.
success	boolean	None.
code	string	None.
message	string	None.
errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentList": [
    {
      "ID": 1,
      "DocumentName": "sample string 2",
      "DocumentType": "sample string 3",
      "DocumentLocation": "sample string 4",
      "ReminderType": "sample string 5",
      "ReminderTypeText": "sample string 6",
      "ExpiryDate": "2025-06-15T06:09:27.6319573+03:00"
    },
    {
      "ID": 1,
      "DocumentName": "sample string 2",
      "DocumentType": "sample string 3",
      "DocumentLocation": "sample string 4",
      "ReminderType": "sample string 5",
      "ReminderTypeText": "sample string 6",
      "ExpiryDate": "2025-06-15T06:09:27.6319573+03:00"
    }
  ],
  "success": true,
  "code": "sample string 2",
  "message": "sample string 3",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<LibraryModels.GetDocumentListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <code>sample string 2</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message>sample string 3</message>
  <success>true</success>
  <DocumentList>
    <LibraryModels.DocumentListModel>
      <DocumentLocation>sample string 4</DocumentLocation>
      <DocumentName>sample string 2</DocumentName>
      <DocumentType>sample string 3</DocumentType>
      <ExpiryDate>2025-06-15T06:09:27.6319573+03:00</ExpiryDate>
      <ID>1</ID>
      <ReminderType>sample string 5</ReminderType>
      <ReminderTypeText>sample string 6</ReminderTypeText>
    </LibraryModels.DocumentListModel>
    <LibraryModels.DocumentListModel>
      <DocumentLocation>sample string 4</DocumentLocation>
      <DocumentName>sample string 2</DocumentName>
      <DocumentType>sample string 3</DocumentType>
      <ExpiryDate>2025-06-15T06:09:27.6319573+03:00</ExpiryDate>
      <ID>1</ID>
      <ReminderType>sample string 5</ReminderType>
      <ReminderTypeText>sample string 6</ReminderTypeText>
    </LibraryModels.DocumentListModel>
  </DocumentList>
</LibraryModels.GetDocumentListRequest>