POST Document/upload
Request Information
URI Parameters
None.
Body Parameters
ApiFromBodyUploadDocumentImage| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonId | integer |
Required Range: inclusive between 1 and 2147483647 |
|
| Id | integer |
None. |
|
| MimeType | string |
Max length: 100 |
|
| DocumentType | integer |
Required Range: inclusive between 1 and 255 |
|
| DocumentValue | string |
Required Max length: 50 |
|
| ImageData | string |
None. |
|
| DocumentExpirationDate | date |
None. |
|
| DocumentAlias | string |
Max length: 50 |
|
| IsDocumentDefault | boolean |
Range: inclusive between false and true |
|
| ExpeditionCountryISO2 | string |
Required String length: inclusive between 2 and 2 |
Request Formats
application/json, text/json
Sample:
{
"personId": 1,
"id": 2,
"mimeType": "sample string 3",
"documentType": 4,
"documentValue": "sample string 5",
"imageData": "sample string 6",
"documentExpirationDate": "2026-06-23T06:10:02.1271436+02:00",
"documentAlias": "sample string 7",
"isDocumentDefault": true,
"expeditionCountryISO2": "sample string 9"
}
multipart/form-data
Sample:
{"personId":1,"id":2,"mimeType":"sample string 3","documentType":4,"documentValue":"sample string 5","imageData":"sample string 6","documentExpirationDate":"2026-06-23T06:10:02.1271436+02:00","documentAlias":"sample string 7","isDocumentDefault":true,"expeditionCountryISO2":"sample string 9"}
application/xml, text/xml
Sample:
<ApiFromBodyUploadDocumentImage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <PersonId>1</PersonId> <Id>2</Id> <MimeType>sample string 3</MimeType> <DocumentType>4</DocumentType> <DocumentValue>sample string 5</DocumentValue> <ImageData>sample string 6</ImageData> <DocumentExpirationDate>2026-06-23T06:10:02.1271436+02:00</DocumentExpirationDate> <DocumentAlias>sample string 7</DocumentAlias> <IsDocumentDefault>true</IsDocumentDefault> <ExpeditionCountryISO2>sample string 9</ExpeditionCountryISO2> </ApiFromBodyUploadDocumentImage>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, multipart/form-data
Sample:
Sample not available.