The Clients API from Alleva — 38 operation(s) for clients.
openapi: 3.2.0
info:
title: Alleva Rest Clients API
version: '1.0'
security:
- Bearer: []
tags:
- name: Clients
paths:
/clients/{id}/luin:
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
patch:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/v{version}/clients/{id}/luin:
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
patch:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/clients/{id}/history:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ClientHistory'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientHistory'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientHistory'
/v{version}/clients/{id}/history:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ClientHistory'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientHistory'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientHistory'
/clients/duplicates:
get:
tags:
- Clients
parameters:
- name: firstName
in: query
schema:
type: string
- name: lastName
in: query
schema:
type: string
- name: email
in: query
schema:
type: string
- name: dateofbirth
in: query
schema:
type: string
- name: phoneNumber
in: query
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Client'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Client'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Client'
/v{version}/clients/duplicates:
get:
tags:
- Clients
parameters:
- name: firstName
in: query
schema:
type: string
- name: lastName
in: query
schema:
type: string
- name: email
in: query
schema:
type: string
- name: dateofbirth
in: query
schema:
type: string
- name: phoneNumber
in: query
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Client'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Client'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Client'
/clients/{id}/urgent-alerts:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
patch:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/v{version}/clients/{id}/urgent-alerts:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
patch:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientUrgentAlert'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/clients/{id}/urgent-alerts/read:
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
/v{version}/clients/{id}/urgent-alerts/read:
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserUrgentAlertMarkAsRead'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/CreateResult'
/clients/{id}/legacy-form:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: formId
in: query
schema:
type: integer
format: int32
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/v{version}/clients/{id}/legacy-form:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: formId
in: query
schema:
type: integer
format: int32
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/clients/{id}/documents:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateResult'
/v{version}/clients/{id}/documents:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientDocument'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateResult'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateResult'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateResult'
/clients/{id}/documents/{docId}:
delete:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: docId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/v{version}/clients/{id}/documents/{docId}:
delete:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: docId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/clients/{id}/image:
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/v{version}/clients/{id}/image:
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ClientLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/clients/{id}/contacts:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Contact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Contact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Contact'
/v{version}/clients/{id}/contacts:
get:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Contact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Contact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Contact'
/clients/{id}/step-down/documents:
post:
tags:
- Clients
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alleva/refs/heads/main/openapi/alleva-clients-api-openapi.yml