swagger: '2.0'
info:
description: >-
#### Adresse de l'API
L'API Opinion System est accessible à partir de l'adresse HTTPS suivante:
https://api.opinionsystem.fr/v2{path}?api_key={api_key}...
#### Fichier de définition Yaml
Pour télécharger le fichier swagger, veuillez cliquer sur le lien suivant:
https://api.opinionsystem.fr/v2/swagger.yaml
Avec ce fichier, vous pouvez générer un « client » pour notre API dans le
langage de votre choix.
#### Éditeur Swagger
http://editor.swagger.io
Simplement importer le fichier de définition et ensuite dans le menu «
Generate Client » choisir votre langage.
version: 2.19.0
title: Opinion System API v2.19.0
host: api.opinionsystem.fr
basePath: /v2
schemes:
- https
consumes:
- application/x-www-form-urlencoded
produces:
- application/json
securityDefinitions:
APIKeyQueryParam:
type: apiKey
in: query
name: api_key
security:
- APIKeyQueryParam: []
paths:
/endpoint:
get:
summary: 'Liste des {path} accessible avec votre clé API'
description: |
Permet de récupérer une liste de {path} accessible avec votre clé API
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/endpoint'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/company:
get:
summary: Liste d'adhérents
description: |
Permet de récupérer une liste d'adhérents
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
- name: siret
in: query
description: Siret de l'adhérent
required: false
type: string
- name: phone
in: query
description: Téléphone de l'adhérent
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_company'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/company/login:
get:
summary: Générer un lien de connexion
description: |
Permet de générer un lien HTTP pour accéder au compte client décrit par
les paramètres plus bas. Le lien est
valide pour **seulement** une période de 5 minutes. Si aucun *user_id*
n'est spécifié, alors le système tentera d'utiliser le compte du
gestionnaire de l'adhérent.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: user_id
in: query
description: ID de l'utilisateur
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_company_login'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/company/rating:
get:
summary: Évaluation d'un adhérent
description: |
Permet de récupérer les évaluations détaillées d'un adhérent
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_company_rating'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/company/survey:
get:
summary: Évaluation détaillé d'un adhérent
description: |
Permet de récupérer les évaluations détaillées des questionnaires d'une
entreprise
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: language
in: query
description: Langue de l'avis (3 lettres ISO 639-2/B)
required: false
type: string
- name: limit
in: query
description: nombre de questionnaire retourné
required: false
type: integer
- name: offset
in: query
description: index du premier questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_company_survey'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/company/url:
get:
summary: URLs du adhérent
description: Permet d'afficher les URL vers les questionnaires ou les certificats
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_company_url'
'204':
description: No Content
'403':
description: Missing Authentication Token
put:
summary: Mettre à jour les URL d'un adhérent
parameters:
- in: formData
name: company_id
description: ID de l'ahrérent
required: true
type: integer
format: int32
- in: formData
name: certificate
description: lien vers les certificats
required: false
type: string
- in: formData
name: survey
description: lien vers les questionnaires
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/resource'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/company/user:
get:
summary: Liste d'utilisateurs
description: |
Permet de générer une liste des utilisateurs d'un adhérent.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: user_id
in: query
description: ID de l'utilisateur
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_company_user'
'204':
description: No Content
'400':
description: Bad Request
'403':
description: Missing Authentication Token
/client/collaborator:
get:
summary: Liste des collaborateurs
description: |
Permet d'obtenir la liste des collaborateurs disponibles.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: external_id
in: query
description: ID externe
required: false
type: string
- name: email
in: query
description: Adresse mail du collaborateur
required: false
type: string
- name: siret
in: query
description: SIRET du collaborateur
required: false
type: string
- name: collaborator_id
in: query
description: ID du collaborateur
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_collaborator'
'204':
description: No Content
'403':
description: Missing Authentication Token
post:
summary: Ajouter un collaborateur
description: ''
parameters:
- in: formData
name: company_id
description: ID de l'adhérent
required: true
type: integer
format: int32
- in: formData
name: external_id
description: ID externe
required: false
type: string
- in: formData
name: first_name
description: Prénom du collaborateur
required: true
type: string
- in: formData
name: last_name
description: Nom du collaborateur
required: true
type: string
- in: formData
name: title
description: Titre du collaborateur
required: false
type: string
- in: formData
name: email
description: E-mail du collaborateur
required: false
type: string
- in: formData
name: siret
description: SIRET du collaborateur
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/resource'
'400':
description: Bad Request
'403':
description: Missing Authentication Token
put:
summary: Mettre à jour un collaborateur
description: '*collaborator_id* ou *external_id* est obligatoire'
parameters:
- in: formData
name: external_id
description: ID externe
required: true
type: string
- in: formData
name: collaborator_id
description: ID du collaborateur
required: true
type: integer
format: int32
- in: formData
name: first_name
description: Prénom du collaborateur
required: false
type: string
- in: formData
name: last_name
description: Nom du collaborateur
required: false
type: string
- in: formData
name: title
description: Titre du collaborateur
required: false
type: string
- in: formData
name: email
description: E-mail du collaborateur
required: false
type: string
- in: formData
name: siret
description: SIRET du collaborateur
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/resource'
'400':
description: Bad Request
'403':
description: Missing Authentication Token
delete:
summary: Supprimer un collaborateur
description: '*collaborator_id* ou *external_id* est obligatoire'
parameters:
- name: collaborator_id
in: formData
description: ID du collaborateur
required: true
type: integer
- name: external_id
in: formData
description: ID externe
required: true
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
'403':
description: Missing Authentication Token
/client/collaborator/url:
get:
summary: URLs du collaborateur
description: Permet d'afficher les URL vers les questionnaires ou les certificats
parameters:
- name: collaborator_id
in: query
description: ID du collaborateur
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_collaborator_url'
'204':
description: No Content
'403':
description: Missing Authentication Token
put:
summary: Mettre à jour les URL d'un collaborateur
parameters:
- in: formData
name: collaborator_id
description: ID du collaborateur
required: true
type: integer
format: int32
- in: formData
name: certificate
description: lien vers les certificats
required: false
type: string
- in: formData
name: survey
description: lien vers les questionnaires
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/resource'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/collaborator/rating:
get:
summary: Évalutation d'un collaborateur
description: |
Permet de récupérer les évaluations détaillées d'un collaborateur.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: collaborator_id
in: query
description: ID du collaborateur
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_collaborator_rating'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/collaborator/survey:
get:
summary: Évaluation détaillé d'un collaborateur
description: |
Permet de récupérer les évaluations détaillées des questionnaires d'un
collaborateur
parameters:
- name: collaborator_id
in: query
description: ID du collaborateur
required: false
type: integer
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: language
in: query
description: Langue de l'avis (3 lettres ISO 639-2/B)
required: false
type: string
- name: limit
in: query
description: nombre de questionnaire retourné
required: false
type: integer
- name: offset
in: query
description: index du premier questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_collaborator_survey'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/group:
get:
summary: Liste des groupes
description: |
Permet d'obtenir la liste des groupes disponibles.
parameters:
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_group'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/group/rating:
get:
summary: Liste des groupes
description: |
Permet de récupérer les évaluations détaillées d'un groupe.
parameters:
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_group_rating'
'204':
description: No Content
'403':
description: Missing Authentication Token
/client/group/survey:
get:
summary: Liste des questionnaires d'un groupe
description: |
Permet d'obtenir la liste des questionnaires d'un groupe.
parameters:
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: language
in: query
description: Langue de l'avis (3 lettres ISO 639-2/B)
required: false
type: string
- name: limit
in: query
description: nombre de questionnaire retourné
required: false
type: integer
- name: offset
in: query
description: index du premier questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/client_group_survey'
'204':
description: No Content
'403':
description: Missing Authentication Token
/collaborator:
get:
summary: Liste des collaborateurs
description: |
Permet d'obtenir la liste des collaborateurs disponibles.
parameters:
- name: collaborator_id
in: query
description: ID du collaborateur
required: false
type: integer
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: email
in: query
description: Adresse mail du collaborateur
required: false
type: string
- name: siret
in: query
description: SIRET du collaborateur
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/collaborator'
'204':
description: No Content
'403':
description: Missing Authentication Token
/collaborator/rating:
get:
summary: Évalutation d'un collaborateur
description: |
Permet de récupérer les évaluations détaillées d'un collaborateur.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: collaborator_id
in: query
description: ID du collaborateur
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/collaborator_rating'
'204':
description: No Content
'403':
description: Missing Authentication Token
/collaborator/survey:
get:
summary: Évaluation détaillé d'un collaborateur
description: |
Permet de récupérer les évaluations détaillées des questionnaires d'un
collaborateur
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: collaborator_id
in: query
description: ID du collaborateur
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: language
in: query
description: Langue de l'avis (3 lettres ISO 639-2/B)
required: false
type: string
- name: limit
in: query
description: nombre de questionnaire retourné
required: false
type: integer
- name: offset
in: query
description: index du premier questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/collaborator_survey'
'204':
description: No Content
'403':
description: Missing Authentication Token
/company:
get:
summary: Liste d'adhérents
description: |
Permet de récupérer une liste d'adhérents
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
- name: siret
in: query
description: Siret de l'adhérent
required: false
type: string
- name: phone
in: query
description: Téléphone de l'adhérent
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/company'
'204':
description: No Content
'403':
description: Missing Authentication Token
/company/rating:
get:
summary: Évaluation d'un adhérent
description: |
Permet de récupérer les évaluations détaillées d'un adhérent
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: siret
in: query
description: Siret de l'adhérent
required: false
type: string
- name: phone
in: query
description: Téléphone de l'adhérent
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/company_rating'
'204':
description: No Content
'403':
description: Missing Authentication Token
/company/survey:
get:
summary: Évaluation détaillé d'un adhérent
description: |
Permet de récupérer les évaluations détaillées des questionnaires d'une
entreprise
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: language
in: query
description: Langue de l'avis (3 lettres ISO 639-2/B)
required: false
type: string
- name: siret
in: query
description: Siret de l'adhérent
required: false
type: string
- name: phone
in: query
description: Téléphone de l'adhérent
required: false
type: string
- name: limit
in: query
description: nombre de questionnaire retourné
required: false
type: integer
- name: offset
in: query
description: index du premier questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/company_survey'
'204':
description: No Content
'403':
description: Missing Authentication Token
/group:
get:
summary: Liste des groupes
description: |
Permet d'obtenir la liste des groupes disponibles.
parameters:
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/group'
'204':
description: No Content
'403':
description: Missing Authentication Token
/group/rating:
get:
summary: Évaluation d'un groupe
description: |
Permet de récupérer les évaluations détaillées d'un groupe
parameters:
- name: group_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/group_rating'
'204':
description: No Content
'403':
description: Missing Authentication Token
/group/survey:
get:
summary: Évaluation détaillé d'un groupe
description: |
Permet de récupérer les évaluations détaillées des questionnaires d'un
groupe
parameters:
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: language
in: query
description: Langue de l'avis (3 lettres ISO 639-2/B)
required: false
type: string
- name: siret
in: query
description: SIRET de l'adhérent
required: false
type: string
- name: limit
in: query
description: nombre de questionnaire retourné
required: false
type: integer
- name: offset
in: query
description: index du premier questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/group_survey'
'204':
description: No Content
'403':
description: Missing Authentication Token
/relation:
get:
summary: Association de SIRET
description: Permet d'associer un SIRET à une compagnie ou un groupe
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: siret
in: query
description: SIRET de l'adhérent
required: false
type: string
- name: forward
in: query
description: Commande de destination
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/relation'
'204':
description: No Content
'403':
description: Missing Authentication Token
/sector:
get:
summary: Liste des secteurs
description: |
Permet d'obtenir la liste des secteurs disponibles.
parameters:
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
- name: language
in: query
description: Langue du secteur
required: false
type: string
default: fre
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/sector'
'204':
description: No Content
'403':
description: Missing Authentication Token
/sector/rating:
get:
summary: Évaluations d'un secteur
description: |
Permet de récupérer les évaluations détaillées d'un secteur.
parameters:
- name: sector_id
in: query
description: ID du secteur
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/sector_rating'
'204':
description: No Content
'403':
description: Missing Authentication Token
/sector/survey:
get:
summary: Évaluation détaillé d'un secteur
description: |
Permet de récupérer les évaluations détaillées des questionnaires d'un
secteur
parameters:
- name: sector_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: category_id
in: query
description: ID de la catégorie
required: false
type: integer
- name: language
in: query
description: Langue de l'avis (3 lettres ISO 639-2/B)
required: false
type: string
- name: limit
in: query
description: nombre de questionnaire retourné
required: false
type: integer
- name: offset
in: query
description: index du premier questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/sector_survey'
'204':
description: No Content
'403':
description: Missing Authentication Token
/survey:
get:
summary: Liste des questionnaires.
description: |
Permet d'obtenir la liste des questionnaires disponibles.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
format: int32
- name: siret
in: query
description: SIRET de l'adhérent
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/survey'
'204':
description: No Content
'400':
description: Bad Request
'403':
description: Missing Authentication Token
/survey/category:
get:
summary: Liste des catégories de questionnaire.
description: |
Permet d'obtenir la liste des catégories de questionnaire disponibles.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
format: int32
- name: group_id
in: query
description: ID du groupe
required: false
type: integer
format: int32
- name: sector_id
in: query
description: ID du sectrue d'activité
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/survey_category'
'204':
description: No Content
'403':
description: Missing Authentication Token
/survey/question:
get:
summary: Légendes texte des questions.
description: |
Permet de récupérer les légendes texte dans une langue particulière
pour les questions d'évaluation
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: siret
in: query
description: SIRET de l'adhérent
required: false
type: string
- name: language
in: query
description: Langue des questions
required: false
type: string
default: fre
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/survey_question'
'204':
description: No Content
'403':
description: Missing Authentication Token
/survey/send:
post:
summary: Envoi d'un questionnaire.
description: |-
Permet d'emvoyer un questionnaire.
**Ici, {company_id} ou {siret} est obligatoire, de même que {phone} ou {email}**.
{phone} doit être en format international (exemple: 05 33 52 06 54 => +33 5 33 52 06 54)
parameters:
- name: company_id
in: formData
description: ID de l'adhérent
required: true
type: integer
- name: collaborator_id
in: formData
description: ID du collaborateur
required: false
type: integer
- name: question_id
in: formData
description: ID du questionnaire interne
required: false
type: integer
- name: survey_category_id
in: formData
description: ID de la catégorie
required: false
type: integer
- name: siret
in: formData
description: SIRET de l'adhérent
required: true
type: string
- name: first_name
in: formData
description: Prénom du client
required: true
type: string
- name: last_name
in: formData
description: Nom du client
required: true
type: string
- name: phone
in: formData
description: Téléphone du client
required: true
type: string
- name: email
in: formData
description: E-mail du client
required: true
type: string
- name: postal_code
in: formData
description: Code postal du client
required: false
type: string
- name: city
in: formData
description: Ville du client
required: false
type: string
- name: country
in: formData
description: Pays du client (2 lettres ISO alpha-2)
required: false
type: string
- name: invoice_detail
in: formData
description: Détail de la prestation
required: true
type: string
- name: invoice_period
description: Date de prestation (YYYY-MM)
in: formData
required: true
type: string
format: date
- name: language
in: formData
description: Langue du client (3 lettres ISO 639-2/B)
type: string
default: fre
responses:
'200':
description: Ok
'201':
description: OK
schema:
type: array
items:
$ref: '#/definitions/resource'
'204':
description: No Content
'400':
description: Bad Request
'403':
description: Missing Authentication Token
/survey/status:
get:
summary: Statut d'un questionnaire.
description: |
Permet d'obtenir le statut d'un questionnaire de satisfaction envoyé.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: survey_id
in: query
description: ID du questionnaire
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/survey_status'
'204':
description: No Content
'403':
description: Missing Authentication Token
/widget/company/statistic:
get:
summary: Générer un lien de connexion
description: |
Permet de générer un lien HTTP pour accéder au compte client décrit par
les paramètres plus bas. Le lien est
valide pour **seulement** une période de 5 minutes. Si aucun *user_id*
n'est spécifié, alors le système tentera d'utiliser le compte du
gestionnaire de l'adhérent.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/widget_company_statistic'
'204':
description: No Content
'400':
description: Bad Request
'403':
description: Missing Authentication Token
/user:
get:
summary: "Liste d'utilisateurs"
description: |
Permet de générer une liste d'utilisateurs.
parameters:
- name: company_id
in: query
description: ID de l'adhérent
required: false
type: integer
- name: user_id
in: query
description: "ID de l'utilisateur"
required: false
type: integer
- name: group_id
in: query
description: "ID du groupe"
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/user'
'204':
description: No Content
'400':
description: Bad Request
'403':
description: Missing Authentication Token
/user/identity:
get:
summary: "Information d'un identité"
description: |
Permet d'obtenir de l'information sur un "User Identity"
parameters:
- name: user_identity_id
in: query
description: ID du "User Identity"
required: false
type: integer
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/user_identity_get'
'204':
description: No Content
'400':
description: Bad Request
'403':
description: Missing Authentication Token
post:
summary: "Enregistrer un identité"
description: |
permet de générer un Identiter utilisateur qui vas être utiliser pour connecter en utilisant un system de Single Sign On.
parameters:
- name: user_id
in: query
description: "ID de l'utilisateur de notre system."
required: false
type: integer
- name: name_id
in: query
description: "ID qui represente l'utilisateur du coter du Identity Provider."
required: false
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/resource'
'201':
description: Created
'400':
description: Bad Request
'403':
description: Missing Authentication Token
'409':
description: Conflict - Duplicate
put:
summary: "Mettre à jour un identité"
description: |
Seulement le name_id peux etre modifier.
parameters:
- name: user_id
in: query
description: "ID de l'utilisateur de notre system."
required: false
type: integer
- name: name_id
in: query
description: "ID qui represente l'utilisateur du coter du Identity Provider."
required: false
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
'403':
description: Missing Authentication Token
delete:
summary: "Supprimer une identité"
description: |
user_id ou name_id est obligatoire
parameters:
- name: user_id
in: query
description: "ID de l'utilisateur de notre system."
required: false
type: integer
- name: name_id
in: query
description: "ID qui represente l'utilisateur du coter du Identity Provider."
required: false
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
'403':
description: Missing Authentication Token
definitions:
endpoint:
type: array
items:
$ref: '#/definitions/endpoint_uri'
endpoint_uri:
type: object
properties:
uri:
type: string
company:
type: array
items:
$ref: '#/definitions/endpoint_permission'
group:
type: array
items:
$ref: '#/definitions/endpoint_permission'
sector:
type: array
items:
$ref: '#/definitions/endpoint_permission'
endpoint_permission:
type: object
properties:
ownership:
type: boolean
get:
type: boolean
post:
type: boolean
put:
type: boolean
delete:
type: boolean
flag:
type: string
client_company:
type: object
properties:
company_id:
type: integer
format: int32
brand_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
siret:
type: string
name:
type: string
address:
type: string
city:
type: string
postal_code:
type: string
country:
type: string
telephone:
type: string
fax:
type: string
email:
type: string
web_site:
type: string
certificate:
type: string
survey:
type: string
logo:
type: string
enrollment:
type: string
format: date
relation:
type: object
properties:
uri:
type: string
client_company_login:
type: object
properties:
url:
type: string
expiry:
type: string
format: date
client_company_rating:
type: object
properties:
company_id:
type: integer
format: int32
brand_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
survey_total:
type: integer
format: int32
survey_good_total:
type: integer
format: int32
survey_neutral_total:
type: integer
format: int32
survey_bad_total:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
roi:
$ref: '#/definitions/client_company_rating_roi'
client_company_rating_roi:
type: object
properties:
total:
type: integer
format: int32
seen:
type: integer
format: int32
help:
type: integer
format: int31
client_company_survey:
type: object
properties:
survey_id:
type: integer
format: int32
collaborator_id:
type: integer
format: int32
company_id:
type: integer
format: int32
category_id:
type: integer
format: int32
answer:
type: string
format: date
name:
type: string
language:
$ref: '#/definitions/language'
client:
$ref: '#/definitions/client_company_survey_client'
invoice_detail:
type: string
invoice_period:
type: string
format: date
comment:
type: string
comment_response:
type: string
smiley_good:
type: integer
format: int32
smiley_neutral:
type: integer
format: int32
smiley_bad:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
roi:
$ref: '#/definitions/client_company_survey_roi'
review_abuse_url:
type: string
single_survey_link:
type: string
client_company_survey_roi:
type: object
properties:
seen:
type: integer
format: int32
help:
type: integer
format: int31
client_company_url:
type: object
properties:
company_id:
type: integer
format: int32
certificate:
type: string
survey:
type: string
client_collaborator_url:
type: object
properties:
collaborator_id:
type: integer
format: int32
certificate:
type: string
survey:
type: string
client_collaborator_rating:
type: object
properties:
collaborator_id:
type: integer
format: int32
company_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
survey_total:
type: integer
format: int32
survey_good_total:
type: integer
format: int32
survey_neutral_total:
type: integer
format: int32
survey_bad_total:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
roi:
$ref: '#/definitions/client_collaborator_rating_roi'
client_collaborator_rating_roi:
type: object
properties:
seen:
type: integer
format: int32
help:
type: integer
format: int31
client_collaborator_survey:
type: object
properties:
survey_id:
type: integer
format: int32
collaborator_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
company_id:
type: integer
format: int32
category_id:
type: integer
format: int32
answer:
type: string
format: date
name:
type: string
language:
$ref: '#/definitions/language'
client:
$ref: '#/definitions/client_collaborator_survey_client'
invoice_detail:
type: string
invoice_period:
type: string
format: date
comment:
type: string
comment_response:
type: string
smiley_good:
type: integer
format: int32
smiley_neutral:
type: integer
format: int32
smiley_bad:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
roi:
$ref: '#/definitions/client_collaborator_survey_roi'
review_abuse_url:
type: string
single_survey_link:
type: string
client_collaborator_survey_roi:
type: object
properties:
seen:
type: integer
format: int32
help:
type: integer
format: int32
collaborator_rating:
type: object
properties:
collaborator_id:
type: integer
format: int32
company_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
survey_total:
type: integer
format: int32
survey_good_total:
type: integer
format: int32
survey_neutral_total:
type: integer
format: int32
survey_bad_total:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
client_company_user:
type: object
properties:
user_id:
type: integer
format: int32
company_id:
type: integer
format: int32
datetime:
type: string
format: date
first_name:
type: string
last_name:
type: string
phone:
type: string
email:
type: string
language:
type: string
time_zone:
type: string
company:
type: object
properties:
company_id:
type: integer
format: int32
brand_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
siret:
type: string
name:
type: string
address:
type: string
city:
type: string
postal_code:
type: string
country:
type: string
telephone:
type: string
fax:
type: string
email:
type: string
web_site:
type: string
certificate:
type: string
survey:
type: string
logo:
type: string
enrollment:
type: string
format: date
relation:
type: object
properties:
uri:
type: string
company_rating:
type: object
properties:
company_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
survey_total:
type: integer
format: int32
survey_good_total:
type: integer
format: int32
survey_neutral_total:
type: integer
format: int32
survey_bad_total:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
company_survey:
type: object
properties:
survey_id:
type: integer
format: int32
collaborator_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
company_id:
type: integer
format: int32
category_id:
type: integer
format: int32
answer:
type: string
format: date
name:
type: string
language:
$ref: '#/definitions/language'
invoice_detail:
type: string
invoice_period:
type: string
format: date
rating:
type: integer
format: int32
smiley_good:
type: integer
format: int32
smiley_neutral:
type: integer
format: int32
smiley_bad:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
comment:
type: string
comment_response:
type: string
review_abuse_url:
type: string
single_survey_link:
type: string
collaborator:
type: object
properties:
collaborator_id:
type: integer
format: int32
company_id:
type: integer
format: int32
first_name:
type: string
last_name:
type: string
title:
type: string
siret:
type: string
certificate:
type: string
survey:
type: string
collaborator_survey:
type: object
properties:
survey_id:
type: integer
format: int32
collaborator_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
company_id:
type: integer
format: int32
category_id:
type: integer
format: int32
answer:
type: string
format: date
name:
type: string
language:
$ref: '#/definitions/language'
invoice_detail:
type: string
invoice_period:
type: string
format: date
rating:
type: integer
format: int32
smiley_good:
type: integer
format: int32
smiley_neutral:
type: integer
format: int32
smiley_bad:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
comment:
type: string
comment_response:
type: string
review_abuse_url:
type: string
single_survey_link:
type: string
client_collaborator:
type: object
properties:
collaborator_id:
type: integer
format: int32
company_id:
type: integer
format: int32
external_id:
type: string
first_name:
type: string
last_name:
type: string
title:
type: string
email:
type: string
siret:
type: string
certificate:
type: string
survey:
type: string
client_group:
type: object
properties:
group_id:
type: integer
format: int32
parent_id:
type: integer
format: int32
name:
type: string
address:
type: string
city:
type: string
postal_code:
type: string
country:
type: string
telephone:
type: string
fax:
type: string
email:
type: string
web_site:
type: string
certificate:
type: string
logo:
type: string
client_group_rating:
type: object
properties:
group_id:
type: integer
format: int32
survey_total:
type: integer
format: int32
survey_good_total:
type: integer
format: int32
survey_neutral_total:
type: integer
format: int32
survey_bad_total:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
roi:
$ref: '#/definitions/client_group_rating_roi'
client_group_rating_roi:
type: object
properties:
total:
type: integer
format: int32
seen:
type: integer
format: int32
help:
type: integer
format: int31
client_group_survey:
type: object
properties:
survey_id:
type: integer
format: int32
collaborator_id:
type: integer
format: int32
company_id:
type: integer
format: int32
category_id:
type: integer
format: int32
answer:
type: string
format: date
name:
type: string
language:
$ref: '#/definitions/language'
client:
$ref: '#/definitions/client_company_survey_client'
invoice_detail:
type: string
invoice_period:
type: string
format: date
comment:
type: string
comment_response:
type: string
smiley:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
roi:
$ref: '#/definitions/client_group_survey_roi'
review_abuse_url:
type: string
single_survey_link:
type: string
client_group_survey_roi:
type: object
properties:
seen:
type: integer
format: int32
help:
type: integer
format: int31
group:
type: object
properties:
group_id:
type: integer
format: int32
parent_id:
type: integer
format: int32
name:
type: string
address:
type: string
city:
type: string
postal_code:
type: string
country:
type: string
telephone:
type: string
fax:
type: string
email:
type: string
web_site:
type: string
certificate:
type: string
logo:
type: string
group_rating:
type: object
properties:
group_id:
type: integer
format: int32
survey_total:
type: integer
format: int32
survey_good_total:
type: integer
format: int32
survey_neutral_total:
type: integer
format: int32
survey_bad_total:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
group_survey:
type: object
properties:
survey_id:
type: integer
format: int32
collaborator_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
company_id:
type: integer
format: int32
category:
$ref: '#/definitions/client_company_survey_category'
answer:
type: string
format: date
name:
type: string
language:
$ref: '#/definitions/language'
invoice_detail:
type: string
invoice_period:
type: string
format: date
smiley:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
review_abuse_url:
type: string
single_survey_link:
type: string
relation:
type: object
properties:
group_id:
type: integer
format: int32
company_id:
type: integer
format: int32
forward:
type: string
sector:
type: object
properties:
sector_id:
type: integer
format: int32
name:
type: string
phase_integration:
type: integer
format: int32
sector_rating:
type: object
properties:
sectr_id:
type: integer
format: int32
survey_total:
type: integer
format: int32
survey_good_total:
type: integer
format: int32
survey_neutral_total:
type: integer
format: int32
survey_bad_total:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
format: int32
display:
type: boolean
sector_survey:
type: object
properties:
survey_id:
type: integer
format: int32
collaborator_id:
type: integer
format: int32
company_id:
type: integer
format: int32
category:
$ref: '#/definitions/client_company_survey_category'
answer:
type: string
format: date
name:
type: string
language:
$ref: '#/definitions/language'
invoice_detail:
type: string
invoice_period:
type: string
format: date
smiley:
type: integer
format: int32
rating:
type: integer
format: int32
question_1:
type: integer
format: int32
question_2:
type: integer
format: int32
question_3:
type: integer
format: int32
question_4:
type: integer
format: int32
question_5:
type: integer
format: int32
question_6:
type: integer
review_abuse_url:
type: string
single_survey_link:
type: string
widget_company_statistic:
type: object
properties:
widget_key:
type: string
expiration:
type: string
format: date
survey:
type: object
properties:
question_id:
type: integer
format: int32
name:
type: string
language:
type: string
certified:
type: boolean
survey_category:
type: object
properties:
survey_category_id:
type: integer
format: int32
sector_id:
type: integer
format: int32
name:
type: string
survey_question:
type: object
properties:
company_id:
type: integer
format: int32
name:
type: string
question_id:
type: integer
format: int32
question_1_short:
type: string
question_1_medium:
type: string
question_1_long:
type: string
question_2_short:
type: string
question_2_medium:
type: string
question_2_long:
type: string
question_3_short:
type: string
question_3_medium:
type: string
question_3_long:
type: string
question_4_short:
type: string
question_4_medium:
type: string
question_4_long:
type: string
question_5_short:
type: string
question_5_medium:
type: string
question_5_long:
type: string
question_6_short:
type: string
question_6_medium:
type: string
question_6_long:
type: string
certified:
type: boolean
survey_status:
type: object
properties:
survey_id:
type: integer
format: int32
datetime_send:
type: string
format: date
datetime_answer:
type: string
format: date
status:
type: integer
format: int32
status_extended:
type: integer
format: int32
client_company_survey_category:
properties:
category_id:
type: integer
format: int32
name:
type: string
client_company_survey_client:
properties:
country:
type: string
city:
type: string
address:
type: string
postal_code:
type: string
last_name:
type: string
first_name:
type: string
email:
type: string
client_collaborator_survey_client:
properties:
country:
type: string
city:
type: string
address:
type: string
postal_code:
type: string
last_name:
type: string
first_name:
type: string
email:
type: string
language:
properties:
code:
type: string
locale:
type: string
user:
properties:
user_id:
type: integer
company_id:
type: integer
first_name:
type: string
last_name:
type: string
email:
type: string
user_identity_get:
properties:
user_identity_id:
type: integer
user_id:
type: integer
name_id:
type: string
first_name:
type: string
last_name:
type: string
resource:
type: object
properties:
uri:
type: string