POST api/Library/UpdatePassport
Request Information
URI Parameters
None.
Body Parameters
UpdatePassportRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
Required |
|
| PasssportNumber | string |
Required Matching regular expression pattern: ^[A-Za-z0-9]{6,20}$ |
|
| PassportType | string |
Required |
|
| PlaceofIssue | string |
Required |
|
| SurName | string |
Required Matching regular expression pattern: ^[a-zA-Z\s'-]+$ |
|
| GivenName | string |
Required Matching regular expression pattern: ^[a-zA-Z\s'-]+$ |
|
| DateofBirth | date |
Required |
|
| DateofIssue | date |
Required |
|
| DateofExpiry | date |
Required |
|
| ReminderType | string |
Required |
|
| PassportImageID | integer |
Required |
Request Formats
application/json, text/json
Sample:
{
"ID": 1,
"PasssportNumber": "sample string 2",
"PassportType": "sample string 3",
"PlaceofIssue": "sample string 4",
"SurName": "sample string 5",
"GivenName": "sample string 6",
"DateofBirth": "2026-01-13T18:27:18.4501112+03:00",
"DateofIssue": "2026-01-13T18:27:18.4501112+03:00",
"DateofExpiry": "2026-01-13T18:27:18.4501112+03:00",
"ReminderType": "sample string 10",
"PassportImageID": 11
}
application/xml, text/xml
Sample:
<LibraryModels.UpdatePassportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models"> <DateofBirth>2026-01-13T18:27:18.4501112+03:00</DateofBirth> <DateofExpiry>2026-01-13T18:27:18.4501112+03:00</DateofExpiry> <DateofIssue>2026-01-13T18:27:18.4501112+03:00</DateofIssue> <GivenName>sample string 6</GivenName> <ID>1</ID> <PassportImageID>11</PassportImageID> <PassportType>sample string 3</PassportType> <PasssportNumber>sample string 2</PasssportNumber> <PlaceofIssue>sample string 4</PlaceofIssue> <ReminderType>sample string 10</ReminderType> <SurName>sample string 5</SurName> </LibraryModels.UpdatePassportRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetPassportListRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PassportList | Collection of PassportListModel |
None. |
|
| success | boolean |
None. |
|
| code | string |
None. |
|
| message | string |
None. |
|
| errors | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"PassportList": [
{
"ID": 1,
"PasssportNumber": "sample string 2",
"PassportType": "sample string 3",
"PlaceofIssue": "sample string 4",
"SurName": "sample string 5",
"GivenName": "sample string 6",
"DateofBirth": "2026-01-13T18:27:18.4501112+03:00",
"DateofIssue": "2026-01-13T18:27:18.4501112+03:00",
"DateofExpiry": "2026-01-13T18:27:18.4501112+03:00",
"ReminderType": "sample string 10",
"PassportImageLocation": "sample string 11"
},
{
"ID": 1,
"PasssportNumber": "sample string 2",
"PassportType": "sample string 3",
"PlaceofIssue": "sample string 4",
"SurName": "sample string 5",
"GivenName": "sample string 6",
"DateofBirth": "2026-01-13T18:27:18.4501112+03:00",
"DateofIssue": "2026-01-13T18:27:18.4501112+03:00",
"DateofExpiry": "2026-01-13T18:27:18.4501112+03:00",
"ReminderType": "sample string 10",
"PassportImageLocation": "sample string 11"
}
],
"success": true,
"code": "sample string 2",
"message": "sample string 3",
"errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<LibraryModels.GetPassportListRequest 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>
<PassportList>
<LibraryModels.PassportListModel>
<DateofBirth>2026-01-13T18:27:18.4501112+03:00</DateofBirth>
<DateofExpiry>2026-01-13T18:27:18.4501112+03:00</DateofExpiry>
<DateofIssue>2026-01-13T18:27:18.4501112+03:00</DateofIssue>
<GivenName>sample string 6</GivenName>
<ID>1</ID>
<PassportImageLocation>sample string 11</PassportImageLocation>
<PassportType>sample string 3</PassportType>
<PasssportNumber>sample string 2</PasssportNumber>
<PlaceofIssue>sample string 4</PlaceofIssue>
<ReminderType>sample string 10</ReminderType>
<SurName>sample string 5</SurName>
</LibraryModels.PassportListModel>
<LibraryModels.PassportListModel>
<DateofBirth>2026-01-13T18:27:18.4501112+03:00</DateofBirth>
<DateofExpiry>2026-01-13T18:27:18.4501112+03:00</DateofExpiry>
<DateofIssue>2026-01-13T18:27:18.4501112+03:00</DateofIssue>
<GivenName>sample string 6</GivenName>
<ID>1</ID>
<PassportImageLocation>sample string 11</PassportImageLocation>
<PassportType>sample string 3</PassportType>
<PasssportNumber>sample string 2</PasssportNumber>
<PlaceofIssue>sample string 4</PlaceofIssue>
<ReminderType>sample string 10</ReminderType>
<SurName>sample string 5</SurName>
</LibraryModels.PassportListModel>
</PassportList>
</LibraryModels.GetPassportListRequest>