Skip to main content
Skip table of contents

Upload summary file key|apartment|user

Uploading an xlsx file to save a consolidated list of keys, flats, and users for a specified intercom.

A notification about the file upload will be sent to the push channel token.ID

See Types of websocket pushes (section «Push for successful export of consolidated intercom key|apartment|user file»)

In case of data errors in the file, a new file will be generated with marked cells containing errors, and a link to this file will be sent to the push channel token.ID

See Types of websocket pushes (section «Push for unsuccessful export of consolidated intercom key|apartment|user file»)

Permission required for this request: intercom-update

POST/api/admin/v1/intercoms/{intercom}/upload

Headers

Authorization

Bearer token

Accept

application/json

Body

json

JSON
{
    "file": "file.xlsx",
    "hash": "98c8ae8cd75194498f53fd37afb89625"
}

intercomoptional

int

Unique identifier of the intercom

filerequired

file

Consolidated key|flat|user file

hashrequired

string

Temporary hash key for the uploaded file

Response

201

«Warning» message stating that existing data will be deleted upon file upload.

JSON
{
                "file_uploaded": true,
                "hash": "68227b6d2954b043f0f939413cf53bb0",
                "expires_at": "2023-05-17T08:28:51.469496Z"
            }

hash

Hash that can be used to retrieve the pre-uploaded file

Returned in the response when attempting to upload a file for the first time and data for the specified intercom already exists.

204

Successful response

401

Authorization token is not provided or is invalid. Obtaining a token

Example

JSON
curl -k --location --request POST 'https://vms.local/api/admin/v1/intercoms/{intercom}/upload' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'Content-Type: application/json \
--data-raw '{
    "file": "file.xlsx",
    "hash": "98c8ae8cd75194498f53fd37afb89625"
}'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.