API docs by Redocly

media API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the media stack.

PdfService

PdfService_GenerateFromHtml

Request Body schema: application/json
required
html
required
string

Responses

Request samples

Content type
application/json
{
  • "html": "string"
}

Response samples

Content type
application/json
{
  • "pdf": "string"
}

DocumentService

DocumentService_Get

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ownerId": "string",
  • "showInPortal": true,
  • "type": "OTHER",
  • "version": 0,
  • "versions": [
    ]
}

DocumentService_Save

Request Body schema: application/json
required
mediaId
required
string
name
required
string
ownerId
required
string <int64>
showInPortal
required
boolean
type
required
string (mediadocumentType)
Default: "OTHER"
Enum: "OTHER" "APPLICATION_FORM" "HANDOVER_PROTOCOL" "CONTRACT" "BUILDING_PLAN" "INVOICE" "HOUSE_REGULATION" "INSTRUCTION_MANUAL" "CREDIT_CHECK" "OWNERS_MEETING" "PAY_IN_SLIP" "ENERGY_CERTIFICATE" "WARRANTY_CERTIFICATE" "BANK_STATEMENT" "ADDITIONAL_COSTS_BILL" "SEPA_DIRECT_DEBIT_MANDATE" "AGREEMENT" "DEPOSIT_CONFIRMATION" "BUILDING_INSURANCE_POLICY" "KEY_LIST" "TERMINATION_DOC_TYPE" "RENT_ADJUSTMENT_DOC_TYPE" "REFERENCES_DOC_TYPE" "MAINTENANCE_CONTRACT_DOC_TYPE" "REGULATIONS" "REGULATIONS_FOR_USE_AND_MANAGEMENT" "ANNUAL_FINANCIAL_STATEMENT" "PURCHASE_CONTRACT_AND_LAND_REGISTER" "CONDOMINIUM_OWNERSHIP" "RENEWAL_FOND" "MORTGAGE" "ORDER" "OFFER" "IDENTITY" "EXTRACT_FROM_DEBT_COLLECTION_REGISTER" "BANK_ACCOUNT_DETAILS" "PURCHASE_CONTRACT" "LAND_REGISTER" "SITUATION_PLAN" "CONSTRUCTION_LAW_AGREEMENT" "EASEMENT_AGREEMENT" "CADASTRAL_ESTIMATE" "LETTER" "TRADE_REGISTER_EXCERPT" "PAYMENT_REMINDER" "PROTOCOL" "COURT_DOC_TYPE" "HONORARIUM" "BUDGET" "OFFICIAL_ESTIMATE" "BUILDING_DESCRIPTION" "PERMITS" "LEGAL_MATTERS" "TENANT_CHANGE_NOTIFICATION" "LOSS_RATIO" "SHARE_CERTIFICATE_DOCUMENT"

Responses

Request samples

Content type
application/json
{
  • "mediaId": "string",
  • "name": "string",
  • "ownerId": "string",
  • "showInPortal": true,
  • "type": "OTHER"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ownerId": "string",
  • "showInPortal": true,
  • "type": "OTHER",
  • "version": 0,
  • "versions": [
    ]
}

DocumentService_List

Request Body schema: application/json
required
documentIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "documents": [
    ]
}

DocumentService_MergeAllDocuments

Request Body schema: application/json
required
required
Array of objects (documentmergingMedium)
mergeMediumName
required
string

Responses

Request samples

Content type
application/json
{
  • "media": [
    ],
  • "mergeMediumName": "string"
}

Response samples

Content type
application/json
{
  • "media": "string"
}

DocumentService_Update

path Parameters
id
required
string
Request Body schema: application/json
required
name
string
showInPortal
boolean
type
string (mediadocumentType)
Default: "OTHER"
Enum: "OTHER" "APPLICATION_FORM" "HANDOVER_PROTOCOL" "CONTRACT" "BUILDING_PLAN" "INVOICE" "HOUSE_REGULATION" "INSTRUCTION_MANUAL" "CREDIT_CHECK" "OWNERS_MEETING" "PAY_IN_SLIP" "ENERGY_CERTIFICATE" "WARRANTY_CERTIFICATE" "BANK_STATEMENT" "ADDITIONAL_COSTS_BILL" "SEPA_DIRECT_DEBIT_MANDATE" "AGREEMENT" "DEPOSIT_CONFIRMATION" "BUILDING_INSURANCE_POLICY" "KEY_LIST" "TERMINATION_DOC_TYPE" "RENT_ADJUSTMENT_DOC_TYPE" "REFERENCES_DOC_TYPE" "MAINTENANCE_CONTRACT_DOC_TYPE" "REGULATIONS" "REGULATIONS_FOR_USE_AND_MANAGEMENT" "ANNUAL_FINANCIAL_STATEMENT" "PURCHASE_CONTRACT_AND_LAND_REGISTER" "CONDOMINIUM_OWNERSHIP" "RENEWAL_FOND" "MORTGAGE" "ORDER" "OFFER" "IDENTITY" "EXTRACT_FROM_DEBT_COLLECTION_REGISTER" "BANK_ACCOUNT_DETAILS" "PURCHASE_CONTRACT" "LAND_REGISTER" "SITUATION_PLAN" "CONSTRUCTION_LAW_AGREEMENT" "EASEMENT_AGREEMENT" "CADASTRAL_ESTIMATE" "LETTER" "TRADE_REGISTER_EXCERPT" "PAYMENT_REMINDER" "PROTOCOL" "COURT_DOC_TYPE" "HONORARIUM" "BUDGET" "OFFICIAL_ESTIMATE" "BUILDING_DESCRIPTION" "PERMITS" "LEGAL_MATTERS" "TENANT_CHANGE_NOTIFICATION" "LOSS_RATIO" "SHARE_CERTIFICATE_DOCUMENT"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "showInPortal": true,
  • "type": "OTHER"
}

Response samples

Content type
application/json
{ }

DocumentService_AddVersion

path Parameters
id
required
string
Request Body schema: application/json
required
mediaId
string

Responses

Request samples

Content type
application/json
{
  • "mediaId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ownerId": "string",
  • "showInPortal": true,
  • "type": "OTHER",
  • "version": 0,
  • "versions": [
    ]
}

DocumentService_RemoveVersion

path Parameters
id
required
string
version
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ownerId": "string",
  • "showInPortal": true,
  • "type": "OTHER",
  • "version": 0,
  • "versions": [
    ]
}

StoreService

StoreService_List

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "media": [
    ]
}

StoreService_SetPublicFlag

Request Body schema: application/json
required
ids
required
Array of strings
public
required
boolean

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "public": true
}

Response samples

Content type
application/json
{ }

StoreService_Get

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "media": {
    }
}

StoreService_Delete

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }