Users

🔒 Скачивание ZIP-архива с документами пользователя (паспорт, удостоверение, военный билет и т.д.).

Скачивание ZIP-архива с документами пользователя (паспорт, удостоверение, военный билет и т.д.).

Access: authorized (10 ) · allowNullCompany: true · Scope: read

Allows: user:documents (все обязательны; ресурс — <тип>ID / ID из запроса, user:* — userID или сам пользователь)

TypeScript (copy-paste)

GET /user/archive-file

<details open><summary><b>Params</b></summary>
export interface UserArchiveFileParams {
  userID: string
  docsEmployment?: user_archive_file_docsEmployment | null
  docsLibrary?: string | null
}
</details> <details open><summary><b>Response</b></summary>
export type UserArchiveFileResponse = IServerResponse<Resp_user_archive-file>

export interface IServerResponse<T = any> {
  code: number
  data: T
  srvTS: number
  rkey: string
}
</details>

Полный файл типов: /docs/types · raw: /docs/api-types.ts

get/user/archive-file

Request

  • Base URL: http://localhost
  • URL: http://localhost/user/archive-file
  • Auth: one of:
    • API key in header sid and API key in header rts and API key in header sig
    • HTTP bearer

Query parameters

userIDstring uuid required

Можно передать header userID (сервер мержит headers+query)

docsEmployment'passportRf' | 'idCard' | 'voennyjBilet' | 'workPermit' | 'vnzh' | 'migrationCard'

passportRf = "passportRf", idCard = "idCard", voennyjBilet = "voennyjBilet", workPermit = "workPermit", vnzh = "vnzh", migrationCard = "migrationCard"

Можно передать header docsEmployment (сервер мержит headers+query)

docsLibrarystring uuid nullable

Можно передать header docsLibrary (сервер мержит headers+query)

Headers

devIDstring uuid required

UUID устройства клиента

tzstring required
Example:Europe/Moscow

Таймзона клиента (IANA или offset)

appstring required
Example:kosmodrom-web

Имя клиентского приложения

appVerstring required
Example:1.0.0

Версия клиента

rKeystring

Уникальный ключ запроса для логов/саппорта

Response

OK — IServerResponse<Resp_user_archive-file>

codeinteger required
dataRespUserArchiveFile required

Empty response object

srvTSinteger required

Server timestamp (ms)

rkeystring required

Request key

Example response

{
  "code": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.