Alpha API ReferenceDossier
Deliver dossier to buyer
Creates a public share link on the bundled document, emails it to the recipients and marks the dossier as delivered.
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/dossiers/string/deliver" \ -H "Content-Type: application/json" \ -d '{ "recipients": [ "string" ] }'{
"clientId": "string",
"completeness": [
{
"message": "string",
"required": true,
"satisfied": true,
"sectionId": "string",
"title": "string"
}
],
"configurationId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"deliveredAt": "2019-08-24T14:15:22Z",
"deliveredTo": [
"string"
],
"dmsDocumentId": "string",
"errorMessage": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"generatedAt": "2019-08-24T14:15:22Z",
"houseId": "string",
"id": "string",
"number": "string",
"projectId": "string",
"status": "DRAFT",
"templateSnapshot": {
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"number": "string",
"projectId": "string",
"sections": [
{
"category": "AS_BUILT_DRAWINGS",
"documentIds": [
"string"
],
"id": "string",
"required": true,
"source": "STATIC_DOCUMENTS",
"title": "string"
}
],
"tenantId": "string",
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"tenantId": "string",
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}