Alleva Survey API
The Survey API from Alleva — 6 operation(s) for survey.
Documentation
Documentation
https://api.helloalleva.com/swagger/index.html
APIReference
https://api.helloalleva.com/swagger/index.html
OpenAPI Specification
openapi: 3.2.0
info:
title: Alleva Rest Survey API
version: '1.0'
security:
- Bearer: []
tags:
- name: Survey
paths:
/surveys/answers:
post:
tags:
- Survey
parameters:
- 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: array
items:
$ref: '#/components/schemas/SurveyAnswer'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SurveyAnswer'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SurveyAnswer'
application/*+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SurveyAnswer'
responses:
'200':
description: Success
/v{version}/surveys/answers:
post:
tags:
- Survey
parameters:
- 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: array
items:
$ref: '#/components/schemas/SurveyAnswer'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SurveyAnswer'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SurveyAnswer'
application/*+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SurveyAnswer'
responses:
'200':
description: Success
/surveys:
get:
tags:
- Survey
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
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/Survey'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Survey'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Survey'
/v{version}/surveys:
get:
tags:
- Survey
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
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/Survey'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Survey'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Survey'
/surveys/{id}:
get:
tags:
- Survey
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/Survey'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Survey'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Survey'
/v{version}/surveys/{id}:
get:
tags:
- Survey
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/Survey'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Survey'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Survey'
components:
schemas:
SurveyQuestion:
type: object
properties:
questionId:
type: integer
format: int32
question:
type:
- string
- 'null'
additionalProperties: false
Survey:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
title:
type:
- string
- 'null'
surveyQuestions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SurveyQuestion'
additionalProperties: false
SurveyAnswer:
type: object
properties:
clientId:
type: integer
format: int32
questionId:
type: integer
format: int32
score:
type: integer
format: int32
createdBy:
type: integer
format: int32
explanation:
type:
- string
- 'null'
submittedDateTime:
type: string
format: date-time
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then\
\ your token in the text input below.\n\nExample: Bearer 12345abcdef"
name: Authorization
in: header
servers:
- url: https://api.helloalleva.com
description: Base URL reconciled from apis.yml