<aside> ⚠️ XP, XL, контекст клиента, V=0

</aside>

Метод позволяет сформировать документ и получить ссылку для его скачивания

<aside> 💡 ВАЖНО! В конфигурационный файл приложения web.config необходимо добавить параметр rootUrl в котором прописать локальный адрес, по которому доступен веб-сервер. Например http://localhost/Xprokat

</aside>

Параметры запроса

<aside> 💡

Примечание: чтобы узнать какой DocumentId у шаблона, выполняем следующие действия:

1. Печатаем в Xlombard/Xprokat нужный нам шаблон;
2. Идем в модуль “Журнал действий” и ищем запись с логом печати данного шаблона;
3. В логе находим параметр “docType=01234”, это и будет наш ID который нужно использовать в запросе.

</aside>

Результат

Возвращаемый объект типа GenerateDocumentDto

public class GenerateDocumentDto
{
    /// <summary>
    /// Формат документа. Возможные значения: file, html
    /// </summary>
    public string Type { get; set; }
    /// <summary>
    /// Ссылка на сформированный документ.
    /// </summary>
    public string Url { get; set; }
    /// <summary>
    /// Имя файла.
    /// </summary>
    public string FileName { get; set; }
}

Примеры запросов

{
	"ApiKey": "IwHVqTARLnKU1H52Htas27ATFIwGWReV",
	"ApiVersion": "0",
	"Method": "GenerateDocument",
	"Parameters": 
	{
		"ClientIntegrationId": "nz2UG1",
		"ContractId": 313527,
		"DocumentId": 70000,
		"CurrentUserId": 2,
		"DocumentTitle": "Договор аренды",
		"OperationDate": "15.11.2019 16:22:14"
	}
}

{
	"ApiKey": "IwHVqTARLnKU1H52Htas27ATFIwGWReV",
	"ApiVersion": "0",
	"Method": "GenerateDocument",
	"Parameters": 
	{
		"ClientIntegrationId": "nz2UG1",
		"ContractId": 313527,
		"DocumentId": 70002,
		"CurrentUserId": 2,
		"DocumentTitle": "Договор аренды (1 сторона)",
		"AdditionalType": "prokat",
		"OperationId": 399301,
		"OperationDate": "15.11.2019 16:22:14"
	}
}

Примеры результатов

{
	"Result": {
		"Type": "file",
		"Url": "<http://prokat.local/buffer/Договор_аренды-№43746-b2.docx>",
		"FileName": "Договор_аренды-№43746-b2.docx"
	},
	"ApiKey": "IwHVqTARLnKU1H52Htas27ATFIwGWReV",
	"ApiVersion": "0",
	"Method": "GenerateDocument",
	"Errors": [],
	"Duration": 10.0000
}

{
	"Result": {
		"Type": "file",
		"Url": "<http://prokat.local/buffer/Продление_договора-№43746-35.docx>",
		"FileName": "Продление_договора-№43746-35.docx"
	},
	"ApiKey": "IwHVqTARLnKU1H52Htas27ATFIwGWReV",
	"ApiVersion": "0",
	"Method": "GenerateDocument",
	"Errors": [],
	"Duration": 10.0000
}