GET api/documents/{id}
Метод для получения информации о "Документе"
Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/documents/{id}
Для этого метода требуется авторизация
Информация о запросе
URL параметры
| Название | Описание | Тип данных | Дополнительная информация |
|---|---|---|---|
| id |
Уникальный идентификатор "Документа" |
string |
Required |
| fields |
Список дополнительных полей, которые необходимо вернуть |
string |
Нет |
Тело запроса
Нет параметров в теле запроса
Информация об ответе
DocumentModel
| Название | Описание | Тип данных | Дополнительная информация |
|---|---|---|---|
| Id | globally unique identifier |
Нет |
|
| VendorId | string |
Нет |
|
| Number | string |
Нет |
|
| Name | string |
Поддерживает сортировку |
|
| Type | DocumentTypeModel |
Нет |
|
| DocumentDate | date |
Нет |
|
| DateFrom | date |
Нет |
|
| DateTill | date |
Нет |
|
| Sum | decimal number |
Нет |
|
| DownloadUrl | string |
Нет |
|
| Active | boolean |
Нет |
Форматы ответа
{
"id": "b1095e9c-9903-438a-8c0a-66f54aca6294",
"vendorId": "sample string 2",
"number": "sample string 3",
"name": "sample string 4",
"type": {
"id": "418bdf4d-835a-4b26-95b8-9637d8837622",
"name": "sample string 2"
},
"documentDate": "2024-11-21T23:59:19.8695285Z",
"dateFrom": "2024-11-21T23:59:19.8695285Z",
"dateTill": "2024-11-21T23:59:19.8695285Z",
"sum": 1.0,
"downloadUrl": "sample string 5",
"active": true
}
<DocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents">
<Active>true</Active>
<DateFrom>2024-11-21T23:59:19.8695285+00:00</DateFrom>
<DateTill>2024-11-21T23:59:19.8695285+00:00</DateTill>
<DocumentDate>2024-11-21T23:59:19.8695285+00:00</DocumentDate>
<DownloadUrl>sample string 5</DownloadUrl>
<Id>b1095e9c-9903-438a-8c0a-66f54aca6294</Id>
<Name>sample string 4</Name>
<Number>sample string 3</Number>
<Sum>1</Sum>
<Type xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents.Types">
<d2p1:Id>418bdf4d-835a-4b26-95b8-9637d8837622</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</Type>
<VendorId>sample string 2</VendorId>
</DocumentModel>