{
"swagger": "2.0",
"info": {
"title": "API Suivideflotte.net",
"description": "Documentation de l'API RESTful Suivideflotte.net. Si vous disposez de cl\u00e9s d'API valides, vous pouvez manipuler directement l'API \u00e0 travers cette page (cliquez sur le bouton Authorize). Soyez vigilant sur les op\u00e9rations que vous effectez car vous agissez sur vos donn\u00e9es de production.",
"version": "Version "
},
"host": "api.suivideflotte.net",
"schemes": [
"https"
],
"paths": {
"/admin/users": {
"get": {
"tags": [
"Admin/Users"
],
"summary": "Liste (pagin\u00e9e) tous les utilisateurs",
"description": "Liste (pagin\u00e9e) de tous les utilisateurs.",
"operationId": "getAllUsers",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 12
},
"name": {
"description": "Nom",
"type": "string",
"maximum": "33",
"example": "John Doe"
},
"email": {
"description": "Email",
"type": "string",
"example": "john.doe@mail.com"
},
"phone": {
"description": "T\u00e9l\u00e9phone",
"type": "string",
"example": "**-**-**-**-**"
},
"login": {
"description": "Identifiant de connexion",
"type": "string",
"example": "john.doe"
},
"lastConnectionAt": {
"description": "Date derni\u00e8re de connexion",
"type": "string",
"example": "2017-11-12 12:12:12"
},
"connectionCounter": {
"description": "Nombre de connexion",
"type": "integer",
"example": 10
},
"createdAt": {
"description": "Nombre de connexion",
"type": "integer",
"example": "2017-11-12 10:12:12"
},
"auth": {
"properties": {
"provider": {
"description": "Type de connexion : login/password ou SSO",
"type": "string",
"example": "password|Google"
},
"secret": {
"description": "Mot de passe ou Email du compte li\u00e9 au provider SSO.",
"type": "string",
"example": "password001|john.doe@gmail.com"
}
},
"type": "object"
},
"profile": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Simple consultation"
}
},
"type": "object"
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Admin/Users"
],
"summary": "Cr\u00e9ation d'un utilisateur",
"description": "Permet de cr\u00e9er un utilisateur. Selon le type d'authentification (login/mot de passe ou SSO), vous devez pr\u00e9ciser `login` et `password` ou `sso`.",
"operationId": "UserCreate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"required": [
"name",
"email"
],
"properties": {
"name": {
"description": "Nom de l'utilisateur",
"type": "string",
"maximum": "33",
"example": "John Doe"
},
"email": {
"description": "Email de l'utilisateur",
"type": "string",
"example": "john.doe@mail.com"
},
"phone": {
"description": "T\u00e9l\u00e9phone de l'utilisateur",
"type": "string",
"example": "**-**-**-**-**"
},
"login": {
"description": "Identifiant au format pr\u00e9nom.nom",
"type": "string"
},
"auth": {
"properties": {
"provider": {
"description": "Type de connexion : login/password ou SSO",
"type": "string",
"example": "password|Google"
},
"secret": {
"description": "Mot de passe ou Email du compte li\u00e9 au provider SSO.",
"type": "string",
"example": "password001|john.doe@gmail.com"
}
},
"type": "object"
},
"profil": {
"properties": {
"id": {
"description": "profile utilisateur",
"type": "integer",
"example": 1
}
},
"type": "object"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/admin/users/{id}": {
"get": {
"tags": [
"Admin/Users"
],
"summary": "Utilisateur sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es pour un utilisateur sp\u00e9cifique",
"operationId": "getUser",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 12
},
"name": {
"description": "Nom",
"type": "string",
"maximum": "33",
"example": "John Doe"
},
"email": {
"description": "Email",
"type": "string",
"example": "john.doe@mail.com"
},
"phone": {
"description": "T\u00e9l\u00e9phone",
"type": "string",
"example": "**-**-**-**-**"
},
"login": {
"description": "Identifiant de connexion",
"type": "string",
"example": "john.doe"
},
"lastConnectionAt": {
"description": "Date derni\u00e8re de connexion",
"type": "string",
"example": "2017-11-12 12:12:12"
},
"connectionCounter": {
"description": "Nombre de connexion",
"type": "integer",
"example": 10
},
"createdAt": {
"description": "Nombre de connexion",
"type": "integer",
"example": "2017-11-12 10:12:12"
},
"auth": {
"properties": {
"provider": {
"description": "Type de connexion : login/password ou SSO",
"type": "string",
"example": "password|Google"
},
"secret": {
"description": "Mot de passe ou Email du compte li\u00e9 au provider SSO.",
"type": "string",
"example": "password001|john.doe@gmail.com"
}
},
"type": "object"
},
"profile": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Simple consultation"
}
},
"type": "object"
},
"groups": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Simple consultation"
}
}
}
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Admin/Users"
],
"summary": "Modification d'un utilisateur",
"description": "Permet de modifier les informations d'un utilisateur.",
"operationId": "UserUpdate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant de l'utilisateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"required": [
"name",
"email",
"password",
"provider",
"profil"
],
"properties": {
"name": {
"description": "Nom de l'utilisateur",
"type": "string",
"maximum": "33",
"example": "John Doe"
},
"email": {
"description": "Email de l'utilisateur",
"type": "string",
"example": "john.doe@mail.com"
},
"phone": {
"description": "T\u00e9l\u00e9phone de l'utilisateur",
"type": "string",
"example": "**-**-**-**-**"
},
"auth": {
"properties": {
"provider": {
"description": "Type de connexion : login/password ou SSO",
"type": "string",
"example": "password|Google"
},
"secret": {
"description": "Mot de passe ou Email du compte li\u00e9 au provider SSO.",
"type": "string",
"example": "password001|john.doe@gmail.com"
}
},
"type": "object"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Admin/Users"
],
"summary": "Supprimer un utilisateur",
"operationId": "deleteUser",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de l'utilisateur",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/actionpoints": {
"get": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Liste de tous les Action Points physiques (hors AP de type zone ou groupe)",
"operationId": "getAllActionPoints",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/ActionPointWithPlans"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "Page X does not exist (last page is Y)."
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Cr\u00e9er un Action Point",
"operationId": "createActionPoint",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model ActionPoint n\u00e9cessaire \u00e0 la cr\u00e9ation d'un Action Point",
"required": true,
"schema": {
"$ref": "#/definitions/ActionPoint"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/beepiz/plans/{id}/groups": {
"post": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Cr\u00e9er un groupe ou une zone",
"operationId": "createActionPointGroup",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model ActionPoint n\u00e9cessaire \u00e0 la cr\u00e9ation d'un Action Point",
"required": true,
"schema": {
"$ref": "#/definitions/ActionPoint"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/beepiz/actionpoints/{id}": {
"get": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Voir un Action Point",
"description": "Voir un Action Point selon son id",
"operationId": "getActionPointById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de l'Action Point",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ActionPointWithPlans"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Modifier un Action Point",
"operationId": "updateActionPoint",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model ActionPoint n\u00e9cessaire \u00e0 la cr\u00e9ation d'un Action Point",
"required": true,
"schema": {
"$ref": "#/definitions/ActionPoint"
}
},
{
"name": "id",
"in": "path",
"description": "id de l'Action Point",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
}
]
},
"delete": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Supprimer un Action Point",
"operationId": "deleteActionPoint",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de l'Action Point \u00e0 supprimer",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/beepiz/plans/{planId}/actionpoints": {
"get": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Voir l'arborescence des Action Points li\u00e9s \u00e0 un plan donn\u00e9",
"description": "Voir l'arborescence des Action Points li\u00e9s \u00e0 un plan donn\u00e9",
"operationId": "getActionPointTreeFromPlan",
"produces": [
"application/json"
],
"parameters": [
{
"name": "planId",
"in": "path",
"description": "id du plan",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ActionPointTree"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/plans/{planId}/actionpoints/available": {
"get": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "R\u00e9cup\u00e9rer la liste des action points disponibles.",
"description": "R\u00e9cup\u00e8re la liste pagin\u00e9e des Action Points non rattach\u00e9s \u00e0 un plan, et des Action Points rattach\u00e9s \u00e0 un plan fr\u00e8re dont le plan parent est de type `service` ou `floor`",
"operationId": "getActionPointAvailable",
"produces": [
"application/json"
],
"parameters": [
{
"name": "planId",
"in": "path",
"description": "id du plan",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ActionPointWithPlans"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/datis": {
"get": {
"tags": [
"Beepiz/Datis"
],
"summary": "Liste de tous les datis li\u00e9s \u00e0 une licence",
"operationId": "getAllDatis",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
},
{
"name": "activeonly",
"in": "path",
"description": "Param\u00e8tre permettant de remonter uniquement les balises datis ayant actuellement une session active. Par d\u00e9faut ce param\u00e8tre est d\u00e9fini \u00e0 0 (toutes les balises datis li\u00e9es \u00e0 une licence, actuellement actives ou non)",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Dati"
}
},
"meta": {
"properties": {
"pagination": {
"properties": {
"total": {
"description": "Nombre total de r\u00e9sultats.",
"type": "int",
"example": 15
},
"count": {
"description": "Nombre d'\u00e9l\u00e9ments sur la page courante.",
"type": "int",
"example": 6
},
"per_page": {
"description": "Nombre d'\u00e9l\u00e9ments maximum par page.",
"type": "int",
"example": 6
},
"current_page": {
"description": "Num\u00e9ro de page courante.",
"type": "int",
"example": 2
},
"total_pages": {
"description": "Nombre total de pages",
"type": "int",
"example": 3
},
"links": {
"properties": {
"previous": {
"description": "URL de la page pr\u00e9c\u00e9dente.",
"type": "string",
"example": "https://api.suivideflotte.net/fleet/devices/?page=1"
},
"next": {
"description": "URL de la page suivante.",
"type": "string",
"example": "https://api.suivideflotte.net/fleet/devices/?page=3"
}
},
"type": "object"
}
},
"type": "object"
},
"filters": {
"properties": {
"manufacturer": {
"description": "Tableaux regroupant les diff\u00e9rents constructeurs de Datis",
"type": "array",
"items": {
"properties": {
"manufacturer": {
"type": "string"
}
},
"type": "object"
},
"example": "['samsung','autre']"
},
"mod\u00e8le": {
"description": "Tableaux regroupant les diff\u00e9rents mod\u00e8les de Datis",
"type": "array",
"items": {
"properties": {
"model": {
"type": "string"
}
},
"type": "object"
},
"example": "['Galaxy S 7','autre']"
},
"profile": {
"properties": {
"index du profil": {
"description": "Ensemble des profiles existant du client (id du profil : nom du profil)",
"type": "string",
"example": "Profil de test"
}
},
"type": "object"
},
"group": {
"properties": {
"index du groupe": {
"description": "Ensemble des groupes de balises datis existant du client (id du groupe : nom du groupe)",
"type": "string",
"example": "Groupe n\u00b04"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/datis/{datiId}": {
"get": {
"tags": [
"Beepiz/Datis"
],
"summary": "Voir un dati en particulier",
"operationId": "getOneDati",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du dati",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/DatiWithRegistration"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Beepiz/Datis"
],
"summary": "Editer un dati (nom, groupe et/ou profil)",
"operationId": "updateDati",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Champs modifiables",
"required": true,
"schema": {
"properties": {
"name": {
"description": "Nouveau nom du Dati",
"type": "string",
"example": "Dati n\u00b02"
},
"groupId": {
"description": "Identifiant du groupe auquel li\u00e9 le Dati",
"type": "integer",
"example": 2
},
"profileId": {
"description": "Identifiant du profil de configuration auquel li\u00e9 le Dati",
"type": "integer",
"example": 2
}
}
}
},
{
"name": "id",
"in": "path",
"description": "id du dati",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/registrations/{hash?}": {
"post": {
"tags": [
"Beepiz/Licences"
],
"summary": "Invitation ou r\u00e9invitation d'enregistrement d'une licence pour un Dati",
"operationId": "cancelRegistration",
"parameters": [
{
"name": "hash",
"in": "path",
"description": "hash de la licence lors d'une relance d'invitation qui a pr\u00e9c\u00e9demment expir\u00e9e",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"properties": {
"datiId": {
"description": "Identifiant du dati \u00e0 inviter",
"type": "integer",
"example": 1
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/registrations": {
"get": {
"tags": [
"Beepiz/Licences"
],
"summary": "Liste de toutes les licences associ\u00e9es ou non \u00e0 un dati",
"operationId": "getAllDatis",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/DatiWithRegistration"
}
},
"meta": {
"properties": {
"pagination": {
"properties": {
"total": {
"description": "Nombre total de r\u00e9sultats.",
"type": "int",
"example": 15
},
"count": {
"description": "Nombre d'\u00e9l\u00e9ments sur la page courante.",
"type": "int",
"example": 6
},
"per_page": {
"description": "Nombre d'\u00e9l\u00e9ments maximum par page.",
"type": "int",
"example": 6
},
"current_page": {
"description": "Num\u00e9ro de page courante.",
"type": "int",
"example": 2
},
"total_pages": {
"description": "Nombre total de pages",
"type": "int",
"example": 3
},
"links": {
"properties": {
"previous": {
"description": "URL de la page pr\u00e9c\u00e9dente.",
"type": "string",
"example": "https://api.suivideflotte.net/fleet/devices/?page=1"
},
"next": {
"description": "URL de la page suivante.",
"type": "string",
"example": "https://api.suivideflotte.net/fleet/devices/?page=3"
}
},
"type": "object"
}
},
"type": "object"
},
"availableLicences": {
"description": "Nombre de licences disponibles.",
"type": "integer",
"example": 10
}
},
"type": "object"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/registrations/{hash}": {
"delete": {
"tags": [
"Beepiz/Licences"
],
"summary": "Annule l'invitation pour l'association d'un dati \u00e0 une licence Beepiz",
"operationId": "cancelRegistration",
"parameters": [
{
"name": "hash",
"in": "path",
"description": "hash de l'invitation",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/datis/{datiId}/registrations": {
"delete": {
"tags": [
"Beepiz/Licences"
],
"summary": "D\u00e9sassocie un Dati d'une licence Beepiz",
"operationId": "deleteRegistration",
"parameters": [
{
"name": "datiId",
"in": "path",
"description": "Identifiant du dati \u00e0 d\u00e9sassocier",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/datis/{datiId}/state": {
"get": {
"tags": [
"Beepiz/Datis"
],
"summary": "Voir l'\u00e9tat actuel d'un dati en particulier",
"operationId": "getStateOneDati",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du dati",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/State"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/events": {
"get": {
"tags": [
"Beepiz/Events"
],
"summary": "Liste de tous les \u00e9v\u00e9nements remont\u00e9s par la balise Dati",
"operationId": "getAllEvents",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
},
{
"name": "start",
"in": "path",
"description": "Date et heure du d\u00e9but de la consultation des events (par d\u00e9faut : 24 heures avant la date et l'heure actuelles)",
"type": "string"
},
{
"name": "end",
"in": "path",
"description": "Date et heure de la fin de la consultation des events (par d\u00e9faut : date et heure actuelles)",
"type": "string"
},
{
"name": "fullSession",
"in": "path",
"description": "Remonter ou pas tous les events li\u00e9s \u00e0 une session comprise entre start et end (par d\u00e9faut : 0)",
"type": "boolean"
},
{
"name": "eventCategory",
"in": "path",
"description": "Remonter les events d'un certain type.
Possibilit\u00e9 de remonter plusieurs types d'events, pour cela s\u00e9parer les diff\u00e9rents types par une virgule `,`
Exemple : `eventCategory=1,2` (Pour remonter les events de type alerte et/ou session)
`1 ou info_alert` les \u00e9v\u00e9nements de type `alerte`
`2 ou info_session` les \u00e9v\u00e9nements de type `session`
`3 ou info_surveillance` les \u00e9v\u00e9nements de type `surveillance`
`4 ou info_position` les \u00e9v\u00e9nements de type `position`
`5 ou info_ap` les \u00e9v\u00e9nements de type `action points`
`9 ou info_phone` les \u00e9v\u00e9nements de type `t\u00e9l\u00e9phone`",
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Events"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/groups": {
"get": {
"tags": [
"Beepiz/Groups"
],
"summary": "Liste de tous les groupes",
"operationId": "getAllGroups",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Group_beepiz"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Beepiz/Groups"
],
"summary": "Cr\u00e9er un groupe",
"operationId": "createGroup",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Mod\u00e8le group modifi\u00e9",
"required": true,
"schema": {
"properties": {
"name": {
"description": "nom du groupe",
"type": "string",
"example": "Groupe R\u00e9gion Ile de France"
},
"datis": {
"description": "tableau des id des datis \u00e0 rattacher au groupe",
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
}
},
"type": "object"
},
"example": "[1,2,3]"
}
}
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"202": {
"description": "partial success operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/groups/{groupId}": {
"get": {
"tags": [
"Beepiz/Groups"
],
"summary": "D\u00e9tails d'un groupe",
"operationId": "getOneGroup",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "id du groupe",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Group_beepiz"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Beepiz/Groups"
],
"summary": "Modifier un groupe",
"operationId": "updateGroup",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "id du groupe",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "Mod\u00e8le group modifi\u00e9",
"required": true,
"schema": {
"properties": {
"name": {
"description": "nom du groupe",
"type": "string",
"example": "Groupe R\u00e9gion Ile de France"
},
"datis": {
"description": "tableau des id des datis \u00e0 rattacher au groupe",
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
}
},
"type": "object"
},
"example": "[1,2,3]"
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"202": {
"description": "partial success operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Beepiz/Groups"
],
"summary": "Supprimer un groupe",
"operationId": "deleteGroup",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "id du groupe",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/identifications": {
"get": {
"tags": [
"Beepiz/Identifications"
],
"summary": "Liste de toutes les cartes d'identifications",
"operationId": "getAllIdentifications",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Identification"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Beepiz/Identifications"
],
"summary": "Cr\u00e9er une carte d'identification",
"operationId": "createIdentification",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model Identification n\u00e9cessaire \u00e0 la cr\u00e9ation d'une carte d'identification",
"required": true,
"schema": {
"$ref": "#/definitions/Identification"
}
}
],
"responses": {
"201": {
"description": "created"
},
"202": {
"description": "created without picture"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": [
""
]
}
]
}
},
"/beepiz/identifications/{id}": {
"get": {
"tags": [
"Beepiz/Identifications"
],
"summary": "Voir une carte d'identification",
"description": "Voir une identification selon son id",
"operationId": "getIdentificationById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de l'identification",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Identification"
}
},
"403": {
"description": "Forbidden request"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Beepiz/Identifications"
],
"summary": "Modifier une carte d'identification",
"operationId": "createIdentification",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model Identification n\u00e9cessaire \u00e0 la cr\u00e9ation d'une carte d'identification",
"required": true,
"schema": {
"$ref": "#/definitions/Identification"
}
},
{
"name": "id",
"in": "path",
"description": "id de la carte d'identification",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"202": {
"description": "updated without picture"
},
"401": {
"description": "error authentication"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": [
""
]
}
]
},
"delete": {
"tags": [
"Beepiz/Identifications"
],
"summary": "Supprimer une carte d'identification",
"operationId": "deleteIdentification",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de l'identification",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"404": {
"description": "not found"
}
},
"security": [
{
"oauth2": [
""
]
}
]
}
},
"/beepiz/phonebooks/{phonebookId}/contacts": {
"get": {
"tags": [
"Beepiz/Contacts"
],
"summary": "Liste de tous les contacts d'un phonebook",
"operationId": "getAllContactsFromPhonebook",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du phonebook",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Contacts"
}
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Beepiz/Contacts"
],
"summary": "Ajouter un ou des contacts \u00e0 un phonebook",
"operationId": "createContactsToPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du phonebook",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "Tableau d'objet contact",
"required": true,
"schema": {
"type": "array",
"items": {
"properties": {
"name": {
"description": "Nom du contact",
"type": "string",
"example": "John Doe"
},
"phone": {
"description": "T\u00e9l\u00e9phone du contact",
"type": "string",
"maxLength": 10,
"minLength": 2,
"example": "0202020202"
}
},
"type": "object"
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Contacts"
}
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/phonebooks/{phonebookId}/contacts/{contactId}": {
"get": {
"tags": [
"Beepiz/Contacts"
],
"summary": "Un contact particulier d'un phonebook",
"operationId": "getContactFromPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du phonebook",
"required": true,
"type": "integer"
},
{
"name": "contactId",
"in": "path",
"description": "Identifiant du contact",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Contacts"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Beepiz/Contacts"
],
"summary": "Modifier le contact d'un phonebook",
"operationId": "createContactsToPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du phonebook",
"required": true,
"type": "integer"
},
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du contact",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "Tableau d'objet contact",
"required": true,
"schema": {
"type": "array",
"items": {
"properties": {
"name": {
"description": "Nom du contact",
"type": "string",
"example": "John Doe"
},
"phone": {
"description": "T\u00e9l\u00e9phone du contact",
"type": "string",
"maxLength": 10,
"minLength": 2,
"example": "0202020202"
}
},
"type": "object"
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Beepiz/Contacts"
],
"summary": "Supprimer un contact d'un phonebook",
"operationId": "deleteContactToPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "id du phonebook dans lequel est le contact \u00e0 supprimer",
"required": true,
"type": "integer"
},
{
"name": "contactId",
"in": "path",
"description": "id du contact \u00e0 supprimer",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/beepiz/phonebooks/{phonebookId}/contacts/order": {
"put": {
"tags": [
"Beepiz/Contacts"
],
"summary": "Modifier l'ordre des contacts dans un phonebook",
"operationId": "deleteContactToPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "id du phonebook dans lequel est le contact \u00e0 supprimer",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "Tableau ordonn\u00e9 des ids des contacts",
"required": true,
"schema": {
"type": "array",
"items": {
"description": "id des contacts du phonebook",
"type": "integer"
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
}
]
}
},
"/beepiz/phonebooks": {
"get": {
"tags": [
"Beepiz/Phonebooks"
],
"summary": "Liste de tous les phonebooks",
"operationId": "getAllPhonebook",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Phonebooks"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Beepiz/Phonebooks"
],
"summary": "Modifier un phonebook",
"operationId": "editPhonebook",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Nom du phonebook",
"required": true,
"schema": {
"properties": {
"name": {
"description": "Nom du phonebook",
"type": "string",
"example": "Annuaire n\u00b02"
}
}
},
"type": "object"
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/phonebooks/{phonebookId}": {
"get": {
"tags": [
"Beepiz/Phonebooks"
],
"summary": "d\u00e9tails d'un phonebook",
"operationId": "getPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du phonebook",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PhonebookWithContacts"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Beepiz/Phonebooks"
],
"summary": "Modifier un phonebook",
"operationId": "editPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du phonebook",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "Identifiant du phonebook",
"required": true,
"schema": {
"properties": {
"name": {
"description": "Nom modifi\u00e9 du phonebook",
"type": "string",
"example": "name updated"
}
}
},
"type": "object"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PhonebookWithContacts"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Beepiz/Phonebooks"
],
"summary": "Supprimer un phonebook",
"description": "Pr\u00e9cisions :
`Si le phonebook est li\u00e9 \u00e0 un profil de configuration sa suppression sera rejet\u00e9e.`
`En cas de suppression, tous les contacts li\u00e9s au phonebook seront \u00e9galement supprim\u00e9s.`",
"operationId": "getPhonebook",
"parameters": [
{
"name": "phonebookId",
"in": "path",
"description": "Identifiant du phonebook",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/plans": {
"get": {
"tags": [
"Beepiz/PlanEntities"
],
"summary": "R\u00e9cup\u00e9rer l'arborescence de tous les plans",
"description": "R\u00e9cup\u00e9ration de l'arborescence des plans. Elle peut avoir jusqu'\u00e0 7 niveaux de profondeurs : Root (Plan abstrait unique \u00e0 chaque client) > Site > Secteur > B\u00e2timent > Etage > Service > Plan",
"operationId": "getAllPlans",
"parameters": [
{
"$ref": "#/parameters/fields"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/PlanEntityWithChildren"
}
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "Page X does not exist (last page is Y)."
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Beepiz/PlanEntities"
],
"summary": "Cr\u00e9er un plan dans une arborescence",
"operationId": "createPlan",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model PlanEntity n\u00e9cessaire \u00e0 la cr\u00e9ation d'un plan dans votre arborescence de lieu(x)",
"required": true,
"schema": {
"$ref": "#/definitions/PlanEntityWithPlan"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"202": {
"description": "planEntity created but picture does not be attached"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": [
""
]
}
]
}
},
"/beepiz/plans/{id}": {
"get": {
"tags": [
"Beepiz/PlanEntities"
],
"summary": "Voir un plan",
"description": "Voir un Plan selon son id",
"operationId": "getPlanEntityById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du plan",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PlanEntity"
}
},
"400": {
"description": "Invalid ID supplied"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Beepiz/PlanEntities"
],
"summary": "Modifier un plan (sans notion d'arborescence)",
"description": "Seul le nom d'un plan est modifiable via cette route.",
"operationId": "updatePlan",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maximum": "64",
"example": "Nom du plan"
}
},
"type": "object"
}
},
{
"name": "id",
"in": "path",
"description": "id du Plan",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Beepiz/PlanEntities"
],
"summary": "Supprimer un Plan",
"operationId": "deletePlan",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du Plan",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/plans/{id}/treeposition": {
"put": {
"tags": [
"Beepiz/PlanEntities"
],
"summary": "Modifier un plan (notion d'arborescence)",
"operationId": "updatePlantree",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Un Plan Entity ne peut \u00eatre d\u00e9plac\u00e9 que dans un m\u00eame niveau (m\u00eame parentId).",
"required": true,
"schema": {
"required": [
"brotherOder"
],
"properties": {
"brotherOder": {
"type": "string",
"example": "1,5,10,12"
}
},
"type": "object"
}
},
{
"name": "id",
"in": "path",
"description": "id du Plan",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/plans/{planId}/actionpoints/{actionpointId}": {
"post": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Associer un Action Point \u00e0 un Plan.",
"operationId": "AttachApToPlan",
"parameters": [
{
"name": "planId",
"in": "path",
"description": "id du Plan",
"required": true,
"type": "integer"
},
{
"name": "actionpointId",
"in": "path",
"description": "id de l'Action Point",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "",
"required": true,
"schema": {
"properties": {
"x": {
"description": "coordonn\u00e9es x",
"type": "number",
"example": 0.3
},
"y": {
"description": "coordonn\u00e9es y",
"type": "number",
"example": -0.2
},
"polygon": {
"description": "N\u00e9cessaire si l'Action Point \u00e0 lier au Plan est de type Zone : coordonn\u00e9es du polygone",
"type": "array",
"items": {
"properties": {
"point": {
"type": "string"
}
},
"type": "object"
},
"example": "[[[0.2,-0.3],[0.4,0.05],[0.3,-0.2]]]"
},
"parentId": {
"description": "N\u00e9cessaire pour l'ajout d'un Action Point au sein d'un AP de type Zone ou Groupe d\u00e9j\u00e0 li\u00e9 au plan : Id de l'AP parent",
"type": "integer",
"example": 12
}
}
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "nprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/plans/{planId}/actionpoints/{actionpointId}/location": {
"put": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Repositionner un Action Point sur un Plan.",
"operationId": "MoveApOnPlan",
"parameters": [
{
"name": "planId",
"in": "path",
"description": "id du Plan",
"required": true,
"type": "integer"
},
{
"name": "actionpointId",
"in": "path",
"description": "id de l'Action Point",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "",
"required": true,
"schema": {
"properties": {
"x": {
"description": "coordonn\u00e9es x",
"type": "number",
"example": 0.3
},
"y": {
"description": "coordonn\u00e9es y",
"type": "number",
"example": -0.2
},
"polygon": {
"description": "coordonn\u00e9es du polygone",
"type": "array",
"items": {
"properties": {
"point": {
"type": "string"
}
},
"type": "object"
},
"example": "[[[0.2,-0.3],[0.4,0.05],[0.3,-0.2]]]"
}
}
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "nprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Permet de d\u00e9sassocier un Action Point d'un Plan",
"operationId": "detachApToPlan",
"parameters": [
{
"name": "planId",
"in": "path",
"description": "id du Plan",
"required": true,
"type": "integer"
},
{
"name": "actionpointId",
"in": "path",
"description": "id de l'Action Point",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/plans/{planId}/actionpoints/{actionpointId}/treeposition": {
"put": {
"tags": [
"Beepiz/ActionPoints"
],
"summary": "Modifier l'arborescence des Action Points.",
"operationId": "MoveApOnTree",
"parameters": [
{
"name": "planId",
"in": "path",
"description": "id du Plan",
"required": true,
"type": "integer"
},
{
"name": "actionpointId",
"in": "path",
"description": "id de l'Action Point",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "",
"required": true,
"schema": {
"properties": {
"after": {
"description": "Id de l'Action Point sous lequel doit \u00eatre plac\u00e9 l'Action Point sp\u00e9cifi\u00e9. Si after = 0, l'Action Point se retrouve en haut de l'arborescence.",
"type": "number",
"example": 0
},
"parentId": {
"description": "Repr\u00e9sente l'AP de type Groupe ou Zone dans lequel l'Action Point doit \u00eatre positionn\u00e9. Si le parentId n'est pas sp\u00e9cifi\u00e9, cela signifie qu'il n'est pas rattach\u00e9 \u00e0 un Action Point de type Groupe ou Zone.",
"type": "number",
"example": 11
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "nprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/profiles": {
"get": {
"tags": [
"Beepiz/Profiles"
],
"summary": "Liste de tous les Profils de configuration existants",
"operationId": "getAllProfiles",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/ShortProfileIndex"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Beepiz/Profiles"
],
"summary": "Configuration compl\u00e8te d'un profil",
"description": "Le comportement de cette route diff\u00e8re selon les param\u00e8tres renseign\u00e9s dans le body.
`meta` + `config` = Cr\u00e9ation d'un nouveau profil de configuration
`meta` + `config` + `datis` = Cr\u00e9ation d'un nouveau profil de configuration avec association au(x) Dati(s) sp\u00e9cifi\u00e9(s)
`profileId` + `meta` = Update des meta du profile (profileId)
`profileId` + `meta` + `datis` = Update des meta du profile (profileId) avec association au(x) Dati(s) sp\u00e9cifi\u00e9(s)
`profileId` + `datis` = Association de Dati(s) \u00e0 un profil (profileId) d\u00e9j\u00e0 existant
`profileId` + `config` = On supprime le profil d'origine (profileId) et on en cr\u00e9\u00e9 un nouveau avec les m\u00eames m\u00e9tas du profil d'origine (profileId) et les m\u00eames associations de datis
`profileId` + `meta` + `config` = On supprime le profil d'origine (profileId) et on en cr\u00e9\u00e9 un nouveau avec nouveau m\u00e9ta, avec les m\u00eames associations de datis que celle de profileId
`profileId` + `config` + `datis` = On supprime le profil d'origine (profileId) et on en cr\u00e9\u00e9 un nouveau avec les m\u00eames m\u00e9tas du profil d'origine (profileId), les m\u00eames associations de datis et les nouvelles associations sp\u00e9cifi\u00e9es (datis)
`profileId` + `meta` + `config` +`datis` = On supprime le profil d'origine (profileId) et on en cr\u00e9\u00e9 un nouveau avec nouveau m\u00e9ta, avec les m\u00eames associations de datis que celle de profileId et les nouvelles sp\u00e9cifi\u00e9es (datis)",
"operationId": "storeOrUpdateProfile",
"parameters": [
{
"name": "profileId",
"in": "body",
"description": "Identifiant du profil",
"schema": {
"properties": {
"profileId": {
"description": "Identifiant du profil",
"type": "integer",
"example": 1
},
"meta": {
"type": "object",
"$ref": "#/definitions/ShortProfile"
},
"datis": {
"description": "Les identifiants des Dati \u00e0 associer au profil",
"type": "array",
"items": {
"properties": {
"id": {
"type": "string"
}
},
"type": "object"
},
"example": "[1,2,3]"
},
"config": {
"properties": {
"aggression.alert.flash": {
"description": "",
"type": "boolean",
"example": ""
},
"aggression.alert.photo": {
"description": "",
"type": "boolean",
"example": ""
},
"aggression.alert.sound": {
"description": "",
"type": "boolean",
"example": ""
},
"aggression.alert.vibrator": {
"description": "",
"type": "boolean",
"example": ""
},
"aggression.delay": {
"description": "",
"type": "integer",
"example": ""
},
"aggression.on": {
"description": "",
"type": "boolean",
"example": ""
},
"allow_monitoring_inhibition": {
"description": "",
"type": "boolean",
"example": ""
},
"auto_offhook": {
"description": "",
"type": "boolean",
"example": ""
},
"battery": {
"description": "",
"type": "integer",
"example": ""
},
"bt": {
"description": "",
"type": "boolean",
"example": ""
},
"dedicated_device": {
"description": "",
"type": "boolean",
"example": ""
},
"email": {
"description": "",
"type": "string",
"example": ""
},
"fall.alert.flash": {
"description": "",
"type": "boolean",
"example": ""
},
"fall.alert.photo": {
"description": "",
"type": "boolean",
"example": ""
},
"fall.alert.sound": {
"description": "",
"type": "boolean",
"example": ""
},
"fall.alert.vibrator": {
"description": "",
"type": "boolean",
"example": ""
},
"fall.delay": {
"description": "",
"type": "integer",
"example": ""
},
"fall.duration": {
"description": "",
"type": "integer",
"example": ""
},
"fall.on": {
"description": "",
"type": "boolean",
"example": ""
},
"gps": {
"description": "",
"type": "boolean",
"example": ""
},
"immo.alert.flash": {
"description": "",
"type": "boolean",
"example": ""
},
"immo.alert.photo": {
"description": "",
"type": "boolean",
"example": ""
},
"immo.alert.sound": {
"description": "",
"type": "boolean",
"example": ""
},
"immo.alert.vibrator": {
"description": "",
"type": "boolean",
"example": ""
},
"immo.delay": {
"description": "",
"type": "integer",
"example": ""
},
"immo.duration": {
"description": "",
"type": "integer",
"example": ""
},
"immo.on": {
"description": "",
"type": "boolean",
"example": ""
},
"immo.tolerance": {
"description": "",
"type": "float",
"example": ""
},
"lostcom": {
"description": "",
"type": "integer",
"example": ""
},
"mode": {
"description": "",
"type": "integer",
"example": ""
},
"nfc": {
"description": "",
"type": "boolean",
"example": ""
},
"phone": {
"description": "",
"type": "boolean",
"example": ""
},
"phonebook_id": {
"description": "",
"type": "integer",
"example": ""
},
"sms": {
"description": "",
"type": "string",
"example": ""
},
"sos.alert.flash": {
"description": "",
"type": "boolean",
"example": ""
},
"sos.alert.photo": {
"description": "",
"type": "boolean",
"example": ""
},
"sos.alert.sound": {
"description": "",
"type": "boolean",
"example": ""
},
"sos.alert.vibrator": {
"description": "",
"type": "boolean",
"example": ""
},
"sos.delay": {
"description": "",
"type": "integer",
"example": ""
},
"sos.on": {
"description": "",
"type": "boolean",
"example": ""
},
"telesurveilleur": {
"description": "",
"type": "boolean",
"example": ""
},
"verticality.alert.flash": {
"description": "",
"type": "boolean",
"example": ""
},
"verticality.alert.photo": {
"description": "",
"type": "boolean",
"example": ""
},
"verticality.alert.sound": {
"description": "",
"type": "boolean",
"example": ""
},
"verticality.alert.vibrator": {
"description": "",
"type": "boolean",
"example": ""
},
"verticality.delay": {
"description": "",
"type": "integer",
"example": ""
},
"verticality.duration": {
"description": "",
"type": "integer",
"example": ""
},
"verticality.flip": {
"description": "",
"type": "integer",
"example": ""
},
"verticality.initpos": {
"description": "",
"type": "integer",
"example": ""
},
"verticality.on": {
"description": "",
"type": "boolean",
"example": ""
},
"vocal": {
"description": "",
"type": "boolean",
"example": ""
},
"wifi": {
"description": "",
"type": "boolean",
"example": ""
}
},
"type": "object"
}
}
},
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ProfileWithProfileItems"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/beepiz/profiles/{profileId}": {
"get": {
"tags": [
"Beepiz/Profiles"
],
"summary": "D\u00e9tails de configuration d'un profil",
"operationId": "getDetailsProfile",
"parameters": [
{
"name": "profileId",
"in": "path",
"description": "Identifiant du profil",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/ProfileWithProfileItems"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "not found"
},
"422": {
"description": "unprocessable entity"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices/{deviceId}/maintenances/{date}": {
"get": {
"tags": [
"Fleet/Devices"
],
"summary": "Liste les alertes entretiens qui se sont d\u00e9clench\u00e9es.",
"description": "Liste les alertes entretiens qui se sont d\u00e9clench\u00e9es \u00e0 la date sp\u00e9cifi\u00e9e.",
"operationId": "getAllMaintenanceTriggeredByDevice",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du v\u00e9hicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "date",
"in": "path",
"description": "Date de d\u00e9clenchement",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "id de l'alerte",
"type": "integer",
"example": 1
},
"name": {
"description": "nom de l'alerte",
"type": "string",
"example": "Vidange"
},
"when": {
"description": "date de d\u00e9clenchement de l'alerte",
"type": "string",
"example": "2017-04-24 12:45:14"
},
"comment": {
"description": "Message envoy\u00e9 lors du d\u00e9clenchement de l'alerte",
"type": "string",
"example": "Kilom\u00e9trage atteint"
},
"device": {
"properties": {
"id": {
"description": "Libelle du v\u00e9hicule",
"type": "integer",
"example": 123
},
"name": {
"description": "Libelle du v\u00e9hicule",
"type": "string",
"example": "Jean-Paul Dumont"
},
"regPlate": {
"description": "Immatriculation du v\u00e9hicule",
"type": "integer",
"example": "AA-152-BB"
},
"icon": {
"description": "type du v\u00e9hicule",
"type": "integer",
"example": 3
}
},
"type": "object"
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/maintenances/{date}": {
"get": {
"tags": [
"Fleet/Maintenances"
],
"summary": "Liste les alertes entretiens qui se sont d\u00e9clench\u00e9es.",
"description": "Liste les alertes entretiens qui se sont d\u00e9clench\u00e9es \u00e0 la date sp\u00e9cifi\u00e9e.",
"operationId": "getAllMaintenanceTriggeredByDate",
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date de d\u00e9clenchement",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "id de l'alerte",
"type": "integer",
"example": 1
},
"name": {
"description": "nom de l'alerte",
"type": "string",
"example": "Vidange"
},
"when": {
"description": "date de d\u00e9clenchement de l'alerte",
"type": "string",
"example": "2017-04-24 12:45:14"
},
"comment": {
"description": "Message envoy\u00e9 lors du d\u00e9clenchement de l'alerte",
"type": "string",
"example": "Kilom\u00e9trage atteint"
},
"device": {
"properties": {
"id": {
"description": "Libelle du v\u00e9hicule",
"type": "integer",
"example": 123
},
"name": {
"description": "Libelle du v\u00e9hicule",
"type": "string",
"example": "Jean-Paul Dumont"
},
"regPlate": {
"description": "Immatriculation du v\u00e9hicule",
"type": "integer",
"example": "AA-152-BB"
},
"icon": {
"description": "type du v\u00e9hicule",
"type": "integer",
"example": 3
}
},
"type": "object"
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices/{deviceId}/movements/{date}": {
"get": {
"tags": [
"Fleet/Devices"
],
"summary": "Liste les alertes de mouvements qui se sont d\u00e9clench\u00e9es.",
"description": "Liste les alertes de mouvements qui se sont d\u00e9clench\u00e9es \u00e0 la date sp\u00e9cifi\u00e9e.",
"operationId": "getAllMovementsTriggeredByDevice",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du v\u00e9hicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "date",
"in": "path",
"description": "Date de d\u00e9clenchement",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "id de l'alerte",
"type": "integer",
"example": 1
},
"name": {
"description": "nom de l'alerte",
"type": "string",
"example": "D\u00e9placement du week-end"
},
"when": {
"description": "date de d\u00e9clenchement de l'alerte",
"type": "string",
"example": "2017-04-24 12:45:14"
},
"comment": {
"description": "Message envoy\u00e9 lors du d\u00e9clenchement de l'alerte",
"type": "string",
"example": "D\u00e9marrage a 12h45"
},
"device": {
"properties": {
"id": {
"description": "Libelle du v\u00e9hicule",
"type": "integer",
"example": 123
},
"name": {
"description": "Libelle du v\u00e9hicule",
"type": "string",
"example": "Jean-Paul Dumont"
},
"regPlate": {
"description": "Immatriculation du v\u00e9hicule",
"type": "integer",
"example": "AA-152-BB"
},
"icon": {
"description": "type du v\u00e9hicule",
"type": "integer",
"example": 3
}
},
"type": "object"
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/movements/{date}": {
"get": {
"tags": [
"Fleet/Movements"
],
"summary": "Liste les alertes de mouvements qui se sont d\u00e9clench\u00e9es.",
"description": "Liste les alertes de mouvements qui se sont d\u00e9clench\u00e9es \u00e0 la date sp\u00e9cifi\u00e9e.",
"operationId": "getAllMovementsTriggeredByDate",
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date de d\u00e9clenchement",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "id de l'alerte",
"type": "integer",
"example": 1
},
"name": {
"description": "nom de l'alerte",
"type": "string",
"example": "D\u00e9placement du week-end"
},
"when": {
"description": "nom de l'alerte",
"type": "string",
"example": "2017-04-24 12:45:14"
},
"comment": {
"description": "Message envoy\u00e9 lors du d\u00e9clenchement de l'alerte",
"type": "string",
"example": "D\u00e9marrage a 17h45"
},
"device": {
"properties": {
"id": {
"description": "Libelle du v\u00e9hicule",
"type": "integer",
"example": 123
},
"name": {
"description": "Libelle du v\u00e9hicule",
"type": "string",
"example": "Jean-Paul Dumont"
},
"regPlate": {
"description": "Immatriculation du v\u00e9hicule",
"type": "integer",
"example": "AA-152-BB"
},
"icon": {
"description": "type du v\u00e9hicule",
"type": "integer",
"example": 3
}
},
"type": "object"
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/badges": {
"get": {
"tags": [
"Fleet/Badges"
],
"summary": "Liste des badges du client",
"description": "Retourne la liste des badges associ\u00e9 \u00e0 votre compte client.",
"operationId": "getBadges",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Badges"
}
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Fleet/Badges"
],
"summary": "Ajout d'un badge sp\u00e9cifique",
"description": "Ajout d'un badge sp\u00e9cifique.",
"operationId": "addBadges",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model Badge",
"required": true,
"schema": {
"$ref": "#/definitions/Badges"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"503": {
"description": "Le badge existe d\u00e9j\u00e0"
},
"500": {
"description": "Erreur interne"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/badges/{id}": {
"get": {
"tags": [
"Fleet/Badges"
],
"summary": "R\u00e9cup\u00e9ration d'un badge sp\u00e9cifique",
"description": "Retourne un badge sp\u00e9cifique.",
"operationId": "getBadgesId",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Badges"
}
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Fleet/Badges"
],
"summary": "Modification d'un badge sp\u00e9cifique",
"description": "Modification d'un badge sp\u00e9cifique.",
"operationId": "editBadgesId",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id du badge",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model Badge",
"required": true,
"schema": {
"$ref": "#/definitions/Badges"
}
}
],
"responses": {
"204": {
"description": "successful operation"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Erreur interne"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Fleet/Badges"
],
"summary": "Supprime un badge sp\u00e9cifique",
"description": "Supprime un badge sp\u00e9cifique.",
"operationId": "deleteBadgesId",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"204": {
"description": "successful operation"
},
"404": {
"description": "Not found"
},
"503": {
"description": "Le badge est rattach\u00e9 a un collaborateur"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices": {
"get": {
"tags": [
"Fleet/Devices"
],
"summary": "Liste tous les v\u00e9hicules g\u00e9olocalis\u00e9s",
"description": "Liste (pagin\u00e9e) de tous les v\u00e9hicules g\u00e9olocalis\u00e9s.",
"operationId": "getAllDevices",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Device"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices/{id}": {
"get": {
"tags": [
"Fleet/Devices"
],
"summary": "V\u00e9hicules sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es pour un v\u00e9hicule sp\u00e9cifique",
"operationId": "getDevice",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Device"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
},
{
"driverOauth2": []
}
]
},
"put": {
"tags": [
"Fleet/Devices"
],
"summary": "Modification d'un v\u00e9hicule",
"description": "Permet de renommer un v\u00e9hicule ou de le d\u00e9placer dans un autre groupe.",
"operationId": "DeviceRename",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du v\u00e9hicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Seuls le nom et le groupe du v\u00e9hicule sont modifiables.",
"required": true,
"schema": {
"required": [
"name",
"groupId"
],
"properties": {
"name": {
"type": "string",
"maximum": "30",
"example": "Nom du vehicule"
},
"groupId": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices/{id}/private": {
"put": {
"tags": [
"Fleet/Devices"
],
"summary": "Active ou d\u00e9sactive le mode Vie Priv\u00e9",
"operationId": "activePrivacyMode",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du v\u00e9hicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Information d'activation du priv\u00e9 ex: {'at':'2017-06-06 09:00:00','state':true}",
"required": true,
"schema": {
"required": [
"state",
"at"
],
"properties": {
"at": {
"type": "datetime",
"example": "2017-06-06 17:00:00"
},
"state": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
},
{
"driverOauth2": []
}
]
}
},
"/fleet/devices/{id}/software": {
"post": {
"tags": [
"Fleet/Devices/Software"
],
"summary": "Simule la position d'un v\u00e9hicule ou d'une balise",
"operationId": "simulatePosition",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du v\u00e9hicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model PositionGPS n\u00e9cessaire \u00e0 la simulation",
"required": true,
"schema": {
"$ref": "#/definitions/GPSPosition"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices/{id}/sensors": {
"get": {
"tags": [
"Fleet/Devices"
],
"summary": "Liste des capteurs d'un v\u00e9hicule sp\u00e9cifique",
"description": "Retourne la liste des capteurs pour un v\u00e9hicule sp\u00e9cifique",
"operationId": "getDeviceSensors",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Sensor"
}
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices/{deviceId}/sensors/{sensorId}/software": {
"post": {
"tags": [
"Fleet/Devices/Software"
],
"summary": "Simule une information de capteur.",
"operationId": "simulateSensorPosition",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du v\u00e9hicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "sensorId",
"in": "path",
"description": "Identifiant du capteur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model PositionGPS n\u00e9cessaire \u00e0 la simulation",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/definitions/GPSPosition"
},
{
"properties": {
"type": {
"description": "1=d\u00e9but 0=fin sur les capteurs de type p\u00e9riode. Optionnel si le capteur est de type impulsion.",
"type": "numeric",
"example": 0
},
"value": {
"description": "Optionnel si le capteur n'attend pas de valeur",
"type": "string",
"example": "12"
}
}
}
]
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/devices/{deviceId}/trips/{tripId}/private": {
"put": {
"tags": [
"Fleet/Devices"
],
"summary": "Passe un trajet en mode priv\u00e9e",
"operationId": "tripToPrivate",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du v\u00e9hicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "tripId",
"in": "path",
"description": "Identifiant du trajet (exemple: 17_46_12312)",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/groups": {
"get": {
"tags": [
"Fleet/Groups"
],
"summary": "Liste tous les groupes de v\u00e9hicule g\u00e9olocalis\u00e9s",
"description": "Liste (pagin\u00e9e) de tous les groupes de v\u00e9hicules g\u00e9olocalis\u00e9s.",
"operationId": "getAllGroups",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"description": "?cars=1",
"type": "array",
"items": {
"$ref": "#/definitions/GroupReadOnly"
}
},
"meta": {
"description": "?cars=1",
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Fleet/Groups"
],
"summary": "Cr\u00e9er un groupe de v\u00e9hicule",
"operationId": "createGroup",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model Groupe n\u00e9cessaire \u00e0 la cr\u00e9ation d'un groupe",
"required": true,
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maximum": "60",
"example": "Nom du groupe"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/groups/{id}": {
"get": {
"tags": [
"Fleet/Groups"
],
"summary": "Voir un groupe",
"operationId": "getGroupsById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du groupe",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GroupReadOnly"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Fleet/Groups"
],
"summary": "Modifier un groupe",
"operationId": "updateGroup",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du groupe",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "Seul le nom du groupe est modifiable.",
"required": true,
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maximum": "60",
"example": "Nouveau nom du groupe"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Fleet/Groups"
],
"summary": "Supprimer un groupe",
"operationId": "deleteGroup",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du groupe",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/pois/categories": {
"get": {
"tags": [
"Fleet/POIs"
],
"summary": "Liste toutes les Categories de POI",
"description": "Liste (pagin\u00e9e) des categories de POI ",
"operationId": "getAllPOICategory",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/PoiCategory"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
},
{
"driverOauth2": []
}
]
}
},
"/fleet/pois": {
"get": {
"tags": [
"Fleet/POIs"
],
"summary": "Liste tous les POIs",
"description": "Liste (pagin\u00e9e) de tous les POI de la categorie sp\u00e9cifi\u00e9e.",
"operationId": "getAllPOI",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Poi"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
},
{
"driverOauth2": []
}
]
},
"post": {
"tags": [
"Fleet/POIs"
],
"summary": "Cr\u00e9er un POI",
"operationId": "createPoi",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Cr\u00e9\u00e9 un nouveau point d'int\u00e9r\u00eat. Exemple de passage des param\u00e8tres : `{'name':'testSelim2', 'radius':0.5, 'category.id':6, 'where.point.lng':0.69835, 'where.point.lat':47.15545}`.",
"required": true,
"schema": {
"$ref": "#/definitions/PoiEditable"
}
}
],
"responses": {
"201": {
"description": "created"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"422": {
"description": "Unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
},
{
"driverOauth2": []
}
]
}
},
"/fleet/pois/categories/{categoryId}": {
"get": {
"tags": [
"Fleet/POIs"
],
"summary": "Liste tous les POIs d'une cat\u00e9gorie",
"description": "Liste (pagin\u00e9e) de tous les POI de la categorie sp\u00e9cifi\u00e9e.",
"operationId": "getAllPOIByCategory",
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "",
"required": true,
"type": "integer"
},
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Poi"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
},
{
"driverOauth2": []
}
]
}
},
"/fleet/pois/{id}": {
"get": {
"tags": [
"Fleet/POIs"
],
"summary": "POI sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es pour un POI sp\u00e9cifique",
"operationId": "getPoi",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Poi"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
},
{
"driverOauth2": []
}
]
},
"put": {
"tags": [
"Fleet/POIs"
],
"summary": "Modifier un Point d'int\u00e9r\u00eat",
"operationId": "updatePoi",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du Poi",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model Poi.",
"required": true,
"schema": {
"$ref": "#/definitions/PoiEditable"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable entity"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Fleet/POIs"
],
"summary": "Supprime un POI",
"description": "Supprime un POI sp\u00e9cifique",
"operationId": "deletePoi",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/reports/daily/{deviceId}/{date}": {
"get": {
"tags": [
"Fleet/Reports"
],
"summary": "Rapport journalier",
"description": "Retourne le d\u00e9tail des d\u00e9placements d'un v\u00e9hicule pour une date donn\u00e9e. Consultable pour un v\u00e9hicule et une seule journ\u00e9e.",
"operationId": "getDailyReport",
"produces": [
"application/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du Device : `999`",
"required": true,
"type": "string"
},
{
"name": "date",
"in": "path",
"description": "Date du rapport \u00e0 visualiser ex: `2017-06-26`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/Trip"
}
}
},
"401": {
"description": "error authentication"
},
"422": {
"description": "Invalid Parameter"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"driverOauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/reports/daily-balise/{deviceId}/{date}": {
"get": {
"tags": [
"Fleet/Reports"
],
"summary": "Rapport journalier pour les balises",
"description": "Retourne le d\u00e9tail des d\u00e9placements d'une balise pour une date donn\u00e9e. Consultable pour une balise et une seule journ\u00e9e.",
"operationId": "getDailyBaliseReport",
"produces": [
"application/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du Device : `999`",
"required": true,
"type": "string"
},
{
"name": "date",
"in": "path",
"description": "Date du rapport \u00e0 visualiser ex: `2017-06-26`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"properties": {
"tripID": {
"type": "string",
"example": "17_32_12365"
},
"step": {
"description": "Num\u00e9ro de la position",
"type": "integer"
},
"location": {
"type": "object",
"$ref": "#/definitions/Location"
},
"when": {
"type": "string",
"example": "2017-06-26 17:00:00"
},
"details": {
"description": "Eventuel commentaire sur la position.",
"type": "string"
},
"action": {
"description": "Type de position",
"type": "string",
"example": "D\u00e9but de service, alerte SOS, ..."
},
"pit": {
"description": "Information du point d'int\u00e9rieur",
"properties": {
"id": {
"description": "Identifiant du point d'int\u00e9rieur",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du point d'int\u00e9rieur",
"type": "string",
"example": "Bureau de Jean-Paul."
},
"group": {
"description": "Nom du groupe du point d'int\u00e9rieur",
"type": "string",
"example": "1er \u00e9tage"
}
}
},
"badge": {
"description": "Information sur la personne identifi\u00e9 sur la balise",
"properties": {
"id": {
"type": "integer",
"example": 10
},
"name": {
"type": "string",
"example": "Jean-Paul"
},
"icon": {
"type": "string"
}
}
}
},
"type": "object"
}
}
},
"401": {
"description": "error authentication"
},
"422": {
"description": "Invalid Parameter"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"driverOauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/reports/ecodrive-ranking/{deviceId}/{date}": {
"get": {
"tags": [
"Fleet/Reports"
],
"summary": "Classement EcoConduite",
"description": "Retourne les notes EcoConduite des v\u00e9hicules pour une p\u00e9riode. Consultable pour un ou plusieurs v\u00e9hicules, sur une p\u00e9riode d'une journ\u00e9e \u00e0 un mois.",
"operationId": "getEcoDriveRankingReport",
"produces": [
"application/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du ou des Device : `999` ou `999,14767`",
"required": true,
"type": "string"
},
{
"name": "date",
"in": "path",
"description": "P\u00e9riodes du rapport \u00e0 visualiser ex: `2017-06-26,2017-06-30` ou `2017-06-26`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"required": [
"device",
"data"
],
"properties": {
"device": {
"type": "object",
"$ref": "#/definitions/DeviceSimple"
},
"data": {
"required": [
"score",
"grade"
],
"properties": {
"score": {
"description": "Note (sur 100) repr\u00e9sentant la qualit\u00e9 de conduite \u00e9co-responsable du v\u00e9hicule. Elle peut \u00eatre `null` si il n'y eu aucun d\u00e9placement sur la p\u00e9riode.",
"type": "integer",
"example": 25
},
"grade": {
"description": "Grade (Lettre entre A et E) la qualit\u00e9 repr\u00e9sentant la conduite \u00e9co-responsable du v\u00e9hicule. Elle peut \u00eatre `null` si il n'y eu aucun d\u00e9placement sur la p\u00e9riode.",
"type": "string",
"example": "A"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"401": {
"description": "error authentication"
},
"422": {
"description": "Invalid Parameter"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/reports/kilometer-synthesis/{deviceId}/{date}": {
"get": {
"tags": [
"Fleet/Reports"
],
"summary": "Synth\u00e8se kilom\u00e9trique",
"description": "Synth\u00e8se kilom\u00e9trique retournant des statistiques sur les d\u00e9placements des v\u00e9hicules (temps de conduite, kilometrage, temps d'arr\u00eat...). Consultable pour un ou plusieurs v\u00e9hicules, sur une p\u00e9riode d'une journ\u00e9e \u00e0 un mois.",
"operationId": "getSyntheseKmReport",
"produces": [
"application/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du ou des Devices : `999` ou `1453,4676,64657`",
"required": true,
"type": "string"
},
{
"name": "date",
"in": "path",
"description": "P\u00e9riodes du rapport \u00e0 visualiser ex: `2017-06-26,2017-06-30` ou `2017-06-26`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"required": [
"device",
"data"
],
"type": "object",
"$ref": "#/definitions/SyntheseKm"
}
}
},
"401": {
"description": "error authentication"
},
"422": {
"description": "Invalid Parameter"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/fleet/reports/sensor/{deviceId}/{sensorId}/{date}": {
"get": {
"tags": [
"Fleet/Reports"
],
"summary": "Rapport capteur",
"description": "Retourne le d\u00e9tail d'un capteur qui \u00e9quipe un v\u00e9hicule pour une date ou une p\u00e9riode donn\u00e9e. Consultable pour une p\u00e9riode d'une journ\u00e9e \u00e0 un mois.",
"operationId": "getDailyBaliseReport",
"produces": [
"application/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du Device : `999`",
"required": true,
"type": "string"
},
{
"name": "sensorId",
"in": "path",
"description": "Identifiant du Capteur : `999`",
"required": true,
"type": "string"
},
{
"name": "date",
"in": "path",
"description": "P\u00e9riodes du rapport \u00e0 visualiser ex: `2017-06-26,2017-06-30` ou `2017-06-26`",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"properties": {
"when": {
"type": "datetime",
"example": "2017-06-06 17:00:00"
},
"where": {
"properties": {
"where": {
"$ref": "#/definitions/Location"
}
},
"type": "object"
},
"value": {
"type": "float",
"example": 9.99
}
},
"type": "object"
}
}
},
"401": {
"description": "error authentication"
},
"422": {
"description": "Invalid Parameter"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"driverOauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/accounts": {
"get": {
"tags": [
"Missions/Accounts"
],
"summary": "Liste (pagin\u00e9e) de tous les comptes.",
"description": "Liste (pagin\u00e9e) de tous les comptes.",
"operationId": "getAllAccounts",
"parameters": [
{
"name": "filter",
"in": "query",
"description": "Filtre sur le nom ou le code du compte ou sur nom de la rue.",
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Filtre sur le(s) tag(s). S\u00e9par\u00e9s par des virgules.",
"type": "string"
},
{
"name": "tags-mode",
"in": "query",
"description": "Mode de recherche des tags. `OR` utilis\u00e9 si non sp\u00e9cifi\u00e9.",
"type": "string",
"enum": [
"OR",
"AND"
]
},
{
"name": "zip",
"in": "query",
"description": "Filtre sur un code postal.",
"type": "string"
},
{
"name": "with-closed-mission-from",
"in": "query",
"description": "Filtre les comptes ayant clotur\u00e9 au moins une mission apr\u00e8s la date sp\u00e9cifi\u00e9.",
"type": "string"
},
{
"name": "with-closed-mission-to",
"in": "query",
"description": "Filtre les comptes ayant clotur\u00e9 au moins une mission avant la date sp\u00e9cifi\u00e9.",
"type": "string"
},
{
"name": "isProfessionnal",
"in": "query",
"description": "Filtre uniquement les comptes professionels si `true`, les particuliers si `false`, tous si non sp\u00e9cifi\u00e9.",
"type": "boolean"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Account"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Missions/Accounts"
],
"summary": "Cr\u00e9er un compte",
"description": "",
"operationId": "createAccount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "Informations relatives au compte client \u00e0 cr\u00e9er.",
"required": true,
"schema": {
"required": [
"name",
"code",
"isProfessionnal"
],
"properties": {
"name": {
"description": "Nom du compte (Nom de la soci\u00e9t\u00e9 si `isProfessionnal=true`, Nom de famille si `isProfessionnal=false`).",
"type": "string",
"example": "Dupont"
},
"firstName": {
"description": "Pr\u00e9nom du contact. N\u00e9cessaire uniquement si le compte est un particulier (`isProfessionnal=false`).",
"type": "string",
"example": "Jean"
},
"code": {
"description": "Code client dans votre syst\u00e8me informatique.",
"type": "string",
"example": "SDF2055"
},
"comment": {
"description": "Commentaire associ\u00e9 au compte.",
"type": "string",
"example": "Client fid\u00e8le"
},
"phone": {
"type": "string",
"example": "02.47.41.07.58"
},
"isProfessionnal": {
"description": "Ce compte est un professionnel (`true`) ou particulier (`false`).",
"type": "boolean",
"example": false
},
"where": {
"$ref": "#/definitions/Address"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/accounts/{id}": {
"get": {
"tags": [
"Missions/Accounts"
],
"summary": "D\u00e9tail d'un compte sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es d'un compte sp\u00e9cifique",
"operationId": "getAccount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Account"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Missions/Accounts"
],
"summary": "Modifier un compte",
"operationId": "updateAccount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de la account",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Donn\u00e9es du comple client \u00e0 modifier",
"required": true,
"schema": {
"required": [
"name",
"code",
"isProfessionnal"
],
"properties": {
"name": {
"description": "Nom du compte (Nom de la soci\u00e9t\u00e9 si le compte est Professionel, Nom de famille pour un particulier.",
"type": "string",
"example": "Dupont"
},
"firstName": {
"description": "Pr\u00e9nom du contact. N\u00e9cessaire uniquement si le compte est un particulier.",
"type": "string",
"example": "Jean"
},
"code": {
"description": "Code client dans votre syst\u00e8me informatique.",
"type": "string",
"example": "SDF2055"
},
"comment": {
"description": "Commentaire associ\u00e9 au compte.",
"type": "string",
"example": "Tr\u00e8s bonne soci\u00e9t\u00e9"
},
"phone": {
"type": "string",
"example": "02410758"
},
"where": {
"$ref": "#/definitions/Address"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Missions/Accounts"
],
"summary": "Supprime un compte",
"description": "Supprime un compte sp\u00e9cifique",
"operationId": "deleteAccount",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/accounts/{id}/tags": {
"post": {
"tags": [
"Missions/Accounts"
],
"summary": "Associe un ou plusieurs tags a un compte.",
"description": "Associe un ou plusieurs tags a un compte. Attention: Si le compte a d\u00e9j\u00e0 des tags ils seront supprim\u00e9s.",
"operationId": "createAccountTags",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de la account",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "tags",
"in": "body",
"description": "Liste des tags s\u00e9par\u00e9s par des virgules ex:BTP,electricien",
"required": true,
"schema": {
"required": [
"tags"
],
"properties": {
"tags": {
"description": "Liste des tags s\u00e9par\u00e9s par des virgules",
"type": "string",
"example": "BTP,electricien"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/assignees": {
"get": {
"tags": [
"Missions/Assignees"
],
"summary": "Liste (pagin\u00e9e) de tous le personnel terrain.",
"description": "Liste (pagin\u00e9e) de tous le personnel terrain.",
"operationId": "getAllAssignees",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Nom du personnel terrain.",
"type": "string"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Assignee"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/assignees/{id}": {
"get": {
"tags": [
"Missions/Assignees"
],
"summary": "D\u00e9tail d'un groupe sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es d'un personnel terrain sp\u00e9cifique",
"operationId": "getAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Assignee"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Missions/Assignees"
],
"summary": "Modifier un personnel terrain",
"description": "",
"operationId": "updateAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model assignee n\u00e9cessaire \u00e0 la modification",
"required": true,
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Nom du personnel terrain.",
"type": "string",
"example": "Techniciens"
},
"comment": {
"description": "Commentaire.",
"type": "string",
"example": "Techniciens"
},
"group": {
"properties": {
"id": {
"description": "Identifiant du groupe associ\u00e9 au personnel terrain",
"type": "integer",
"example": 1
}
},
"type": "object"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"404": {
"description": "not found"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/assignees/{id}/photo": {
"post": {
"tags": [
"Missions/Assignees"
],
"summary": "Modifie la photo du personnel terrain",
"description": "",
"operationId": "addAttachmentAssignee",
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de la assignee",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "filename",
"in": "formData",
"description": "Fichier a ajouter",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"404": {
"description": "not found"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/assignees/{id}/device": {
"delete": {
"tags": [
"Missions/Assignees"
],
"summary": "Supprimer l'association entre le t\u00e9l\u00e9phone et le personnel terrain.",
"description": "",
"operationId": "DelAssociationDeviceAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/assignees/{id}/key": {
"get": {
"tags": [
"Missions/Assignees"
],
"summary": "Demande d'association",
"description": "G\u00e9n\u00e8re une cl\u00e9 permettant d'associer un p\u00e9riph\u00e9rique avec le personnel terrain sp\u00e9cifi\u00e9.",
"operationId": "getAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"required": [
"key",
"expireAt"
],
"properties": {
"key": {
"description": "Cl\u00e9 \u00e0 saisir dans le p\u00e9riph\u00e9rique.",
"type": "string",
"example": "1574 8087 7834 1132"
},
"expireAt": {
"description": "Date Heure d'expiration de la cl\u00e9.",
"type": "string",
"example": "16:00"
}
},
"type": "object"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/assignees/{id}/messages": {
"get": {
"tags": [
"Missions/Assignees"
],
"summary": "Messages du personnel terrain",
"description": "Liste (pagin\u00e9e) de tous les messages re\u00e7us/\u00e9mis par/pour du personnel terrain.",
"operationId": "getAllAssigneesMessages",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Message"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"404": {
"description": "not found"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Missions/Assignees"
],
"summary": "Envoyer un message au personnel terrain",
"description": "",
"operationId": "createAssigneeMessage",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model message n\u00e9cessaire \u00e0 la cr\u00e9ation",
"required": true,
"schema": {
"required": [
"subject"
],
"properties": {
"summary": {
"type": "string",
"example": "titre du message"
},
"details": {
"type": "string",
"example": "corps du message"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"404": {
"description": "not found"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/accounts/{id}/contacts": {
"get": {
"tags": [
"Missions/Contacts"
],
"summary": "Liste (pagin\u00e9e) de tous les contacts d'un compte.",
"description": "Liste (pagin\u00e9e) de tous les contacts d'un compte.",
"operationId": "getAllContacts",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du compte associ\u00e9",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "name",
"in": "query",
"description": "Filtre sur le nom du contact.",
"type": "string"
},
{
"name": "firstName",
"in": "query",
"description": "Filtre sur le pr\u00e9nom du contact.",
"type": "string"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Missions/Contacts"
],
"summary": "Cr\u00e9er un contact",
"description": "",
"operationId": "createContact",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du compte associ\u00e9",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model contact n\u00e9cessaire \u00e0 la cr\u00e9ation d'un contact",
"required": true,
"schema": {
"required": [
"gender",
"name",
"firstName"
],
"properties": {
"gender": {
"description": "M. ou Mme",
"type": "string",
"example": "M."
},
"name": {
"description": "Nom du contact.",
"type": "string",
"example": "Dupont"
},
"firstName": {
"description": "Pr\u00e9nom du contact.",
"type": "string",
"example": "Jean"
},
"fonction": {
"type": "string",
"example": "Directeur"
},
"email": {
"type": "string",
"example": "dupont.jean@gmail.com"
},
"phone": {
"description": "T\u00e9l\u00e9phone fixe du contact.",
"type": "string",
"example": "02.47.41.07.58"
},
"gsm": {
"description": "T\u00e9l\u00e9phone portable du contact.",
"type": "string",
"example": "06.45.41.07.58"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/accounts/{accountId}/contacts/{contactId}": {
"get": {
"tags": [
"Missions/Contacts"
],
"summary": "D\u00e9tail d'un contact sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es d'un contact sp\u00e9cifique",
"operationId": "getContact",
"produces": [
"application/json"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "Identifiant du compte",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "contactId",
"in": "path",
"description": "Identifiant du contact",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Contact"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Missions/Contacts"
],
"summary": "Modifier un contact",
"operationId": "updateContact",
"produces": [
"application/json"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "Identifiant du compte",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "contactId",
"in": "path",
"description": "Identifiant du contact",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model account n\u00e9cessaire \u00e0 la modification d'un compte",
"required": true,
"schema": {
"required": [
"gender",
"name",
"firstName"
],
"properties": {
"gender": {
"description": "M. ou Mme",
"type": "string",
"example": "M."
},
"name": {
"description": "Nom du contact.",
"type": "string",
"example": "Dupont"
},
"firstName": {
"description": "Pr\u00e9nom du contact.",
"type": "string",
"example": "Jean"
},
"fonction": {
"type": "string",
"example": "Directeur"
},
"email": {
"type": "string",
"example": "dupont.jean@gmail.com"
},
"phone": {
"description": "T\u00e9l\u00e9phone fixe du contact.",
"type": "string",
"example": "02.47.41.07.58"
},
"gsm": {
"description": "T\u00e9l\u00e9phone portable du contact.",
"type": "string",
"example": "06.45.41.07.58"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Missions/Contacts"
],
"summary": "Supprime un contact",
"description": "Supprime un contact sp\u00e9cifique",
"operationId": "deleteContact",
"produces": [
"application/json"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "Identifiant du compte",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "contactId",
"in": "path",
"description": "Identifiant du contact",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/groups": {
"get": {
"tags": [
"Missions/Groups"
],
"summary": "Liste (pagin\u00e9e) de tous les groupes de personnel terrain.",
"description": "Liste (pagin\u00e9e) de tous les groupes de personnel terrain.",
"operationId": "getAllGroupsAssignee",
"parameters": [
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/GroupAssignee"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Missions/Groups"
],
"summary": "Cr\u00e9er un groupe de personnel terrain",
"description": "",
"operationId": "createGroupAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model groupe n\u00e9cessaire \u00e0 la cr\u00e9ation d'un groupe",
"required": true,
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Nom du groupe.",
"type": "string",
"example": "Techniciens"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/groups/{id}": {
"get": {
"tags": [
"Missions/Groups"
],
"summary": "D\u00e9tail d'un groupe sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es d'un groupe sp\u00e9cifique",
"operationId": "getGroupeAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GroupAssignee"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Missions/Groups"
],
"summary": "Modifier un groupe de personnel terrain",
"description": "",
"operationId": "updateGroupAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model groupe n\u00e9cessaire \u00e0 la modification d'un groupe",
"required": true,
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "Nom du groupe.",
"type": "string",
"example": "Techniciens"
},
"assignees": {
"type": "array",
"items": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Identifiant(s) du(es) personnel(s) terrain \u00e0 ajouter au groupe.",
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Missions/Groups"
],
"summary": "Supprime un groupe de personnel terrain.",
"description": "Supprime un groupe de personnel terrain. Le personnel qui y \u00e9tait associ\u00e9 n'appartiennent plus \u00e0 aucun groupe.",
"operationId": "deleteGroupsAssignee",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/messages": {
"get": {
"tags": [
"Missions/Messages"
],
"summary": "Liste (pagin\u00e9e) de tous les messages.",
"description": "Liste (pagin\u00e9e) de tous les messages.",
"operationId": "getAllMessages",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Message"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Missions/Messages"
],
"summary": "Envoyer un message",
"description": "",
"operationId": "createMessage",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "Envoyer un message \u00e0 un ou plusieurs personnels terrain.",
"required": true,
"schema": {
"required": [
"subject"
],
"properties": {
"summary": {
"type": "string",
"example": "titre du message"
},
"details": {
"type": "string",
"example": "detail du message"
},
"assignees": {
"type": "array",
"items": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/messages/{id}": {
"get": {
"tags": [
"Missions/Messages"
],
"summary": "D\u00e9tails d'un message sp\u00e9cifique.",
"description": "D\u00e9tails d'un message sp\u00e9cifique.",
"operationId": "getMessage",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Message"
}
},
"401": {
"description": "error authentication"
},
"404": {
"description": "not found"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/flows": {
"get": {
"tags": [
"Missions/Missions"
],
"summary": "Liste (pagin\u00e9e) de tous les flux.",
"description": "Liste (pagin\u00e9e) de tous les flux.",
"operationId": "getAllMessages",
"parameters": [
{
"name": "missionId",
"in": "query",
"description": "Filtre les flux sur une mission.",
"type": "integer"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"required": [],
"properties": {
"type": {
"type": "string",
"example": "Passage en 'A planifier'"
},
"comment": {
"type": "string"
},
"createdAt": {
"type": "string",
"example": "2017-08-04 15:39:11"
},
"status": {
"type": "string",
"example": "TO_CONFIRM"
},
"user": {
"type": "object",
"items": {
"required": [],
"properties": {
"id": {
"description": "Identifiant de l'utilisateur ayant effectu\u00e9 l'action",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom de l'utilisateur ayant effectu\u00e9 l'action",
"type": "string",
"example": "Paul Dupond"
}
},
"type": "object"
}
},
"assignee": {
"type": "object",
"items": {
"required": [],
"properties": {
"id": {
"description": "Identifiant du personnel terrain ayant effectu\u00e9 l'action",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du personnel terrain ayant effectu\u00e9 l'action",
"type": "string",
"example": "Paul Dupond"
}
},
"type": "object"
}
},
"mission": {
"type": "object",
"items": {
"required": [],
"properties": {
"id": {
"description": "Identifiant de la mission ayant \u00e9t\u00e9 modifi\u00e9",
"type": "integer",
"example": 1
},
"code": {
"description": "Code de la mission ayant \u00e9t\u00e9 modifi\u00e9",
"type": "string",
"example": "Paul Dupond"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/missions": {
"get": {
"tags": [
"Missions/Missions"
],
"summary": "Liste (pagin\u00e9e) de toutes les missions.",
"description": "Liste (pagin\u00e9e) de toutes les missions.",
"operationId": "getAllMissions",
"parameters": [
{
"name": "accoundId",
"in": "query",
"description": "Identifiant du compte auquel les missions appartiennent.",
"type": "integer"
},
{
"name": "status",
"in": "query",
"description": "Filtre sur le ou les status.",
"type": "array",
"items": {
"type": "string",
"enum": [
"TO_PLAN",
"TO_CONFIRM",
"CONFIRMED",
"TO_DO",
"IN_PROGRESS",
"DONE",
"CANCELED"
],
"example": "TO_PLAN,TO_CONFIRM"
}
},
{
"name": "startDate",
"in": "query",
"description": "Date de d\u00e9but de la mission.",
"type": "string"
},
{
"name": "endDate",
"in": "query",
"description": "Date de fin de la mission.",
"type": "string"
},
{
"name": "assigneeId",
"in": "query",
"description": "Identifiant du personnel terrain devant r\u00e9aliser la mission.",
"type": "integer"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Mission"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Missions/Missions"
],
"summary": "Cr\u00e9er une mission",
"description": "",
"operationId": "createAccount",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Model mission n\u00e9cessaire \u00e0 la cr\u00e9ation d'une mission",
"required": true,
"schema": {
"required": [
"summary",
"account"
],
"properties": {
"summary": {
"description": "R\u00e9sum\u00e9 de la mission.",
"type": "string",
"example": "Intervention chaudi\u00e8re"
},
"startAt": {
"description": "D\u00e9but de la mission.",
"type": "string",
"example": "2017-06-15 14:07:00"
},
"endAt": {
"description": "Fin de la mission.",
"type": "string",
"example": "2017-06-15 15:07:00"
},
"duration": {
"description": "Dur\u00e9e en seconde de la mission.",
"type": "integer",
"example": 3600
},
"details": {
"description": "Description de la mission.",
"type": "string",
"example": "Depannez la chaudi\u00e8re de Mr Dupond"
},
"isAllDay": {
"description": "La mission dure-t-elle toute la journ\u00e9e ?",
"type": "boolean",
"example": false
},
"isEditable": {
"description": "La mission peut-t-elle \u00eatre modifi\u00e9 ?",
"type": "boolean",
"readOnly": true,
"example": false
},
"status": {
"type": "string",
"enum": [
"TO_PLAN",
"TO_CONFIRM",
"CONFIRMED",
"TO_DO",
"IN_PROGRESS",
"DONE",
"CANCELED"
]
},
"account": {
"properties": {
"id": {
"description": "Identifiant du compte.",
"type": "integer",
"example": 4
},
"name": {
"description": "Nom du compte si celui-ci n'existe pas.",
"type": "string",
"example": "SA Touraine"
},
"firstName": {
"description": "Pr\u00e9nom du compte si le compte est un particulier.",
"type": "string",
"example": "SA Touraine"
},
"isProfessionnal": {
"description": "Est-ce un compte professionnel. Obligatoire si le compte n'existe pas.",
"type": "boolean",
"example": "true"
}
},
"type": "object"
},
"contact": {
"properties": {
"id": {
"description": "Identifiant du contact.",
"type": "integer",
"example": 4
},
"name": {
"description": "Nom du contact si celui-ci n'existe pas.",
"type": "string",
"example": "Duchemin"
},
"firstName": {
"description": "Pr\u00e9nom du contact si celui-ci n'existe pas.",
"type": "string",
"example": "Jean Hibernatus"
}
},
"type": "object"
},
"assignee": {
"properties": {
"id": {
"description": "Identifiant du personnel terrain.",
"type": "integer",
"example": 4
}
},
"type": "object"
},
"where": {
"properties": {
"poi": {
"description": "Informations basique sur Point d'int\u00e9r\u00eat. Si `poi` est d\u00e9finit, `address` l'est aussi.",
"required": [],
"properties": {
"id": {
"type": "integer",
"example": 1756
},
"name": {
"type": "string",
"example": "Nom du POI"
}
},
"type": "object"
},
"address": {
"properties": {
"street": {
"type": "string",
"example": "178 avenue andr\u00e9 maginot"
},
"city": {
"type": "string",
"example": "Tours"
},
"zip": {
"type": "string",
"example": "37100"
}
},
"type": "object"
},
"point": {
"$ref": "#/definitions/Point"
}
},
"type": "object"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/missions/{id}": {
"get": {
"tags": [
"Missions/Missions"
],
"summary": "D\u00e9tail d'une mission sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es d'une mission sp\u00e9cifique",
"operationId": "getMission",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Mission"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Missions/Missions"
],
"summary": "Modifier une mission",
"operationId": "updateMission",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de la mission",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Model Mission.",
"required": true,
"schema": {
"required": [
"summary",
"account"
],
"properties": {
"summary": {
"description": "R\u00e9sum\u00e9 de la mission.",
"type": "string",
"example": "Intervention chaudi\u00e8re"
},
"startAt": {
"description": "D\u00e9but de la mission.",
"type": "string",
"example": "2017-06-15 14:07:00"
},
"endAt": {
"description": "Fin de la mission.",
"type": "string",
"example": "2017-06-15 15:07:00"
},
"duration": {
"description": "Dur\u00e9e en seconde de la mission.",
"type": "integer",
"example": 3600
},
"details": {
"description": "Description de la mission.",
"type": "string",
"example": "Depannez la chaudi\u00e8re de Mr Dupond"
},
"isAllDay": {
"description": "La mission dure-t-elle toute la journ\u00e9e ?",
"type": "boolean",
"example": false
},
"isEditable": {
"description": "La mission peut-t-elle \u00eatre modifi\u00e9 ?",
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"enum": [
"TO_PLAN",
"TO_CONFIRM",
"CONFIRMED",
"TO_DO",
"IN_PROGRESS",
"DONE",
"CANCELED"
]
},
"account": {
"properties": {
"id": {
"description": "Identifiant du compte.",
"type": "integer",
"example": 4
},
"name": {
"description": "Nom du compte si celui-ci n'existe pas.",
"type": "string",
"example": "SA Touraine"
},
"firstName": {
"description": "Pr\u00e9nom du compte si le compte est un particulier.",
"type": "string",
"example": "SA Touraine"
},
"isProfessionnal": {
"description": "Est-ce un compte professionnel. Obligatoire si le compte n'existe pas.",
"type": "boolean",
"example": "true"
}
},
"type": "object"
},
"contact": {
"properties": {
"id": {
"description": "Identifiant du contact.",
"type": "integer",
"example": 4
},
"name": {
"description": "Nom du contact si celui-ci n'existe pas.",
"type": "string",
"example": "Duchemin"
},
"firstName": {
"description": "Pr\u00e9nom du contact si celui-ci n'existe pas.",
"type": "string",
"example": "Jean Hibernatus"
}
},
"type": "object"
},
"assignee": {
"properties": {
"id": {
"description": "Identifiant du personnel terrain.",
"type": "integer",
"example": 4
}
},
"type": "object"
},
"where": {
"properties": {
"poi": {
"description": "Informations basique sur Point d'int\u00e9r\u00eat. Si `poi` est d\u00e9finit, `address` l'est aussi.",
"required": [],
"properties": {
"id": {
"type": "integer",
"example": 1756
},
"name": {
"type": "string",
"example": "Nom du POI"
}
},
"type": "object"
},
"address": {
"properties": {
"street": {
"type": "string",
"example": "178 avenue andr\u00e9 maginot"
},
"city": {
"type": "string",
"example": "Tours"
},
"zip": {
"type": "string",
"example": "37100"
}
},
"type": "object"
},
"point": {
"$ref": "#/definitions/Point"
}
},
"type": "object"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/missions/{id}/flows": {
"get": {
"tags": [
"Missions/Missions"
],
"summary": "Liste les flux d'une mission",
"description": "Retourne les flux d'une mission sp\u00e9cifique",
"operationId": "getMissionFlow",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"type",
"comment",
"user",
"assignee",
"status"
],
"properties": {
"type": {
"description": "Type de flux.",
"type": "string",
"example": "Modification"
},
"comment": {
"description": "",
"type": "string",
"example": "Ajout du fichier Notice de la chaudiere"
},
"user": {
"description": "Info sur l'utilisateur ayant effectu\u00e9 l'action. Peut \u00eatre null.",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Identifiant de l'utilisateur.",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom de l'utilisateur.",
"type": "string",
"example": "Paul Dupond"
}
},
"type": "object"
},
"assignee": {
"description": "Info sur personnel terrain ayant effectu\u00e9 l'action. Peut \u00eatre null.",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Identifiant du personnel terrain.",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du personnel terrain.",
"type": "string",
"example": "Paul Dupond"
}
},
"type": "object"
},
"status": {
"description": "Info sur le status de la mission au moment de l'action.",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "id du status.",
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Paul Dupond"
}
},
"type": "object"
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/missions/{id}/status": {
"put": {
"tags": [
"Missions/Missions"
],
"summary": "Modifier le status d'une mission",
"operationId": "updateMissionStatus",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de la mission",
"required": true,
"type": "integer"
},
{
"name": "status",
"in": "query",
"description": "Filtre sur le ou les status.",
"type": "string",
"enum": [
"TO_PLAN",
"TO_CONFIRM",
"CONFIRMED",
"TO_DO",
"IN_PROGRESS",
"DONE",
"CANCELED"
]
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/missions/{id}/attachments": {
"post": {
"tags": [
"Missions/Missions"
],
"summary": "Ajout d'une piece jointe a une mission",
"description": "",
"operationId": "addAttachmentMission",
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id de la mission",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "filename",
"in": "formData",
"description": "Fichier a ajouter",
"required": true,
"type": "file"
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/missions/attachments/{hash}": {
"get": {
"tags": [
"Missions/Missions"
],
"summary": "R\u00e9cuperation d'une pi\u00e8ce jointe d'une mission",
"description": "R\u00e9cuperation d'une pi\u00e8ce jointe d'une mission",
"operationId": "getMissionAttachment",
"produces": [
"image/png",
"image/jpg"
],
"parameters": [
{
"name": "hash",
"in": "path",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Missions/Missions"
],
"summary": "Supprime une pi\u00e8ce jointe",
"description": "Supprime une pi\u00e8ce jointe.",
"operationId": "deleteAttachment",
"parameters": [
{
"name": "hash",
"in": "path",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/drivers": {
"get": {
"tags": [
"Park/Drivers"
],
"summary": "Liste (pagin\u00e9e) de tous vos collaborateurs",
"description": "Liste (pagin\u00e9e) de tous les collaborateurs.",
"operationId": "getAllDrivers",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 18
},
"title": {
"type": "string",
"example": "M"
},
"name": {
"type": "string",
"example": "DUPONT"
},
"forname": {
"type": "string",
"example": "Robert"
},
"email": {
"type": "string",
"example": "r.dupond@exemple.fr"
},
"gsm": {
"type": "string",
"example": "0612345678"
},
"login": {
"description": "Identifiant de connexion a l'application conducteur",
"type": "string",
"example": "robert.dupond"
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Park/Drivers"
],
"summary": "Cr\u00e9er un collaborateur",
"description": "Permet de cr\u00e9er un collaborateur.",
"operationId": "DriverCreate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"required": [
"title",
"name",
"forname",
"email"
],
"properties": {
"title": {
"type": "string",
"maximum": "3",
"example": "M"
},
"name": {
"description": "Nom du collaborateur",
"type": "string",
"maximum": "33",
"example": "Doe"
},
"forname": {
"description": "Pr\u00e9nom du collaborateur",
"type": "string",
"maximum": "33",
"example": "John"
},
"email": {
"description": "Email du collaborateur",
"type": "string",
"example": "john.doe@mail.com"
},
"gsm": {
"description": "T\u00e9l\u00e9phone du collaborateur",
"type": "string",
"example": "**-**-**-**-**"
},
"login": {
"description": "Identifiant au format pr\u00e9nom.nom",
"type": "string"
},
"password": {
"description": "Mot de passe",
"type": "string"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/drivers/{id}": {
"get": {
"tags": [
"Park/Drivers"
],
"summary": "R\u00e9cup\u00e8re les informations d'un collaborateur sp\u00e9cifique.",
"description": "",
"operationId": "getDriver",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 19
},
"title": {
"type": "string",
"example": "M"
},
"name": {
"type": "string",
"example": "DUPONT"
},
"forname": {
"type": "string",
"example": "Robert"
},
"email": {
"type": "string",
"example": "r.dupond@exemple.fr"
},
"gsm": {
"type": "string",
"example": "0612345678"
},
"login": {
"description": "Identifiant de connexion a l'application conducteur",
"type": "string",
"example": "robert.dupond"
}
},
"type": "object"
}
},
"403": {
"description": "Ce collaborateur n'est pas autoris\u00e9 \u00e0 acc\u00e9der \u00e0 la ressource"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Park/Drivers"
],
"summary": "Modification d'un collaborateur",
"description": "Permet de modifier les informations d'un collaborateur.",
"operationId": "DriverUpdate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"properties": {
"title": {
"type": "string",
"maximum": "3",
"example": "M"
},
"name": {
"description": "Nom du collaborateur",
"type": "string",
"maximum": "33",
"example": "Doe"
},
"forname": {
"description": "Pr\u00e9nom du collaborateur",
"type": "string",
"maximum": "33",
"example": "John"
},
"email": {
"description": "Email du collaborateur",
"type": "string",
"example": "john.doe@mail.com"
},
"gsm": {
"description": "T\u00e9l\u00e9phone du collaborateur",
"type": "string",
"example": "**-**-**-**-**"
},
"login": {
"description": "Identifiant au format pr\u00e9nom.nom",
"type": "string"
},
"password": {
"description": "Mot de passe",
"type": "string"
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Park/Drivers"
],
"summary": "Supprimer un collaborateur",
"operationId": "deleteUser",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/drivers/{id}/park/vehicle": {
"get": {
"tags": [
"Park/Drivers"
],
"summary": "Liste les v\u00e9hicules de votre parc associ\u00e9s au collaborateur",
"description": "Liste les v\u00e9hicules de votre parc associ\u00e9s au collaborateur. Si `from` et/ou `to` sont d\u00e9finis, vous obtenez l'historique des v\u00e9hicules du parc associ\u00e9s au collaborateur sur la p\u00e9riode sp\u00e9cifi\u00e9e.",
"operationId": "getDriverVehiculeAssociated",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "from",
"in": "query",
"description": "P\u00e9riode de d\u00e9but de l'association du v\u00e9hicule",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "path",
"description": "P\u00e9riode d'arr\u00eat de l'association du v\u00e9hicule",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"property": "message",
"type": "array",
"items": {
"properties": {
"vehicle": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"regPlate": {
"type": "string",
"example": "AA-1111-AA"
}
},
"type": "object"
},
"association": {
"properties": {
"startAt": {
"type": "string",
"example": "2016-07-10 12:54:22"
},
"endAt": {
"type": "string",
"example": "2016-08-10 14:00:00"
}
},
"type": "object"
}
}
}
}
},
"403": {
"description": "forbidden request"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/drivers/{id}/fleet/devices": {
"get": {
"tags": [
"Park/Drivers"
],
"summary": "Liste le v\u00e9hicule g\u00e9olocalis\u00e9 associ\u00e9 \u00e0 votre collaborateur",
"description": "Si `from` et/ou `to` sont d\u00e9finis, vous obtenez l'historique des v\u00e9hicules associ\u00e9s au collaborateur sur la p\u00e9riode sp\u00e9cifi\u00e9e.",
"operationId": "getDriverGeolocalizedDeviceAssociated",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "from",
"in": "query",
"description": "P\u00e9riode de d\u00e9but de l'association du v\u00e9hicule",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "path",
"description": "P\u00e9riode d'arr\u00eat de l'association du v\u00e9hicule",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"property": "message",
"type": "array",
"items": {
"properties": {
"device": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"regPlate": {
"type": "string",
"example": "AA-1111-AA"
},
"name": {
"type": "string",
"example": "John ode"
},
"icon": {
"type": "integer",
"example": 4
}
},
"type": "object"
},
"association": {
"properties": {
"startAt": {
"type": "string",
"example": "2016-07-10 12:54:22"
},
"endAt": {
"type": "string",
"example": "2016-08-10 14:00:00"
}
},
"type": "object"
}
}
}
}
},
"403": {
"description": "Ce collaborateur n'est pas autoris\u00e9 \u00e0 acc\u00e9der \u00e0 la ressource"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/drivers/{id}/park/vehicle/{vehicleId}": {
"post": {
"tags": [
"Park/Drivers"
],
"summary": "Associer un collaborateur \u00e0 un v\u00e9hicule du parc.",
"description": "Permet d'associer un collaborateur \u00e0 un v\u00e9hicule du parc.",
"operationId": "DriverAssociate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "vehicleId",
"in": "path",
"description": "Identifiant du vehicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Utilisation de la date/heure courante si non sp\u00e9cifi\u00e9",
"required": false,
"schema": {
"properties": {
"start_at": {
"description": "D\u00e9but de l'utilisation de ce v\u00e9hicule par votre collaborateur.",
"type": "string",
"example": "2017-11-12 14:02:30"
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Park/Drivers"
],
"summary": "D\u00e9sassocier un collaborateur \u00e0 un v\u00e9hicule du parc.",
"description": "Permet de d\u00e9sassocier un collaborateur \u00e0 un v\u00e9hicule du parc.",
"operationId": "DriverDesassociate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "vehicleId",
"in": "path",
"description": "Identifiant du vehicule",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/drivers/{id}/fleet/devices/{deviceId}": {
"post": {
"tags": [
"Park/Drivers"
],
"summary": "Associer un collaborateur \u00e0 un v\u00e9hicule g\u00e9olocalis\u00e9.",
"description": "Permet d'associer un collaborateur \u00e0 un v\u00e9hicule g\u00e9olocalis\u00e9.",
"operationId": "DriverAssociateDevice",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du vehicule",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"description": "Utilisation de la date/heure courante si non sp\u00e9cifi\u00e9",
"required": false,
"schema": {
"properties": {
"start_at": {
"description": "D\u00e9but de l'association de ce v\u00e9hicule g\u00e9ocolocalis\u00e9 \u00e0 ce collaborateur.",
"type": "string",
"example": "2017-11-12 14:02:30"
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Park/Drivers"
],
"summary": "D\u00e9sassocier un collaborateur \u00e0 un v\u00e9hicule g\u00e9olocalis\u00e9.",
"description": "Permet de d\u00e9sassocier un collaborateur \u00e0 un v\u00e9hicule g\u00e9olocalis\u00e9.",
"operationId": "DriverDesassociateDevice",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "deviceId",
"in": "path",
"description": "Identifiant du vehicule",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/drivers/{id}/badges/{badgeId}": {
"delete": {
"tags": [
"Park/Drivers"
],
"summary": "D\u00e9sassocier un collaborateur \u00e0 un badge.",
"description": "Permet de d\u00e9sassocier un collaborateur \u00e0 un badge.",
"operationId": "DriverDesassociateBadge",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du collaborateur",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "badgeId",
"in": "path",
"description": "Identifiant du badge",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/groups": {
"get": {
"tags": [
"Park/Groups"
],
"summary": "Liste (pagin\u00e9e) de tous vos groupes",
"description": "Liste (pagin\u00e9e) de tous les groupes.",
"operationId": "getAllGroups",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 18
},
"idclient": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Groupe John Doe"
},
"nbVehicles": {
"type": "integer",
"example": 3
},
"vehicles": {
"type": "array",
"items": {
"properties": {
"vehiculeId": {
"type": "integer",
"example": 1
},
"immatriculation": {
"type": "string",
"example": "007JB75"
},
"in_at": {
"type": "string",
"example": "01/01/1970"
},
"out_at": {
"type": "string",
"example": "01/01/1970"
},
"theorical_out_at": {
"type": "string",
"example": "01/01/1970"
},
"brand": {
"type": "string",
"example": "Peugeot"
},
"model": {
"type": "string",
"example": "Partner"
},
"versions": {
"type": "string",
"example": "170C 1.9D"
},
"drivers": {
"type": "string",
"example": "John Doe"
},
"company": {
"type": "string",
"example": "Doe Company"
},
"usage": {
"type": "boolean",
"example": 0
},
"OBD": {
"type": "boolean",
"example": 0
}
}
}
}
}
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Park/Groups"
],
"summary": "Cr\u00e9er un groupe",
"description": "Permet de cr\u00e9er un groupe.",
"operationId": "GroupCreate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maximum": "60",
"example": "Jonh Doe's Group"
}
},
"type": "object"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/groups/{id}": {
"get": {
"tags": [
"Park/Groups"
],
"summary": "R\u00e9cup\u00e8re les informations d'un groupe sp\u00e9cifique",
"description": "R\u00e9cup\u00e8re les informations d'un groupe sp\u00e9cifique",
"operationId": "getOneGroup",
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"id": {
"type": "integer",
"example": 18
},
"idclient": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Groupe John Doe"
},
"nbVehicles": {
"type": "integer",
"example": 3
},
"vehicles": {
"type": "array",
"items": {
"properties": {
"vehiculeId": {
"type": "integer",
"example": 1
},
"immatriculation": {
"type": "string",
"example": "007JB75"
},
"in_at": {
"type": "string",
"example": "01/01/1970"
},
"out_at": {
"type": "string",
"example": "01/01/1970"
},
"theorical_out_at": {
"type": "string",
"example": "01/01/1970"
},
"brand": {
"type": "string",
"example": "Peugeot"
},
"model": {
"type": "string",
"example": "Partner"
},
"versions": {
"type": "string",
"example": "170C 1.9D"
},
"drivers": {
"type": "string",
"example": "John Doe"
},
"company": {
"type": "string",
"example": "Doe Company"
},
"usage": {
"type": "boolean",
"example": 0
},
"OBD": {
"type": "boolean",
"example": 0
}
}
}
}
}
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Park/Groups"
],
"summary": "Modification d'un groupe",
"description": "Permet de modifier les informations d'un groupe.",
"operationId": "GroupUpdate",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du groupe",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"properties": {
"name": {
"description": "Nom du groupe",
"type": "string",
"maximum": "60",
"example": "John Doe's Group"
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"delete": {
"tags": [
"Park/Groups"
],
"summary": "Supprimer un groupe.",
"description": "`Un groupe ne doit plus contenir de v\u00e9hicules pour pouvoir \u00eatre supprim\u00e9.`",
"operationId": "deleteGroup",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du groupe",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/groups/{id}/attach": {
"put": {
"tags": [
"Park/Groups"
],
"summary": "Attacher un ou des v\u00e9hicules \u00e0 un groupe.",
"description": "`Un v\u00e9hicule d\u00e9j\u00e0 attach\u00e9 \u00e0 un groupe sera automatiquement d\u00e9tach\u00e9 de celui ci.`",
"operationId": "GroupVehicleAttach",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du groupe",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"properties": {
"vehicleIds": {
"type": "array",
"items": {
"title": "idVehicle",
"description": "Id du ou des v\u00e9hicules \u00e0 attacher au groupe",
"type": "integer",
"example": 1
}
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/groups/{id}/detach": {
"put": {
"tags": [
"Park/Groups"
],
"summary": "D\u00e9tacher un ou des v\u00e9hicules d'un groupe.",
"description": "D\u00e9tacher un ou des v\u00e9hicules d'un groupe.",
"operationId": "GroupVehicleDetach",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifiant du groupe",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"properties": {
"vehicleIds": {
"type": "array",
"items": {
"title": "idVehicle",
"description": "Id du ou des v\u00e9hicules \u00e0 d\u00e9tacher du groupe",
"type": "integer",
"example": 1
}
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/vehicles": {
"get": {
"tags": [
"Park/Vehicles"
],
"summary": "Liste tous les v\u00e9hicules de votre parc",
"description": "Liste (pagin\u00e9e) de tous les v\u00e9hicules de votre parc.",
"operationId": "getAllParkVehicles",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Vehicle"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"post": {
"tags": [
"Park/Vehicles"
],
"summary": "Cr\u00e9er un v\u00e9hicule de votre parc",
"description": "",
"operationId": "createParkVehicles",
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Vehicle"
}
}
],
"responses": {
"201": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/vehicles/{id}": {
"get": {
"tags": [
"Park/Vehicles"
],
"summary": "V\u00e9hicules sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es pour un v\u00e9hicule sp\u00e9cifique",
"operationId": "getParkVehicles",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Vehicle"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/park/vehicles/importations": {
"post": {
"tags": [
"Park/Vehicles"
],
"summary": "Import de v\u00e9hicule dans la gestion de parc",
"description": "",
"operationId": "vehicleImport",
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "filename",
"in": "formData",
"description": "Fichier Excel contenant la liste des v\u00e9hicules a importer.
T\u00e9l\u00e9charger le mod\u00e8le d'import : https://api.suivideflotte.net/import_gestion_de_parc_v2.xlsx.",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"code": {
"description": "Code de retour",
"type": "integer"
},
"message": {
"description": "Liste des erreurs s'\u00e9tant produite.",
"properties": {
"AA-9999-AA": {
"description": "Immatriculation import\u00e9e #1",
"properties": {
"code": {
"description": "Code de retour",
"type": "integer",
"example": 201
},
"message": {
"description": "Id du v\u00e9hicule cr\u00e9\u00e9 avec succ\u00e8s",
"type": "integer"
}
},
"type": "object"
},
"921ABC37": {
"description": "Immatriculation import\u00e9e #2",
"properties": {
"code": {
"description": "Code de retour",
"type": "integer",
"example": 422
},
"message": {
"description": "Liste des \u00e9ventuelles erreurs s'\u00e9tant produites.",
"type": "array",
"items": {
"properties": {
"error": {
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/plugins/categories": {
"get": {
"tags": [
"Plugins"
],
"summary": "Cat\u00e9gories de plugins disponibles.",
"description": "Liste les cat\u00e9gories de plugins disponibles.",
"operationId": "getPluginsCategories",
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"description": "Liste des cat\u00e9gories",
"type": "array",
"items": {
"properties": {
"id": {
"description": "Liste des cat\u00e9gories",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom de la cat\u00e9gorie",
"type": "string",
"maximum": "128",
"example": "Gestion RH"
}
}
}
}
},
"type": "object"
}
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/plugins/providers": {
"get": {
"tags": [
"Plugins"
],
"summary": "Services g\u00e9r\u00e9s par les plugins.",
"description": "Liste les services g\u00e9r\u00e9s par les plugins",
"operationId": "getPluginsProviders",
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"description": "Liste de providers",
"type": "array",
"items": {
"properties": {
"id": {
"description": "Liste de providers",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du service",
"type": "string",
"maximum": "128"
}
}
}
}
},
"type": "object"
}
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/support/tickets": {
"get": {
"tags": [
"Support"
],
"summary": "Liste tous les tickets en cours",
"description": "Liste (pagin\u00e9e) de tous les tickets en cours.",
"operationId": "getAllTickets",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Ticket"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/support/tickets/closed": {
"get": {
"tags": [
"Support"
],
"summary": "Liste des 10 derniers tickets clotur\u00e9s",
"description": "Liste des 10 derniers tickets clotur\u00e9s.",
"operationId": "getAllTicketsClosed",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Ticket"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
}
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/support/tickets/{id}": {
"get": {
"tags": [
"Support"
],
"summary": "Voir le d\u00e9tail d'un ticket",
"operationId": "getTicketsById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du ticket",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"allOf": [
{
"$ref": "#/definitions/Ticket"
},
{
"properties": {
"actions": {
"type": "array",
"items": {
"required": [
"actionAt",
"echange",
"interlocutor"
],
"properties": {
"actionAt": {
"description": "Date heure de l'action du ticket.",
"type": "string",
"example": "2017-02-17 16:01:12"
},
"actionType": {
"description": "Type de l'action :
`1` Appel entrant
`2` Appel sortant
`3` Mail entrant
`4` Mail sortant
`5` Note du Support Technique
`6` Note utilisateur
`50` Cl\u00f4ture du ticket
`150` T\u00e2che.",
"type": "integer",
"example": 1
},
"echange": {
"description": "Description de l'action r\u00e9alis\u00e9.",
"type": "string",
"example": "Envoi des codes de connexion a Mr Dupont"
},
"interlocutor": {
"description": "Personne ayant effectu\u00e9 l'action.",
"type": "string",
"example": "Support technique"
}
},
"type": "object"
}
}
}
}
]
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
},
"put": {
"tags": [
"Support"
],
"summary": "Ajouter une note a un ticket non clotur\u00e9",
"operationId": "ticketAddNote",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id du ticket",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"required": [
"echange"
],
"properties": {
"echange": {
"type": "string",
"example": "Note a ajout\u00e9"
}
},
"type": "object"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"401": {
"description": "error authentication"
},
"403": {
"description": "forbidden request"
},
"404": {
"description": "ticket not found"
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/support/tickets/stats": {
"get": {
"tags": [
"Support"
],
"summary": "R\u00e9cup\u00e9ration des statistiques concernant les tickets",
"operationId": "getTicketsStats",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"required": [
"closed",
"open",
"total",
"waitingForClient",
"untreated"
],
"properties": {
"closed": {
"description": "Nombre de ticket clotur\u00e9.",
"type": "integer"
},
"open": {
"description": "Nombre de ticket ouvert.",
"type": "integer"
},
"total": {
"description": "Nombre de ticket total.",
"type": "integer"
},
"waitingForClient": {
"description": "Nombre de ticket en attente d'\u00e9l\u00e9ment de la part du client.",
"type": "integer"
},
"untreated": {
"description": "Nombre de ticket en attente de prise en charge.",
"type": "integer"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/support/opening-time": {
"get": {
"tags": [
"Support"
],
"summary": "Disponibilit\u00e9 du Support Technique",
"description": "Retoune les heures d'ouvertures du Support et indique si celui-ci est actuellement ouvert",
"operationId": "getTicketsOpeningTime",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"phone": {
"properties": {
"isOpen": {
"description": "Indique si le standard t\u00e9l\u00e9phonique SuivDeFlotte.net est actuellement ouvert.",
"type": "boolean",
"example": true
},
"hours": {
"properties": {
"am": {
"description": "Horaire d'ouverture du matin.",
"type": "string",
"example": "09:00-12:00"
},
"pm": {
"description": "Horaire d'ouverture de l'apr\u00e8s-midi.",
"type": "string",
"example": "14:00-18:00"
}
},
"type": "object"
}
},
"type": "object"
},
"chat": {
"properties": {
"isOpen": {
"description": "Indique Chat est actuellement ouvert.",
"type": "boolean",
"example": true
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets/dashboard/fleet": {
"get": {
"tags": [
"Widgets"
],
"summary": "R\u00e9cup\u00e9re les widgets du tableau de bord 'g\u00e9olocalisation' de l'utilisateur.",
"operationId": "getAvailableWidgetsForUsers",
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/Dashboard"
}
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets/dashboard/beepiz": {
"get": {
"tags": [
"Widgets"
],
"summary": "R\u00e9cup\u00e9re les widgets du tableau de bord 'beepiz' de l'utilisateur.",
"operationId": "getAvailableWidgetsForUsersBeepiz",
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/Dashboard"
}
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets/dashboard/park": {
"get": {
"tags": [
"Widgets"
],
"summary": "R\u00e9cup\u00e9re les widgets du tableau de bord 'gestion de parc' de l'utilisateur.",
"operationId": "getAvailableWidgetsForUsersPark",
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/Dashboard"
}
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets": {
"get": {
"tags": [
"Widgets"
],
"summary": "Liste de tous les widgets disponibles",
"description": "Liste (pagin\u00e9e) de tous les widgets disponibles.",
"operationId": "getAvailableWidgets",
"parameters": [
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/sort"
},
{
"$ref": "#/parameters/equals"
},
{
"$ref": "#/parameters/like"
},
{
"$ref": "#/parameters/page"
},
{
"$ref": "#/parameters/perpage"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Widget"
}
},
"meta": {
"$ref": "#/definitions/pagination"
}
},
"type": "object"
}
},
"401": {
"description": "error authentication"
},
"406": {
"description": "not acceptable"
},
"422": {
"description": "Page X does not exist (last page is Y)."
},
"500": {
"description": "internal server error"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets/{id}": {
"get": {
"tags": [
"Widgets"
],
"summary": "Widget sp\u00e9cifique",
"description": "Retourne les informations d\u00e9taill\u00e9es pour un widget sp\u00e9cifique",
"operationId": "getWidgetDetail",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "deviceId",
"in": "query",
"description": "Si le widget peut \u00eatre demand\u00e9 pour un Device particulier, l'identifiant peut \u00eatre sp\u00e9cifi\u00e9.",
"type": "integer",
"format": "int64"
},
{
"name": "driverId",
"in": "query",
"description": "Si le widget peut \u00eatre demand\u00e9 pour un Driver particulier, l'identifiant peut \u00eatre sp\u00e9cifi\u00e9.",
"type": "integer",
"format": "int64"
},
{
"name": "from",
"in": "query",
"description": "Date (format yyyy-mm-dd) de d\u00e9but de p\u00e9riode sur laquelle agr\u00e9ger les donn\u00e9es (la p\u00e9riode maximale doit \u00eatre respect\u00e9e). Si non sp\u00e9cifi\u00e9e, la 'date du jour - p\u00e9riode maximale' est utilis\u00e9.",
"type": "string",
"format": "int64"
},
{
"name": "to",
"in": "query",
"description": "Date (format yyyy-mm-dd) de fin de p\u00e9riode sur laquelle agr\u00e9ger les donn\u00e9es (la p\u00e9riode maximale doit \u00eatre respect\u00e9e). Si non sp\u00e9cifi\u00e9e, la date du jour est utilis\u00e9e.",
"type": "string",
"format": "int64"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/WidgetData"
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets/fleet": {
"get": {
"tags": [
"Widgets"
],
"summary": "Widget sp\u00e9cifique \u00e0 l'univers g\u00e9olocalisation",
"description": "Retourne les Widgets sp\u00e9cifiques \u00e0 l'univers g\u00e9olocalisation",
"operationId": "getWidgetsFleet",
"produces": [
"application/json"
],
"responses": {
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets/park": {
"get": {
"tags": [
"Widgets"
],
"summary": "Widget sp\u00e9cifique \u00e0 l'univers gestion de parc",
"description": "Retourne les Widgets sp\u00e9cifiques \u00e0 l'univers gestion de parc",
"operationId": "getWidgetsPark",
"produces": [
"application/json"
],
"responses": {
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
},
"/widgets/beepiz": {
"get": {
"tags": [
"Widgets"
],
"summary": "Widget sp\u00e9cifique \u00e0 l'univers beepiz",
"description": "Retourne les Widgets sp\u00e9cifiques \u00e0 l'univers beepiz",
"operationId": "getWidgetsBeepiz",
"produces": [
"application/json"
],
"responses": {
"404": {
"description": "Not found"
}
},
"security": [
{
"oauth2": []
},
{
"api_key": []
}
]
}
}
},
"definitions": {
"User": {
"required": [
"iduser",
"nom"
],
"properties": {
"iduser": {
"description": "Identifiant unique",
"type": "integer",
"example": "1"
},
"nom": {
"description": "Nom de l'utilisateur",
"type": "string",
"example": "John Doe"
},
"email": {
"description": "Email de l'utilisateur",
"type": "string",
"example": "john.doe@mail.com"
},
"tel": {
"description": "T\u00e9l\u00e9phone de l'utilisateur",
"type": "string",
"example": "**-**-**-**-**"
},
"client": {
"type": "array",
"items": {
"$ref": "#/definitions/Client"
}
}
},
"type": "object"
},
"ActionPoint": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": 2
},
"serial": {
"description": "N\u00b0 de s\u00e9rie de l'Action Point, format d\u00e9pendant du type de l'Action Point
\n * Formats attendus selon le type de l'Action Point :
`WIFI` AE:5D:4E:D9:7F:EE (6* 2 caract\u00e8res hexad\u00e9cimaux)
`iBeacon` 32 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux
`EddyStone` 20 caract\u00e8res hexad\u00e9cimaux : 12 caract\u00e8res hexad\u00e9cimaux
`NFC` jusqu'\u00e0 32 caract\u00e8res hexad\u00e9cimaux
`QRCode` jusqu'\u00e0 64 caract\u00e8res",
"type": "string",
"example": "A5:7E:DE:AB:5D:F8"
},
"name": {
"description": "Nom de l'Action Point",
"type": "string",
"example": "Child AP"
},
"comment": {
"description": "Commentaire",
"type": "string",
"example": "Lorem ipsum"
},
"notification": {
"description": "Notification",
"type": "string",
"example": "Lorem ipsum"
},
"type": {
"description": "Identifiant du type d'Action Point :
`1` WIFI - champs serial obligatoire
`2` iBeacon - champs serial obligatoire
`3` NFC - champs serial obligatoire
`4` QRCode - champs serial obligatoire
`5` EddyStone - champs serial obligatoire
`6` Zone - champs serial laiss\u00e9 vide
`7` Groupe - champs serial laiss\u00e9 vide ",
"type": "integer",
"example": 1
},
"picture": {
"description": "image de l'action point cod\u00e9e en base64",
"type": "string",
"example": ""
}
},
"type": "object"
},
"ActionPointWithCoordinates": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": 2
},
"serial": {
"description": "N\u00b0 de s\u00e9rie de l'Action Point, format d\u00e9pendant du type de l'Action Point
\n * Formats attendus selon le type de l'Action Point :
`WIFI` AE:5D:4E:D9:7F:EE (6* 2 caract\u00e8res hexad\u00e9cimaux)
`iBeacon` 32 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux
`EddyStone` 20 caract\u00e8res hexad\u00e9cimaux : 12 caract\u00e8res hexad\u00e9cimaux
`NFC` jusqu'\u00e0 32 caract\u00e8res hexad\u00e9cimaux
`QRCode` jusqu'\u00e0 64 caract\u00e8res",
"type": "string",
"example": "A5:7E:DE:AB:5D:F8"
},
"name": {
"description": "Nom de l'Action Point",
"type": "string",
"example": "Child AP"
},
"comment": {
"description": "Commentaire",
"type": "string",
"example": "Lorem ipsum"
},
"notification": {
"description": "Notification",
"type": "string",
"example": "Lorem ipsum"
},
"type": {
"description": "Identifiant du type d'Action Point :
`1` WIFI - champs serial obligatoire
`2` iBeacon - champs serial obligatoire
`3` NFC - champs serial obligatoire
`4` QRCode - champs serial obligatoire
`5` EddyStone - champs serial obligatoire
`6` Zone - champs serial laiss\u00e9 vide
`7` Groupe - champs serial laiss\u00e9 vide ",
"type": "integer",
"example": 1
},
"x": {
"description": "Position x du point",
"type": "number",
"example": 0.2
},
"y": {
"description": "Position y du point",
"type": "number",
"example": -0.3
}
},
"type": "object"
},
"ActionPointWithPlans": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": 2
},
"serial": {
"description": "N\u00b0 de s\u00e9rie de l'Action Point, format d\u00e9pendant du type de l'Action Point
\n * Formats attendus selon le type de l'Action Point :
`WIFI` AE:5D:4E:D9:7F:EE (6* 2 caract\u00e8res hexad\u00e9cimaux)
`iBeacon` 32 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux
`EddyStone` 20 caract\u00e8res hexad\u00e9cimaux : 12 caract\u00e8res hexad\u00e9cimaux
`NFC` jusqu'\u00e0 32 caract\u00e8res hexad\u00e9cimaux
`QRCode` jusqu'\u00e0 64 caract\u00e8res",
"type": "string",
"example": "A5:7E:DE:AB:5D:F8"
},
"name": {
"description": "Nom de l'Action Point",
"type": "string",
"example": "Child AP"
},
"comment": {
"description": "Commentaire",
"type": "string",
"example": "Lorem ipsum"
},
"notification": {
"description": "Notification",
"type": "string",
"example": "Lorem ipsum"
},
"type": {
"description": "Identifiant du type d'Action Point :
`1` WIFI - champs serial obligatoire
`2` iBeacon - champs serial obligatoire
`3` NFC - champs serial obligatoire
`4` QRCode - champs serial obligatoire
`5` EddyStone - champs serial obligatoire
`6` Zone - champs serial laiss\u00e9 vide
`7` Groupe - champs serial laiss\u00e9 vide ",
"type": "integer",
"example": 1
},
"picture": {
"description": "image de l'action point cod\u00e9e en base64",
"type": "string",
"example": ""
},
"plans": {
"type": "array",
"items": {
"$ref": "#/definitions/PlanEntity"
}
}
},
"type": "object"
},
"ActionPointTree": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": 1
},
"serial": {
"description": "N\u00b0 de s\u00e9rie de l'Action Point, format d\u00e9pendant du type de l'Action Point
\n * Formats attendus selon le type de l'Action Point :
`WIFI` AE:5D:4E:D9:7F:EE (6* 2 caract\u00e8res hexad\u00e9cimaux)
`iBeacon` 32 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux : 4 caract\u00e8res hexad\u00e9cimaux
`EddyStone` 20 caract\u00e8res hexad\u00e9cimaux : 12 caract\u00e8res hexad\u00e9cimaux
`NFC` jusqu'\u00e0 32 caract\u00e8res hexad\u00e9cimaux
`QRCode` jusqu'\u00e0 64 caract\u00e8res",
"type": "string",
"example": "A5:7E:DE:AB:5D:F8"
},
"name": {
"description": "Nom de l'Action Point",
"type": "string",
"example": "AP1"
},
"comment": {
"description": "Commentaire",
"type": "string",
"example": "Lorem ipsum"
},
"notification": {
"description": "Notification",
"type": "string",
"example": "Lorem ipsum"
},
"type": {
"description": "Identifiant du type d'Action Point :
`1` WIFI - champs serial obligatoire
`2` iBeacon - champs serial obligatoire
`3` NFC - champs serial obligatoire
`4` QRCode - champs serial obligatoire
`5` EddyStone - champs serial obligatoire
`6` Zone - champs serial laiss\u00e9 vide
`7` Groupe - champs serial laiss\u00e9 vide ",
"type": "integer",
"example": 6
},
"x": {
"description": "Position x du point",
"type": "number",
"example": 1
},
"y": {
"description": "Position y du point",
"type": "number",
"example": 1
},
"polygon": {
"description": "Coordonn\u00e9es d'un polygone pour un Action Point de type zone",
"type": "string",
"example": "[[ [0.2,-0.2],[0.5,-1.05],[-0.3,0.8] ]]"
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/ActionPoint"
}
}
},
"type": "object"
},
"apType": {
"required": [
"id",
"name",
"zone"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"example": "1"
},
"name": {
"description": "Nom du type d'Action Point",
"type": "string",
"example": "Wifi"
},
"zone": {
"description": "Port\u00e9e du signal de l'Action Point",
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"Dati": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du Dati",
"type": "string",
"example": "Dati n\u00b01"
},
"imei": {
"description": "N\u00b0 Imei du Dati",
"type": "string",
"example": "123-654-789"
},
"version": {
"description": "Version de l'application",
"type": "string",
"example": "0.1"
},
"gcm": {
"description": "Syst\u00e8me d'exploitation du Dati",
"type": "string",
"example": ""
},
"clientId": {
"description": "Identifiant du client",
"type": "integer",
"example": 1
},
"groupId": {
"description": "Identifiant du groupe de Datis auquel le dati appartient",
"type": "integer",
"example": 1
},
"deviceOs": {
"description": "Syst\u00e8me d'exploitation du Dati",
"type": "string",
"example": "Andro\u00efd"
},
"deviceOsModel": {
"description": "Version de l'os",
"type": "string",
"example": "6.0.1"
},
"deviceManufacturer": {
"description": "Fabricant du dati",
"type": "string",
"example": "Sony"
},
"deviceModel": {
"description": "Mod\u00e8le du dati",
"type": "string",
"example": "Xp\u00e9ria"
},
"slot1SimCarrier": {
"description": "Op\u00e9rateur du slot 1 du dati",
"type": "string",
"example": "SFR"
},
"slot2SimCarrier": {
"description": "Op\u00e9rateur du slot 2 du dati",
"type": "string",
"example": "SFR"
},
"slot1PhoneNumber": {
"description": "N\u00b0 de t\u00e9l\u00e9phone du slot 1 du dati",
"type": "string",
"example": "0606060606"
},
"slot2PhoneNumber": {
"description": "N\u00b0 de t\u00e9l\u00e9phone du slot 2 du dati",
"type": "string",
"example": "0606060606"
},
"status": {
"description": "Status d'enregistrement du dati :
`0` Licence disponible
`1` Invitation envoy\u00e9e au Dati
`2` Dati enregistr\u00e9 aupr\u00e8s d'une licence
`3` Invitation expir\u00e9e",
"type": "integer",
"example": 2
},
"profile": {
"properties": {
"id": {
"description": "Identifiant unique du profil",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du Profil",
"type": "string",
"example": "Profil par d\u00e9faut"
},
"icon": {
"description": "Icon font awesome",
"type": "string",
"example": "id-badge"
},
"hash": {
"description": "Hash unique du profile",
"type": "string",
"example": "4b9724534e019c037bcd2a8412a1015d1b960a13"
}
},
"type": "object"
}
},
"type": "object"
},
"DatiWithRegistration": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du Dati",
"type": "string",
"example": "Dati n\u00b01"
},
"imei": {
"description": "N\u00b0 Imei du Dati",
"type": "string",
"example": "123-654-789"
},
"version": {
"description": "Version de l'application",
"type": "string",
"example": "0.1"
},
"gcm": {
"description": "Syst\u00e8me d'exploitation du Dati",
"type": "string",
"example": ""
},
"clientId": {
"description": "Identifiant du client",
"type": "integer",
"example": 1
},
"groupId": {
"description": "Identifiant du groupe de Datis auquel le dati appartient",
"type": "integer",
"example": 1
},
"deviceOs": {
"description": "Syst\u00e8me d'exploitation du Dati",
"type": "string",
"example": "Andro\u00efd"
},
"deviceOsModel": {
"description": "Version de l'os",
"type": "string",
"example": "6.0.1"
},
"deviceManufacturer": {
"description": "Fabricant du dati",
"type": "string",
"example": "Sony"
},
"deviceModel": {
"description": "Mod\u00e8le du dati",
"type": "string",
"example": "Xp\u00e9ria"
},
"slot1SimCarrier": {
"description": "Op\u00e9rateur du slot 1 du dati",
"type": "string",
"example": "SFR"
},
"slot2SimCarrier": {
"description": "Op\u00e9rateur du slot 2 du dati",
"type": "string",
"example": "SFR"
},
"slot1PhoneNumber": {
"description": "N\u00b0 de t\u00e9l\u00e9phone du slot 1 du dati",
"type": "string",
"example": "0606060606"
},
"slot2PhoneNumber": {
"description": "N\u00b0 de t\u00e9l\u00e9phone du slot 2 du dati",
"type": "string",
"example": "0606060606"
},
"status": {
"description": "Status d'enregistrement du dati :
`0` Licence disponible
`1` Invitation envoy\u00e9e au Dati
`2` Dati enregistr\u00e9 aupr\u00e8s d'une licence
`3` Invitation expir\u00e9e",
"type": "integer",
"example": 2
},
"profile": {
"properties": {
"id": {
"description": "Identifiant unique du profil",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du Profil",
"type": "string",
"example": "Profil par d\u00e9faut"
},
"icon": {
"description": "Icon font awesome",
"type": "string",
"example": "id-badge"
},
"hash": {
"description": "Hash unique du profile",
"type": "string",
"example": "4b9724534e019c037bcd2a8412a1015d1b960a13"
}
},
"type": "object"
},
"registration": {
"properties": {
"id": {
"description": "Identifiant unique de la demande d'enregistrement",
"type": "integer",
"example": 177
},
"datiId": {
"description": "Identifiant du Dati li\u00e9 \u00e0 l'enregistrement",
"type": "integer",
"example": 1
},
"hash": {
"description": "Hash de l'invitation",
"type": "string",
"example": "id-c2006800c8f83692032cfeba56ede0784ca4b680"
},
"liveUntil": {
"description": "Date limite de validit\u00e9 de l'invitation",
"type": "string",
"example": "2017-08-21 13:51:20"
},
"recipient": {
"description": "",
"type": "string",
"example": ""
},
"shortLink": {
"description": "Lien persistant vers l'application Beepiz",
"type": "string",
"example": "https://bup2x.app.goo.gl/Af8D"
}
},
"type": "object"
}
},
"type": "object"
},
"Events": {
"properties": {
"id": {
"description": "Identifiant unique de l'event",
"type": "integer",
"example": 5310
},
"remoteId": {
"description": "Identifiant unique de session g\u00e9n\u00e9r\u00e9 par la balise Dati",
"type": "integer",
"example": 825
},
"type": {
"description": "Identifiant du type d'event",
"type": "integer",
"example": 10
},
"datId": {
"description": "Identifiant du Dati ayant envoy\u00e9 l'event",
"type": "integer",
"example": 1
},
"datiSessionId": {
"description": "Identifiant de la session \u00e0 laquelle appartient l'event",
"type": "integer",
"example": 130
},
"identificationId": {
"description": "Identifiant de la carte d'identification \u00e0 laquelle l'event est li\u00e9",
"type": "integer",
"example": ""
},
"gpsX": {
"description": "longitude donn\u00e9e par le gps",
"type": "float",
"example": 0
},
"gpsY": {
"description": "lattitude donn\u00e9e par le gps",
"type": "float",
"example": 0
},
"gpsAccuracy": {
"description": "pr\u00e9cision du gps en m\u00e8tre",
"type": "float",
"example": 10000
},
"gpsAt": {
"type": "object",
"$ref": "#/definitions/Datetime"
},
"eventAt": {
"type": "object",
"$ref": "#/definitions/Datetime"
},
"sentAt": {
"type": "object",
"$ref": "#/definitions/Datetime"
},
"receivedAt": {
"type": "object",
"$ref": "#/definitions/Datetime"
},
"battery": {
"description": "Niveau de batterie restante en %",
"type": "integer",
"example": 70
},
"name": {
"description": "Nom du type d'event",
"type": "string",
"example": "D\u00e9marrage surveillance"
},
"icon": {
"description": "icon class",
"type": "string",
"example": ""
},
"eventCategory": {
"description": "Cat\u00e9gorie de l'event",
"type": "integer",
"example": 2
},
"dati": {
"type": "object",
"$ref": "#/definitions/Dati"
}
},
"type": "object"
},
"Datetime": {
"properties": {
"date": {
"description": "",
"type": "datetime",
"example": ""
},
"timezone_type": {
"description": "",
"type": "integer",
"example": ""
},
"timezone": {
"description": "",
"type": "string",
"example": ""
}
},
"type": "object"
},
"Group_beepiz": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Identifiant unique du groupe",
"type": "integer",
"readOnly": true,
"example": 1
},
"name": {
"description": "Nom du groupe",
"type": "string",
"example": "Groupe R\u00e9gion Centre"
},
"count": {
"description": "Nombre de Dati rattach\u00e9 \u00e0 ce groupe",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"Identification": {
"required": [
"id",
"name",
"serial"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": "1"
},
"serial": {
"description": "N\u00b0 de s\u00e9rie de la carte d'identification",
"type": "string",
"maxLength": 64,
"example": "123-456-789"
},
"name": {
"description": "Nom de la carte d'identification",
"type": "string",
"maxLength": 64,
"minLength": 1,
"example": "carte 1"
},
"language": {
"description": "Langue du porteur de la carte :
`fr` Fran\u00e7ais
`en` Anglais
`pt` Portugais
`ar` Arabe",
"type": "string",
"maxLength": 5,
"example": "fr"
},
"comment": {
"description": "Commentaire",
"type": "string",
"maxLength": 512,
"example": "Lorem ipsum"
},
"picture": {
"description": "Photo li\u00e9e \u00e0 la carte d'identification cod\u00e9e en base64.",
"type": "string",
"example": ""
}
},
"type": "object"
},
"Contacts": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Identifiant unique du contact",
"type": "integer",
"readOnly": true,
"example": "1"
},
"name": {
"description": "Nom du contact",
"type": "string",
"example": "John Doe"
},
"phone": {
"description": "N\u00b0 de t\u00e9l\u00e9phone",
"type": "string",
"example": "06.06.06.06.06"
},
"version": {
"description": "Version du phonebook",
"type": "integer",
"example": 4
}
},
"type": "object"
},
"Phonebooks": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Identifiant unique du phonebook",
"type": "integer",
"readOnly": true,
"example": 1
},
"name": {
"description": "Nom du phonebook",
"type": "string",
"example": "Annuaire n\u00b01"
},
"count": {
"description": "Nombre de contacts",
"type": "integer",
"example": 10
}
},
"type": "object"
},
"PhonebookWithContacts": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Identifiant unique du phonebook",
"type": "integer",
"readOnly": true,
"example": 1
},
"name": {
"description": "Nom du phonebook",
"type": "string",
"example": "Annuaire n\u00b01"
},
"count": {
"description": "Nombre de contacts",
"type": "integer",
"example": 10
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/definitions/Contacts"
}
}
},
"type": "object"
},
"PlanEntity": {
"required": [
"id",
"type",
"name",
"parentId"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": 102
},
"type": {
"description": "Identifiant du type de plan :
`1` : Root(Type abstrait propre \u00e0 chaque client Beepiz)
`2` : Site
`3` : Secteur
`4` : B\u00e2timent
`5` : Etage
`6` : Service
`7` : Plan",
"type": "integer",
"example": 7
},
"name": {
"description": "Nom du Plan",
"type": "string",
"example": "Plan du 1er \u00e9tage"
},
"parentId": {
"description": "Identifiant du 'p\u00e8re' du plan dans l'arborescence",
"type": "integer",
"example": 101
},
"brotherOrder": {
"description": "Position du plan par rapport \u00e0 ses 'fr\u00e8res' dans l'arborescence",
"type": "integer",
"example": 1
},
"pathOrder": {
"description": "Chemin du plan de la racine de l'arborescence jusqu'au parentId",
"type": "string",
"example": "100,101"
},
"where": {
"$ref": "#/definitions/Address"
},
"zoom": {
"description": "Niveau de zoom pour les plans rattach\u00e9s \u00e0 une carte ou \u00e0 une image de plan",
"type": "float",
"example": 10.25865
},
"polygon": {
"description": "Tra\u00e7age d'un polygone sur une carte ou une image de plan",
"type": "string",
"example": "[[ [1.388,2.506], [1.503,2.654], [3.52,1.987] ]]"
}
},
"type": "object"
},
"PlanEntityWithPlan": {
"required": [
"id",
"type",
"name",
"parentId"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": 102
},
"type": {
"description": "Identifiant du type de plan :
`1` : Root(Type abstrait propre \u00e0 chaque client Beepiz)
`2` : Site
`3` : Secteur
`4` : B\u00e2timent
`5` : Etage
`6` : Service
`7` : Plan",
"type": "integer",
"example": 7
},
"name": {
"description": "Nom du Plan",
"type": "string",
"example": "Plan du 1er \u00e9tage"
},
"parentId": {
"description": "Identifiant du 'p\u00e8re' du plan dans l'arborescence",
"type": "integer",
"example": 101
},
"brotherOrder": {
"description": "Position du plan par rapport \u00e0 ses 'fr\u00e8res' dans l'arborescence",
"type": "integer",
"example": 1
},
"pathOrder": {
"description": "Chemin du plan de la racine de l'arborescence jusqu'au parentId",
"type": "string",
"example": "100,101"
},
"where": {
"$ref": "#/definitions/Address"
},
"zoom": {
"description": "Niveau de zoom pour les plans rattach\u00e9s \u00e0 une carte ou \u00e0 une image de plan",
"type": "float",
"example": 10.25865
},
"polygon": {
"description": "Tra\u00e7age d'un polygone sur une carte ou une image de plan",
"type": "string",
"example": "[[ [1.388,2.506], [1.503,2.654], [3.52,1.987] ]]"
},
"plan": {
"description": "Image associ\u00e9e au PlanEntity cod\u00e9e en base64",
"type": "string"
}
},
"type": "object"
},
"PlanEntityWithChildren": {
"required": [
"id",
"type",
"name",
"parentId"
],
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"readOnly": true,
"example": 101
},
"type": {
"description": "Identifiant du type de plan :
`1` : Root(Type abstrait propre \u00e0 chaque client Beepiz)
`2` : Site
`3` : Secteur
`4` : B\u00e2timent
`5` : Etage
`6` : Service
`7` : Plan",
"type": "integer",
"example": 5
},
"name": {
"description": "Nom du Plan",
"type": "string",
"example": "1er \u00e9tage"
},
"parentId": {
"description": "Identifiant du 'p\u00e8re' du plan dans l'arborescence",
"type": "integer",
"example": 100
},
"brotherOrder": {
"description": "Position du plan par rapport \u00e0 ses 'fr\u00e8res' dans l'arborescence",
"type": "integer",
"example": 1
},
"pathOrder": {
"description": "Chemin du plan de la racine de l'arborescence jusqu'au parentId",
"type": "string",
"example": "100"
},
"where": {
"$ref": "#/definitions/Address"
},
"zoom": {
"description": "Niveau de zoom pour les plans rattach\u00e9s \u00e0 une carte ou \u00e0 une image de plan",
"type": "float",
"example": 10.25865
},
"polygon": {
"description": "Tra\u00e7age d'un polygone sur une carte ou une image de plan",
"type": "string",
"example": "[[ [1.388,2.506], [1.503,2.654], [3.52,1.987] ]]"
},
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/PlanEntity"
}
}
},
"type": "object"
},
"ShortProfile": {
"properties": {
"id": {
"description": "Identifiant unique",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du Profil",
"type": "string",
"example": "Profil par d\u00e9faut"
},
"icon": {
"description": "Icon font awesome",
"type": "string",
"example": "id-badge"
},
"hash": {
"description": "Hash unique du profile",
"type": "string",
"example": "4b9724534e019c037bcd2a8412a1015d1b960a13"
}
},
"type": "object"
},
"Client": {
"required": [
"id",
"nom"
],
"properties": {
"idclient": {
"description": "Identifiant unique",
"type": "integer",
"example": "1"
},
"nom": {
"description": "Nom du client",
"type": "string",
"example": "John Doe"
},
"telephone": {
"description": "T\u00e9l\u00e9phone du client",
"type": "string",
"example": "**-**-**-**-**"
}
},
"type": "object",
"xml": {
"name": "client"
}
},
"Point": {
"required": [
"lng",
"lat"
],
"properties": {
"lng": {
"type": "float",
"example": 0.69313
},
"lat": {
"type": "float",
"example": 47.41985
}
},
"type": "object"
},
"Address": {
"required": [
"point"
],
"properties": {
"address": {
"required": [
"street",
"city",
"zip"
],
"properties": {
"street": {
"type": "string",
"example": "178 avenue andr\u00e9 maginot"
},
"city": {
"type": "string",
"example": "Tours"
},
"zip": {
"type": "string",
"example": "37100"
}
},
"type": "object"
},
"point": {
"$ref": "#/definitions/Point"
}
},
"type": "object"
},
"Location": {
"required": [
"point"
],
"type": "object",
"allOf": [
{
"properties": {
"poi": {
"description": "Informations basique sur Point d'int\u00e9r\u00eat. Si `poi` est d\u00e9finit, `address` l'est aussi.",
"required": [
"id",
"name",
"category"
],
"properties": {
"id": {
"type": "integer",
"example": 1756
},
"name": {
"type": "string",
"example": "Nom du POI"
},
"category": {
"$ref": "#/definitions/PoiCategory"
}
},
"type": "object"
}
}
},
{
"$ref": "#/definitions/Address"
}
]
},
"Position": {
"required": [
"when",
"where"
],
"properties": {
"when": {
"type": "datetime",
"example": "2017-06-06 17:00:00"
},
"where": {
"$ref": "#/definitions/Location"
}
},
"type": "object"
},
"Wait": {
"required": [
"when",
"where"
],
"properties": {
"duration": {
"description": "Temps d'attente en secondes",
"type": "int",
"example": 60
},
"when": {
"type": "datetime",
"example": "2017-06-06 17:00:00"
},
"where": {
"$ref": "#/definitions/Location"
}
},
"type": "object"
},
"Slot": {
"properties": {
"slot_sim_subscription_id": {
"description": "Id de subscription",
"type": "string",
"example": "1"
},
"slot_sim_iccid": {
"description": "Information carte Sim",
"type": "string",
"example": ""
},
"slot_sim_carrier": {
"description": "Op\u00e9rateur t\u00e9l\u00e9phonique",
"type": "string",
"example": ""
},
"slot_phone_number": {
"description": "Num\u00e9ro de t\u00e9l\u00e9phone",
"type": "string",
"example": "06.06.06.06.06"
}
},
"type": "object"
},
"Registration": {
"required": [
"dati_id",
"status",
"live_until",
"hash"
],
"properties": {
"dati_id": {
"description": "Id du dati",
"type": "integer",
"example": 1
},
"status": {
"description": "Information carte Sim",
"type": "integer",
"example": 1
},
"live_until": {
"description": "Validit\u00e9 du lien pour synchronisation du Dati \u00e0 une licence",
"type": "datetime",
"example": "2017-07-17 10:52:25"
},
"recipient": {
"description": "T\u00e9l\u00e9phone ou mail o\u00f9 envoyer le lien de t\u00e9l\u00e9chargement de l'application",
"type": "string",
"example": "06.06.06.06.06"
},
"hash": {
"description": "Cl\u00e9 unique",
"type": "string",
"example": ""
},
"short_link": {
"description": "Lien pour t\u00e9l\u00e9chargement de l'appli",
"type": "string",
"example": "https://bup2x.app.goo.gl/GZt2"
}
},
"type": "object"
},
"State": {
"required": [
"dati_id",
"status",
"live_until",
"hash"
],
"properties": {
"id": {
"description": "Id du dati",
"type": "integer",
"example": 1
},
"activity_at": {
"description": "date de la derni\u00e8re activit\u00e9 du dati",
"type": "datetime",
"example": "2017-09-01 17:30:00"
},
"datiSession_id": {
"description": "Identifiant de la session en cours si le dati est en surveillance",
"type": "integer",
"example": 12
},
"datiSession_start_at": {
"description": "Date de d\u00e9marrage de la session en cours",
"type": "datetime",
"example": "2017-09-01 17:25:30"
},
"identification_id": {
"description": "Id d'une carte d'identification si l'utilisateur du Dati l'a li\u00e9 \u00e0 sa session de surveillance",
"type": "integer",
"example": 2
},
"gps_x": {
"description": "derni\u00e8re longitude transmise par le gps du Dati",
"type": "float",
"example": 0.69307
},
"gps_y": {
"description": "derni\u00e8re lattitude transmise par le gps du Dati",
"type": "floet",
"example": 41.41944
},
"gps_accuracy": {
"description": "niveau de pr\u00e9cision du gps en m\u00e8tres",
"type": "float",
"example": 20
},
"gps_at": {
"description": "Date et heure de la derni\u00e8re remont\u00e9e d'information du gps",
"type": "datetime",
"example": "2017-09-01 17:29:45"
},
"battery": {
"description": "Niveau de batterie du Dati en %",
"type": "integer",
"example": 95
},
"inhibition_immobility": {
"description": "inhibition de l'utilisateur du Dati des alertes d'immobilit\u00e9",
"type": "boolean",
"example": 0
},
"inhibition_fall": {
"description": "inhibition de l'utilisateur du Dati des alertes de chute",
"type": "boolean",
"example": 0
},
"inhibition_verticality": {
"description": "inhibition de l'utilisateur du Dati des alertes de perte de verticalit\u00e9",
"type": "boolean",
"example": 0
},
"lost_com_at": {
"description": "Si aucune activit\u00e9 du Dati n'est remont\u00e9e pendant plus de 5 minutes, ce champ est renseign\u00e9 pour permettre d'alerter le superviseur.",
"type": "datetime"
}
},
"type": "object"
},
"ShortProfileIndex": {
"properties": {
"profileId": {
"description": "Identifiant du profil",
"type": "integer",
"example": 1
},
"meta": {
"properties": {
"name": {
"description": "Nom du profil",
"type": "string",
"example": "Profil par d\u00e9faut"
},
"description": {
"description": "Description du profil",
"type": "string",
"example": ""
},
"default": {
"description": "Boolean d\u00e9terminant si le profil est le profil par d\u00e9faut(un client ne peut avoir qu'un seul profil par d\u00e9faut)",
"type": "boolean",
"example": 1
},
"hash": {
"description": "Hash unique repr\u00e9sentant le profil",
"type": "string",
"example": "4b9724534e019c037bcd2a8412a1015d1b960a13"
},
"icon": {
"description": "Icone de type font awesome",
"type": "string",
"example": "fa-amazon"
}
},
"type": "object"
},
"count": {
"description": "Nombre de Datis ayant ce profil affect\u00e9.",
"type": "integer",
"example": 3
}
},
"type": "object"
},
"ProfileWithProfileItems": {
"properties": {
"profileId": {
"description": "Identifiant du profil",
"type": "integer",
"example": 1
},
"config": {
"properties": {
"mode": {
"description": "Mode d'allumage du Dati",
"type": "object",
"$ref": "#/definitions/ProfileItemValuesModeList"
},
"sos": {
"description": "Configuration du mode alerte SOS",
"properties": {
"on": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"delay": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"alert": {
"properties": {
"vibrator": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"flash": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"sound": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"photo": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
}
},
"type": "object"
}
},
"type": "object"
},
"aggression": {
"description": "Configuration du mode alerte Agression",
"properties": {
"on": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"delay": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"alert": {
"properties": {
"vibrator": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"flash": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"sound": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"photo": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
}
},
"type": "object"
}
},
"type": "object"
},
"verticality": {
"properties": {
"on": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"delay": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"initpos": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesInitPos"
},
"flip": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"duration": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"alert": {
"properties": {
"vibrator": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"flash": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"sound": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"photo": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
}
},
"type": "object"
}
},
"type": "object"
},
"immo": {
"properties": {
"on": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"delay": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"tolerance": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"duration": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"alert": {
"properties": {
"vibrator": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"flash": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"sound": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"photo": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
}
},
"type": "object"
}
},
"type": "object"
},
"fall": {
"properties": {
"on": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"delay": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"duration": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"alert": {
"properties": {
"vibrator": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"flash": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"sound": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"photo": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
}
},
"type": "object"
}
},
"type": "object"
},
"lostcom": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"battery": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesMinMaxStep"
},
"wifi": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"gps": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"bt": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"nfc": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"email": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"sms": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"telesurveilleur": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"phone": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"phonebook_id": {
"properties": {
"type": {
"description": "",
"type": "string",
"example": "relation"
},
"description": {
"description": "",
"type": "string",
"example": "Identifiant annuaire t\u00e9l\u00e9phone"
},
"server_only": {
"description": "",
"type": "boolean",
"example": 0
},
"values": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/PhonebookList"
}
},
"default_value": {
"description": "",
"type": "integer",
"example": 0
},
"value": {
"description": "",
"type": "integer",
"example": 1
},
"unit": {
"description": "",
"type": "",
"example": ""
},
"created_at": {
"description": "",
"type": "datetime",
"example": "2017-07-01 09:05:00"
},
"required_appcode": {
"description": "",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"auto_offhook": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"dedicated_device": {
"type": "object",
"$ref": "#/definitions/ProfileItemValuesDedicatedDevice"
},
"allow_monitoring_inhibition": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
},
"vocal": {
"type": "object",
"$ref": "#/definitions/ProfileItem"
}
},
"type": "object"
},
"meta": {
"properties": {
"name": {
"description": "Nom du profil",
"type": "string",
"example": "Profil par d\u00e9faut"
},
"description": {
"description": "Description du profil",
"type": "string",
"example": ""
},
"default": {
"description": "Profil par d\u00e9faut ?(O/N)",
"type": "boolean",
"example": 1
},
"hash": {
"description": "Hash du profil",
"type": "string",
"example": "4b9724534e019c037bcd2a8412a1015d1b960a13"
},
"icon": {
"description": "Icone Font Awesome",
"type": "string",
"example": "fa-amazon"
}
},
"type": "object"
}
},
"type": "object"
},
"PhonebookList": {
"properties": {
"id": {
"description": "Identifiant de l'annuaire",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom de l'annuaire et nombre de contacts associ\u00e9s",
"type": "string",
"example": "Annuaire n\u00b01 (11 contact(s))"
}
},
"type": "object"
},
"ProfileItemValuesDedicatedDevice": {
"properties": {
"type": {
"description": "Type de donn\u00e9es de configuration (list, number, boolean...)",
"type": "string",
"example": "list"
},
"description": {
"description": "Description du module de configuration",
"type": "string",
"example": ""
},
"server_only": {
"description": "Module de configuration propre au serveur",
"type": "boolean",
"example": 0
},
"default_value": {
"description": "valeur par d\u00e9faut de ce module",
"type": "integer",
"example": 0
},
"value": {
"description": "valeur actuelle de ce module",
"type": "integer",
"example": 1
},
"unit": {
"description": "unit\u00e9 de valeur de la value (s=>seconde, m=>minutes...)",
"type": "string",
"example": "s"
},
"created_at": {
"description": "Date de cr\u00e9ation du module",
"type": "datetime",
"example": "2017-07-01 09:00:00"
},
"required_appcode": {
"description": "version minimale de l'application requise pour que ce module soit pris en compte",
"type": "integer",
"example": 1
},
"values": {
"type": "object",
"$ref": "#/definitions/ValuesDedicatedDevice"
}
},
"type": "object"
},
"ProfileItemValuesMinMaxStep": {
"properties": {
"type": {
"description": "Type de donn\u00e9es de configuration (list, number, boolean...)",
"type": "string",
"example": "list"
},
"description": {
"description": "Description du module de configuration",
"type": "string",
"example": ""
},
"server_only": {
"description": "Module de configuration propre au serveur",
"type": "boolean",
"example": 0
},
"default_value": {
"description": "valeur par d\u00e9faut de ce module",
"type": "integer",
"example": 0
},
"value": {
"description": "valeur actuelle de ce module",
"type": "integer",
"example": 1
},
"unit": {
"description": "unit\u00e9 de valeur de la value (s=>seconde, m=>minutes...)",
"type": "string",
"example": "s"
},
"created_at": {
"description": "Date de cr\u00e9ation du module",
"type": "datetime",
"example": "2017-07-01 09:00:00"
},
"required_appcode": {
"description": "version minimale de l'application requise pour que ce module soit pris en compte",
"type": "integer",
"example": 1
},
"values": {
"type": "object",
"$ref": "#/definitions/ValuesMinMaxStep"
}
},
"type": "object"
},
"ProfileItemValuesModeList": {
"properties": {
"type": {
"description": "Type de donn\u00e9es de configuration (list, number, boolean...)",
"type": "string",
"example": "list"
},
"description": {
"description": "Description du module de configuration",
"type": "string",
"example": ""
},
"server_only": {
"description": "Module de configuration propre au serveur",
"type": "boolean",
"example": 0
},
"default_value": {
"description": "valeur par d\u00e9faut de ce module",
"type": "integer",
"example": 0
},
"value": {
"description": "valeur actuelle de ce module",
"type": "integer",
"example": 30
},
"unit": {
"description": "unit\u00e9 de valeur de la value (s=>seconde, m=>minutes...)",
"type": "string",
"example": "s"
},
"created_at": {
"description": "Date de cr\u00e9ation du module",
"type": "datetime",
"example": "2017-07-01 09:00:00"
},
"required_appcode": {
"description": "version minimale de l'application requise pour que ce module soit pris en compte",
"type": "integer",
"example": 1
},
"values": {
"type": "object",
"$ref": "#/definitions/ValuesModeList"
}
},
"type": "object"
},
"ProfileItemValuesInitPos": {
"properties": {
"type": {
"description": "Type de donn\u00e9es de configuration (list, number, boolean...)",
"type": "string",
"example": "list"
},
"description": {
"description": "Description du module de configuration",
"type": "string",
"example": ""
},
"server_only": {
"description": "Module de configuration propre au serveur",
"type": "boolean",
"example": 0
},
"default_value": {
"description": "valeur par d\u00e9faut de ce module",
"type": "integer",
"example": 0
},
"value": {
"description": "valeur actuelle de ce module",
"type": "integer",
"example": 30
},
"unit": {
"description": "unit\u00e9 de valeur de la value (s=>seconde, m=>minutes...)",
"type": "string",
"example": "s"
},
"created_at": {
"description": "Date de cr\u00e9ation du module",
"type": "datetime",
"example": "2017-07-01 09:00:00"
},
"required_appcode": {
"description": "version minimale de l'application requise pour que ce module soit pris en compte",
"type": "integer",
"example": 1
},
"values": {
"type": "object",
"$ref": "#/definitions/ValuesInitPos"
}
},
"type": "object"
},
"ProfileItem": {
"properties": {
"type": {
"description": "Type de donn\u00e9es de configuration (list, number, boolean...)",
"type": "string",
"example": "list"
},
"description": {
"description": "Description du module de configuration",
"type": "string",
"example": ""
},
"server_only": {
"description": "Module de configuration propre au serveur",
"type": "boolean",
"example": 0
},
"default_value": {
"description": "valeur par d\u00e9faut de ce module",
"type": "integer",
"example": 0
},
"value": {
"description": "valeur actuelle de ce module",
"type": "integer",
"example": 30
},
"unit": {
"description": "unit\u00e9 de valeur de la value (s=>seconde, m=>minutes...)",
"type": "string",
"example": "s"
},
"created_at": {
"description": "Date de cr\u00e9ation du module",
"type": "datetime",
"example": "2017-07-01 09:00:00"
},
"required_appcode": {
"description": "version minimale de l'application requise pour que ce module soit pris en compte",
"type": "integer",
"example": 1
},
"values": []
},
"type": "object"
},
"ValuesMinMaxStep": {
"properties": {
"min": {
"description": "valeur minimum",
"type": "integer",
"example": 0
},
"max": {
"description": "valeur maximum",
"type": "integer",
"example": 300
},
"step": {
"description": "valeur du pas",
"type": "integer",
"example": 5
}
},
"type": "object"
},
"ValuesDedicatedDevice": {
"properties": {
"`0`": {
"description": "",
"type": "integer",
"example": "Mode application"
},
"`1`": {
"description": "",
"type": "integer",
"example": "Mode d\u00e9di\u00e9"
}
},
"type": "object"
},
"ValuesModeList": {
"properties": {
"1": {
"description": "D\u00e9marrage manuel",
"type": "string",
"example": "Manuel"
},
"2": {
"description": "D\u00e9marrage au d\u00e9branchement du Dati",
"type": "string",
"example": "D\u00e9branchement"
},
"3": {
"description": "Surveillance permanente",
"type": "string",
"example": "Permanent"
},
"4": {
"description": "D\u00e9marrage \u00e0 l'identification",
"type": "string",
"example": "Identification"
}
},
"type": "object"
},
"ValuesInitPos": {
"properties": {
"1": {
"description": "",
"type": "string",
"example": "Portrait"
},
"2": {
"description": "",
"type": "string",
"example": "Portrait invers\u00e9"
},
"3": {
"description": "",
"type": "string",
"example": "Paysage"
},
"4": {
"description": "",
"type": "string",
"example": "Paysage invers\u00e9"
}
},
"type": "object"
},
"DeviceConfig": {
"required": [
"privacyType"
],
"properties": {
"privacyType": {
"description": "Type de Pro/Priv\u00e9 dont est \u00e9quip\u00e9 le v\u00e9hicule :
`Null` Aucun syst\u00e8me d\u00e9clar\u00e9.
`1` Bouton Physique en mode switch.
`2` Bouton Physique en mode trajet.
`3` Logiciel : Mode Switch via l'application SuiviConducteur.
`4` Logiciel : Mode trajet via l'application SuiviConducteur.
`5` Mode SMS.",
"type": "integer",
"example": 4
}
},
"type": "object"
},
"DeviceState": {
"required": [
"lastActivity",
"lastEvent",
"status",
"where"
],
"properties": {
"lastActivity": {
"description": "Date de derni\u00e8re remont\u00e9e d'information",
"type": "datetime",
"example": "2017-06-06 17:00:00"
},
"lastEvent": {
"description": "Date de derni\u00e8re \u00e9vennement.
Si 'Arr\u00eat\u00e9' ou 'D\u00e9marr\u00e9' (status `0` ou `1`) : heure d'arret/de d\u00e9marrage.
Si 'En attente' (status `2`) : heure de d\u00e9but d'attente.
Si 'En priv\u00e9', Heure de passage en Priv\u00e9. Dans les autres cas, on retourne l'heure de derni\u00e8re activit\u00e9.",
"type": "datetime",
"example": "2017-06-06 17:00:00"
},
"angle": {
"description": "Orientation du v\u00e9hicule `[0-7]` : `0` Nord, `1`, Nord est, etc...",
"type": "integer",
"example": 3
},
"status": {
"description": "Etat du p\u00e9ripherique :
`0` Arr\u00eat\u00e9
`1` D\u00e9marr\u00e9
`2` En attente
`4` Travail (si chronotachygraphe)
`5` Dispo. (si chronotachygraphe)
`6` Repos (si chronotachygraphe)
`-1` Mode Vie priv\u00e9e actif
`-2` Hors r\u00e9seaux
`-3` D\u00e9connect\u00e9
`-4` En veille
`-5` Coupe batterie
`-6` R\u00e9cup\u00e9ration historique
Etats verrouill\u00e9s :
`99-1` Non mont\u00e9
`99-1-1` En attente de PV de montage
`99-2` En Maintenance
`99-3` Plus utilis\u00e9/A d\u00e9poser
`99-4` Contrat invalide",
"type": "string",
"example": "1"
},
"where": {
"$ref": "#/definitions/Location"
}
},
"type": "object"
},
"DeviceSimple": {
"required": [
"id",
"name",
"regPlate",
"icon"
],
"properties": {
"id": {
"type": "integer",
"example": 909
},
"name": {
"description": "Nom du v\u00e9hicule",
"type": "string",
"example": "Fred"
},
"regPlate": {
"description": "Plaque d'immatriculation",
"type": "string",
"example": "CB-45-AB"
},
"icon": {
"description": "Repr\u00e9sentation du p\u00e9riph\u00e9rique :
`1` PL
`2` VU
`3` VL
`4` Moto
`5` Mini-pelle
`6` Bus
`7` BOM
`8` Balayeuse
`9` Paysagiste
`10` Nacelle
`11` Personne
`12` Tracteur (PL)
`13` Grue
`14` Plateau
`15` Hydrocureur
`16` VU l\u00e9ger
`17` Remorque
`18` Balise
`19` T\u00e9l\u00e9sco.
`20` Nacelle
`21` V\u00e9lo
`22` Compresseur
`23` Secours.",
"type": "integer",
"example": 3
}
},
"type": "object"
},
"GPSPosition": {
"required": [
"position",
"speed",
"sats",
"heading",
"engine"
],
"properties": {
"position": {
"properties": {
"where": {
"description": "Position",
"type": "integer",
"$ref": "#/definitions/Point"
},
"when": {
"description": "Date heure de la position",
"type": "string",
"example": "2017-06-26 12:05:35"
}
}
},
"speed": {
"description": "Vitesse en km/h",
"type": "numeric",
"example": 90
},
"meters": {
"description": "Distance en m\u00e8tre",
"type": "numeric",
"example": 90
},
"sats": {
"description": "Nb de satellite en visualisation",
"type": "numeric",
"example": 5
},
"heading": {
"description": "Cap en \u00b0 (0-360)",
"type": "integer",
"example": 60
},
"engine": {
"description": "0 ou 1 indique si le moteur est allum\u00e9",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"Sensor": {
"required": [
"position",
"speed",
"sats",
"heading",
"engine"
],
"properties": {
"id": {
"description": "Identifiant du capteur",
"type": "integer",
"readOnly": true,
"example": 90
},
"familyId": {
"description": "Identifiant de la famille du capteur",
"type": "integer",
"example": 8
},
"name": {
"description": "Nom du capteur",
"type": "string",
"example": "Identification"
},
"labels": {
"properties": {
"on": {
"description": "Libelle lorsque le capteur est actif.",
"type": "string",
"example": "Identifi\u00e9"
},
"off": {
"description": "Libelle lorsque le capteur est inactif",
"type": "string",
"example": "Non identifi\u00e9"
}
}
},
"unit": {
"description": "",
"type": "integer",
"example": 60
}
},
"type": "object"
},
"pagination": {
"properties": {
"pagination": {
"properties": {
"total": {
"description": "Nombre total de r\u00e9sultats.",
"type": "int",
"example": 15
},
"count": {
"description": "Nombre d'\u00e9l\u00e9ments sur la page courante.",
"type": "int",
"example": 6
},
"per_page": {
"description": "Nombre d'\u00e9l\u00e9ments maximum par page.",
"type": "int",
"example": 6
},
"current_page": {
"description": "Num\u00e9ro de page courante.",
"type": "int",
"example": 2
},
"total_pages": {
"description": "Nombre total de pages",
"type": "int",
"example": 3
},
"links": {
"properties": {
"previous": {
"description": "URL de la page pr\u00e9c\u00e9dente.",
"type": "string",
"example": "https://api.suivideflotte.net/fleet/devices/?page=1"
},
"next": {
"description": "URL de la page suivante.",
"type": "string",
"example": "https://api.suivideflotte.net/fleet/devices/?page=3"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"Trip": {
"required": [
"tripID",
"drivingDuration",
"stopDuration",
"km",
"start",
"tracks",
"waits",
"isDriving",
"inPrivate"
],
"properties": {
"tripID": {
"type": "string",
"example": "17_32_56568"
},
"drivingDuration": {
"description": "Temps de conduite en secondes",
"type": "integer",
"example": 1223
},
"stopDuration": {
"description": "Temps d'arr\u00eat en secondes sur le lieu d'arr\u00eat `end`",
"type": "integer",
"example": 142
},
"km": {
"description": "Distance du trajet en kilom\u00e8tre",
"type": "number",
"example": 10.25
},
"start": {
"$ref": "#/definitions/Position"
},
"end": {
"$ref": "#/definitions/Position"
},
"tracks": {
"description": "Liste des positions composant le trajet",
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/Position"
}
},
"waits": {
"description": "Liste des attentes ayant eu lieu sur le trajet",
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/Wait"
}
},
"isDriving": {
"description": "Indique si le v\u00e9hicule est en train d'effectuer le trajet. Si true, `end` est sa position actuelle.",
"type": "boolean",
"example": false
},
"inPrivate": {
"description": "Indique si le trajet a \u00e9t\u00e9 fait en priv\u00e9. Si true, `tracks` et `waits` sont vides.",
"type": "boolean",
"example": false
}
},
"type": "object"
},
"SyntheseKmDetail": {
"required": [
"date",
"km",
"kmPrivate",
"workedDuration",
"workedTimeStart",
"workedTimeEnd",
"driveDuration",
"driveDurationInPrivate",
"waitDurationTotal",
"waitCount",
"stopDurationTotal",
"isConnected"
],
"properties": {
"date": {
"type": "string",
"example": "2017-06-12"
},
"km": {
"description": "Kilom\u00e9trage effectu\u00e9 dans la journ\u00e9e. Contient aussi les km fait en priv\u00e9.",
"type": "number",
"example": 100.25
},
"kmPrivate": {
"description": "Kilom\u00e9trage effectu\u00e9 en priv\u00e9 dans la journ\u00e9e.",
"type": "number",
"example": 100.25
},
"workedDuration": {
"description": "Amplitude de travail calcul\u00e9 en faisant Dernier Arr\u00eat - Premier d\u00e9marrage.",
"type": "int",
"example": 100
},
"workedTimeStart": {
"description": "Premier d\u00e9marrage de la journ\u00e9e",
"type": "string",
"example": "2017-06-12 08:00:00"
},
"workedTimeEnd": {
"description": "Dernier arr\u00eat de la journ\u00e9e.",
"type": "string",
"example": "2017-06-12 11:00:00"
},
"driveDuration": {
"description": "Temps de conduite effectu\u00e9 dans la journ\u00e9e.",
"type": "int",
"example": 600
},
"driveDurationInPrivate": {
"description": "Temps de conduite effectu\u00e9 en priv\u00e9 dans la journ\u00e9e.Contient aussi le temps de conduite fait en priv\u00e9.",
"type": "int",
"example": 600
},
"waitDurationTotal": {
"description": "Temps d'attente effectu\u00e9e dans la journ\u00e9e.",
"type": "int",
"example": 300
},
"waitCount": {
"description": "Nombre d'attente effectu\u00e9e dans la journ\u00e9e.",
"type": "int",
"example": 1
},
"stopDurationTotal": {
"description": "Temps d'arr\u00eat effectu\u00e9 dans la journ\u00e9e.",
"type": "int",
"example": 150
},
"isConnected": {
"description": "Si le v\u00e9hicule a transmis des informations \u00e0 SuiviDeFlotte.net alors ce champs sera \u00e9gale \u00e0 1 sinon il sera \u00e0 0.",
"type": "boolean",
"example": true
}
},
"type": "object"
},
"SyntheseKm": {
"required": [
"device",
"data"
],
"properties": {
"device": {
"type": "object",
"$ref": "#/definitions/DeviceSimple"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/SyntheseKmDetail"
}
}
},
"type": "object"
},
"WidgetData": {
"required": [
"labels",
"values",
"source"
],
"properties": {
"labels": {
"description": "Libell\u00e9s.",
"type": "array",
"items": {
"type": "string"
}
},
"values": {
"description": "Valeurs de la s\u00e9rie (tableau \u00e0 plusieurs dimensions si plusieurs s\u00e9ries sont d\u00e9finies).",
"type": "array",
"items": {
"type": "number"
}
},
"series": {
"description": "Nom des s\u00e9ries (\u00e0 pr\u00e9ciser uniquement si plusieurs s\u00e9ries sont d\u00e9finies dans `values[]`).",
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"type": "array",
"items": {
"properties": {
"url": {
"description": "url de chargement des donn\u00e9es.",
"type": "string"
},
"refresh": {
"description": "Temps en seconde de rafraichissement des donn\u00e9es.",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"Dashboard": {
"required": [
"device",
"data"
],
"properties": {
"widget": {
"type": "object",
"$ref": "#/definitions/Widget"
},
"data": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/WidgetData"
}
}
},
"type": "object"
},
"PoiEditable": {
"required": [],
"properties": {
"name": {
"type": "string"
},
"reference": {
"description": "R\u00e9f\u00e9rence client libre. Permet de liser un POI avec un identifiant de vos propres logiciels ou bases de donn\u00e9es.",
"type": "string"
},
"radius": {
"description": "Rayon de d\u00e9tection (Km)",
"type": "number",
"example": 0.05
},
"category": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 16
}
},
"type": "object"
},
"where": {
"required": [
"point"
],
"properties": {
"point": {
"required": [
"lng",
"lat"
],
"properties": {
"lng": {
"type": "number",
"example": 0.69545
},
"lat": {
"type": "number",
"example": 41.41545
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"web": {
"type": "string"
},
"fax": {
"type": "string"
},
"comment": {
"type": "string"
}
},
"type": "object"
},
"Badges": {
"required": [],
"properties": {
"id": {
"type": "integer"
},
"nom": {
"type": "string",
"example": "pierre dupond"
},
"cle": {
"type": "string",
"example": "AB12345"
},
"driver": {
"properties": {
"id": {
"type": "integer",
"example": 16
},
"name": {
"type": "string",
"example": "Pierre dupond"
}
},
"type": "object"
},
"type": {
"properties": {
"id": {
"type": "integer",
"example": 16
},
"name": {
"type": "string",
"example": "RFID"
}
},
"type": "object"
}
},
"type": "object"
},
"Driver": {
"required": [
"title",
"forname",
"name"
],
"properties": {
"id": {
"type": "integer",
"example": 18
},
"title": {
"type": "string",
"example": "M"
},
"name": {
"type": "string",
"example": "DUPONT"
},
"forname": {
"type": "string",
"example": "Robert"
},
"email": {
"type": "string",
"example": "r.dupond@exemple.fr"
},
"gsm": {
"type": "string",
"example": "0612345678"
},
"deviceId": {
"type": "integer",
"example": 21479
},
"modules": {
"description": "Liste des modules auquels le chauffeur a le droit d'acc\u00e9der.",
"properties": {
"location": {
"description": "True Si le chauffeur a le droit de visualiser sa position.",
"type": "boolean",
"example": true
},
"aroundMe": {
"description": "True Si le chauffeur a le droit de visualiser les poi autour de lui.",
"type": "boolean",
"example": true
},
"dailyReport": {
"description": "True Si le chauffeur a le droit de visualiser son rapport journalier.",
"type": "boolean",
"example": true
},
"ecoDrive": {
"description": "True Si le chauffeur a le droit de visualiser sa note \u00e9co-conduite.",
"type": "boolean",
"example": true
},
"poi": {
"properties": {
"view": {
"description": "True Si le chauffeur a le droit de visualiser les poi.",
"type": "boolean",
"example": true
},
"create": {
"description": "True Si le chauffeur a le droit de cr\u00e9er des poi.",
"type": "boolean",
"example": true
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"DriverPhoneFcm": {
"required": [
"androidId",
"appId",
"token"
],
"properties": {
"androidId": {
"description": "Identifiant du t\u00e9l\u00e9phone",
"type": "string",
"example": "789000aa8a766c29"
},
"appId": {
"description": "Identifiant de l'application",
"type": "integer",
"example": 27
},
"token": {
"description": "Token FCM",
"type": "string",
"example": "ePhr2ETQ4SY:APA91bEguUoOh7Vb89lttutqdoJv ... Wxj4-elLo02zNXc402Q50WcjgpiGXAfLJBzdV0vj0gJ8Jh"
}
},
"type": "object"
},
"DriverPhoneVersion": {
"required": [
"androidId",
"appId",
"version"
],
"properties": {
"androidId": {
"description": "Identifiant du t\u00e9l\u00e9phone",
"type": "string",
"example": "789000aa8a766c29"
},
"appId": {
"description": "Identifiant de l'application",
"type": "integer",
"example": 27
},
"version": {
"description": "Num\u00e9ro de version de l'application",
"type": "string",
"example": "1.1.1"
}
},
"type": "object"
},
"Device": {
"required": [
"id",
"name",
"icon",
"regPlate",
"groupId",
"type",
"config",
"state"
],
"type": "object",
"allOf": [
{
"$ref": "#/definitions/DeviceSimple"
},
{
"properties": {
"gsm": {
"description": "Num\u00e9ro de t\u00e9l\u00e9phone associ\u00e9",
"type": "string",
"example": "0645254512"
},
"email": {
"description": "Email associ\u00e9",
"type": "string",
"example": "nomprenom@email.com"
},
"groupId": {
"description": "Identifiant du groupe",
"type": "integer",
"example": 42
},
"type": {
"description": "Type de p\u00e9riph\u00e9rique :
`1` V\u00e9hicule
`2` Balise avec APC
`3` Balise sans APC
`4` Remorque",
"type": "integer",
"example": 1
},
"config": {
"$ref": "#/definitions/DeviceConfig"
},
"state": {
"$ref": "#/definitions/DeviceState"
}
}
}
]
},
"Group": {
"required": [
"id",
"name",
"count"
],
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "nom du groupe"
},
"count": {
"type": "integer",
"example": 12
}
},
"type": "object"
},
"GroupReadOnly": {
"required": [
"id",
"name",
"count",
"isOpen"
],
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Group"
},
{
"properties": {
"isOpen": {
"description": "Indique si le groupe est ouvert ou ferm\u00e9. True Indique que le groupe est ouvert sinon False.",
"type": "boolean"
}
}
}
]
},
"PoiCategory": {
"required": [
"id",
"name",
"count",
"icon"
],
"properties": {
"id": {
"type": "integer",
"example": 16
},
"name": {
"type": "string",
"example": "Ma Soci\u00e9t\u00e9"
},
"count": {
"type": "integer",
"example": 10
},
"icon": {
"type": "integer",
"example": 16
}
},
"type": "object"
},
"Poi": {
"required": [
"id",
"name",
"radius",
"category",
"where"
],
"properties": {
"id": {
"type": "integer",
"example": 3647
},
"name": {
"type": "string",
"example": "Si\u00e8ge SuiviDeFlotte.net"
},
"reference": {
"description": "R\u00e9f\u00e9rence client libre. Permet de liser un POI avec un identifiant de vos propres logiciels ou bases de donn\u00e9es.",
"type": "string"
},
"radius": {
"description": "Rayon de d\u00e9tection (Km)",
"type": "number"
},
"category": {
"$ref": "#/definitions/PoiCategory"
},
"where": {
"$ref": "#/definitions/Address"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"web": {
"type": "string",
"example": "https://www.suivideflotte.net"
},
"fax": {
"type": "string"
},
"comment": {
"type": "string"
}
},
"type": "object"
},
"Account": {
"required": [
"id",
"name",
"code",
"comment",
"phone",
"isProfessionnal",
"contacts"
],
"properties": {
"id": {
"description": "Identifiant du compte.",
"type": "integer",
"readOnly": true,
"example": 4
},
"name": {
"description": "Nom du compte.",
"type": "string",
"example": "SuiviDeFlotte.net"
},
"code": {
"description": "Code client dans votre syst\u00e8me informatique.",
"type": "string",
"example": "SDF2055"
},
"comment": {
"description": "Commentaire associ\u00e9 au compte.",
"type": "string",
"example": "Votre partenaire sp\u00e9cialis\u00e9 dans la g\u00e9olocalisation !"
},
"phone": {
"type": "string",
"example": "02410758"
},
"isProfessionnal": {
"description": "Ce compte est un professionnel (`true`) ou particulier (`false`).",
"type": "boolean",
"example": true
},
"where": {
"$ref": "#/definitions/Address"
}
},
"type": "object"
},
"Assignee": {
"required": [
"id",
"name",
"comment"
],
"properties": {
"id": {
"description": "Identifiant du personnel terrain.",
"type": "integer",
"readOnly": true,
"example": 4
},
"name": {
"description": "Nom du personnel terrain.",
"type": "string",
"example": "Dupont"
},
"comment": {
"description": "Commentaire assioci\u00e9 au personnel terrain.",
"type": "string",
"example": "Jean"
},
"group": {
"properties": {
"id": {
"description": "Identifiant du groupe associ\u00e9 au personnel terrain",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du groupe associ\u00e9 au personnel terrain",
"type": "string",
"readOnly": true,
"example": "Techniciens"
}
},
"type": "object"
}
},
"type": "object"
},
"Contact": {
"required": [
"id",
"gender",
"name",
"firstName\"fonction",
"email",
"phone",
"gsm"
],
"properties": {
"id": {
"description": "Identifiant du contact.",
"type": "integer",
"readOnly": true,
"example": 4
},
"gender": {
"description": "M. ou Mme",
"type": "string",
"example": "M."
},
"name": {
"description": "Nom du contact.",
"type": "string",
"example": "Dupont"
},
"firstName": {
"description": "Pr\u00e9nom du contact.",
"type": "string",
"example": "Jean"
},
"fonction": {
"type": "string",
"example": "Directeur"
},
"email": {
"type": "string",
"example": "dupont.jean@gmail.com"
},
"phone": {
"description": "T\u00e9l\u00e9phone fixe du contact.",
"type": "string",
"example": "02.47.41.07.58"
},
"gsm": {
"description": "T\u00e9l\u00e9phone portable du contact.",
"type": "string",
"example": "06.45.41.07.58"
}
},
"type": "object"
},
"GroupAssignee": {
"required": [
"id",
"name",
"createdAt",
"assignees"
],
"properties": {
"id": {
"description": "Identifiant du personnel terrain.",
"type": "integer",
"readOnly": true,
"example": 4
},
"name": {
"description": "Nom du personnel terrain.",
"type": "string",
"example": "Dupont"
},
"createdAt": {
"description": "Commentaire assioci\u00e9 au personnel terrain.",
"type": "string",
"example": "2017-04-05 12:12:00"
},
"assignees": {
"type": "array",
"items": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Identifiant du personnel terrain \u00e0 associ\u00e9.",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du personnel terrain \u00e0 associ\u00e9.",
"type": "string",
"readOnly": true,
"example": "jean paul"
}
},
"type": "object"
}
}
},
"type": "object"
},
"Message": {
"required": [
"id",
"subject",
"createdAt",
"assignees",
"transmitAt",
"readedAt"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 4
},
"summary": {
"type": "string",
"example": "titre du message"
},
"details": {
"type": "string",
"example": "corps du message"
},
"sendByUser": {
"description": "Identifiant de l'utilisateur ayant envoy\u00e9 le message. Vaut `null` si le message a \u00e9t\u00e9 envoy\u00e9 par le personnel terrain.",
"type": "integer",
"example": 80
},
"createdAt": {
"type": "string",
"readOnly": true,
"example": "2017-06-06 12:12:12"
},
"assignees": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Jean-Paul"
}
},
"type": "object"
}
},
"transmitAt": {
"description": "Date d'envoi du message. Peut \u00eatre null si le message n'a pas encore \u00e9t\u00e9 envoy\u00e9",
"type": "string",
"example": "2017-06-06 12:15:12"
},
"readedAt": {
"description": "Date de lecture du message. Peut-\u00eatre null si le message n'a pas encore \u00e9t\u00e9 lu.",
"type": "string",
"example": "2017-06-06 12:15:12"
}
},
"type": "object"
},
"Mission": {
"required": [
"id",
"summary",
"code",
"startAt",
"endAt",
"duration",
"details",
"isAllDay",
"isEditable",
"status",
"account",
"contact",
"assignee",
"where"
],
"properties": {
"id": {
"description": "Identifiant de la mission.",
"type": "integer",
"readOnly": true,
"example": 4
},
"summary": {
"description": "R\u00e9sum\u00e9 de la mission.",
"type": "string",
"example": "Intervention chaudi\u00e8re"
},
"code": {
"description": "Num\u00e9ro de mission.",
"type": "string",
"example": "0000874"
},
"startAt": {
"description": "D\u00e9but de la mission.",
"type": "string",
"example": "2017-06-15 14:07:00"
},
"endAt": {
"description": "Fin de la mission.",
"type": "string",
"example": "2017-06-15 15:07:00"
},
"duration": {
"description": "Dur\u00e9e en seconde de la mission.",
"type": "integer",
"example": 3600
},
"details": {
"description": "Description de la mission.",
"type": "string",
"example": "Depannez la chaudi\u00e8re de Mr Dupond"
},
"isAllDay": {
"description": "La mission dure-t-elle toute la journ\u00e9e ?",
"type": "boolean",
"example": false
},
"isEditable": {
"description": "La mission peut-t-elle \u00eatre modifi\u00e9 ?",
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"enum": [
"TO_PLAN",
"TO_CONFIRM",
"CONFIRMED",
"TO_DO",
"IN_PROGRESS",
"DONE",
"CANCELED"
]
},
"account": {
"properties": {
"id": {
"description": "Identifiant du compte.",
"type": "integer",
"example": 4
},
"name": {
"description": "Nom du compte.",
"type": "string",
"example": "SuiviDeFlotte.net"
},
"code": {
"description": "Code client dans votre syst\u00e8me informatique.",
"type": "string",
"example": "SDF2055"
},
"comment": {
"description": "Commentaire associ\u00e9 au compte.",
"type": "string",
"example": "Tr\u00e8s bonne soci\u00e9t\u00e9"
},
"phone": {
"type": "string",
"example": "02410758"
},
"isProfessionnal": {
"description": "Est-ce un compte professionnel ou particulier.",
"type": "boolean",
"example": false
}
},
"type": "object"
},
"attachments": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "Identifiant du compte.",
"type": "string",
"readOnly": true,
"example": "dd5445458797a878788f789"
},
"name": {
"description": "Nom de la pi\u00e8ce jointe.",
"type": "string",
"example": "SuiviDeFlotte.net"
},
"size": {
"description": "Taille en octet du fichier.",
"type": "integer",
"example": "123"
}
},
"type": "object"
},
"readOnly": true
},
"contact": {
"type": "object",
"$ref": "#/definitions/Contact"
},
"assignee": {
"type": "object",
"$ref": "#/definitions/Assignee"
},
"where": {
"type": "object",
"$ref": "#/definitions/Location"
}
},
"type": "object"
},
"GroupPark": {
"required": [
"idgroupe",
"idclient",
"name"
],
"properties": {
"idgroupe": {
"description": "Identifiant unique",
"type": "integer",
"example": 1
},
"idclient": {
"description": "Identifiant du client",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom du Groupe",
"type": "string",
"example": "Groupe JohnDoe"
},
"nbVehicles": {
"description": "Nombre de v\u00e9hicules rattach\u00e9s au groupe",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"Vehicle": {
"required": [
"id",
"name",
"registerAt",
"inAt",
"outAt",
"isServiceType",
"type",
"brand",
"model",
"version",
"contract"
],
"properties": {
"id": {
"description": "Identifiant du vehicule",
"type": "integer",
"readOnly": true,
"example": 512
},
"name": {
"description": "Immatriculation",
"type": "string",
"example": "1106WY73"
},
"registerAt": {
"description": "Date de la premi\u00e8re immatriculation du v\u00e9hicule",
"type": "string",
"example": "2006-06-06"
},
"inAt": {
"description": "Date d'entr\u00e9e du vehicule dans votre parc.",
"type": "string",
"example": "2006-08-06"
},
"outAt": {
"description": "Date de sortie du vehicule de votre parc.",
"type": "string",
"example": "2006-09-06"
},
"isServiceType": {
"description": "Est-ce un v\u00e9hicule de service ?",
"type": "boolean",
"example": true
},
"type": {
"description": "Type du v\u00e9hicule :
`VL`
`VU`
`PL`
`Machine`",
"type": "string",
"example": "VL"
},
"brand": {
"description": "Information sur la marque du v\u00e9hicule",
"properties": {
"id": {
"description": "Identifiant de la marque du v\u00e9hicule.",
"type": "integer",
"example": 1
},
"name": {
"description": "Nom de la marque du v\u00e9hicule.",
"type": "string",
"example": "Renault"
}
},
"type": "object"
},
"model": {
"description": "Information sur le mod\u00e8le du v\u00e9hicule",
"properties": {
"id": {
"description": "Identifiant du mod\u00e8le du v\u00e9hicule.",
"type": "integer",
"example": 72
},
"name": {
"description": "Nom du mod\u00e8le du v\u00e9hicule.",
"type": "string",
"example": "Clio"
}
},
"type": "object"
},
"version": {
"description": "Information sur la version du v\u00e9hicule",
"properties": {
"id": {
"description": "Identifiant de la version du v\u00e9hicule.",
"type": "integer",
"example": 1710
},
"name": {
"description": "Nom de la version du v\u00e9hicule.",
"type": "string",
"example": "CAMPUS BYE BYE 1.2 16V 75"
}
},
"type": "object"
},
"contract": {
"description": "Information sur le contrat du v\u00e9hicule",
"properties": {
"id": {
"description": "Identifiant",
"type": "integer",
"example": 1
},
"name": {
"description": "Numero du contrat.",
"type": "string",
"example": "ABO1214"
},
"startAt": {
"description": "Date de d\u00e9but du contrat.",
"type": "string",
"example": "2010-06-26"
},
"duration": {
"description": "Dur\u00e9e en mois du contrat.",
"type": "integer",
"example": 24
},
"km": {
"description": "Kilom\u00e9trage du contrat.",
"type": "integer",
"example": 240000
},
"useTime": {
"description": "Dur\u00e9e en heure d'utilisation du v\u00e9hicule.
Obligatoirement si le v\u00e9hicule est une machine.",
"type": "integer",
"example": 240000
},
"costPurchase": {
"description": "Co\u00fbt d'achat du vehicule.
Obligatoire pour un contrat de type achat.",
"type": "integer",
"example": 350000
},
"costFirst": {
"description": "Co\u00fbt du premier loyer.",
"type": "integer",
"example": 240000
},
"costPeriodic": {
"description": "Co\u00fbt du loyer.",
"type": "integer",
"example": 10000
},
"costMaintenance": {
"description": "Co\u00fbt du loyer de maintenance.",
"type": "integer",
"example": 2000
},
"costTiresSummer": {
"description": "Co\u00fbt pneus \u00e9t\u00e9.",
"type": "integer",
"example": 3000
},
"costTiresWinter": {
"description": "Co\u00fbt pneus hiver.",
"type": "integer",
"example": 3000
},
"costFinancialLoss": {
"description": "Pertes financi\u00e8res.",
"type": "integer",
"example": 5000
},
"costOther": {
"description": "Autres couts.",
"type": "integer",
"example": 250
},
"lastRevisionDate": {
"description": "Date d'application du contract.",
"type": "string",
"example": "2010-07-26"
},
"paymentFrequency": {
"description": "Fr\u00e9quence en mois du paiement.",
"type": "integer",
"example": 1
},
"paymentDay": {
"description": "Jour du paiement.",
"type": "integer",
"example": 10
},
"type": {
"description": "Type du contrat",
"properties": {
"id": {
"description": "Identifiant.",
"type": "integer",
"example": 1
},
"name": {
"description": "Type du contrat.",
"type": "string",
"example": "LCD - Location Courte Dur\u00e9e"
}
},
"type": "object"
},
"company": {
"description": "Soci\u00e9t\u00e9 d'acquisition du contrat",
"properties": {
"id": {
"description": "Identifiant.",
"type": "integer",
"example": 1
},
"name": {
"description": "Type du contrat.",
"type": "string",
"example": "ALD Automotive"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"Ticket": {
"required": [
"id",
"name",
"category",
"lastActionAt",
"createAt",
"state",
"device"
],
"properties": {
"id": {
"description": "Num\u00e9ro de ticket.",
"type": "integer",
"example": 4
},
"name": {
"description": "Description courte du ticket.",
"type": "string",
"example": "Demande d'information"
},
"category": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "int",
"example": 1
},
"name": {
"type": "string",
"example": "Boitier localisateur"
}
},
"type": "object"
},
"lastActionAt": {
"description": "Date heure de la derni\u00e8re action effectu\u00e9 sur le ticket.",
"type": "string",
"example": "2017-02-17 16:01:12"
},
"closedAt": {
"description": "Date heure de la cloture du ticket.",
"type": "string",
"example": "2017-02-17 16:01:12"
},
"createAt": {
"description": "Date heure de la cr\u00e9ation du ticket.",
"type": "string",
"example": "2017-02-17 15:50:10"
},
"state": {
"description": "Repr\u00e9sente l'\u00e9tat du ticket.",
"type": "string",
"example": "En cours"
},
"device": {
"type": "object",
"$ref": "#/definitions/DeviceSimple"
}
},
"type": "object"
},
"UserConnected": {
"required": [
"iduser",
"nom"
],
"properties": {
"iduser": {
"description": "Identifiant unique",
"type": "integer",
"example": "1"
},
"nom": {
"description": "Nom de l'utilisateur",
"type": "string",
"example": "John Doe"
},
"email": {
"description": "Email de l'utilisateur",
"type": "string",
"example": "john.doe@mail.com"
},
"tel": {
"description": "T\u00e9l\u00e9phone de l'utilisateur",
"type": "string",
"example": "**-**-**-**-**"
},
"client": {
"type": "array",
"items": {
"$ref": "#/definitions/Client"
}
}
},
"type": "object",
"xml": {
"name": "user"
}
},
"Widget": {
"required": [
"id",
"name",
"type",
"parameters"
],
"properties": {
"id": {
"type": "integer",
"example": 909
},
"name": {
"description": "Titre du widget",
"type": "string",
"example": "Kilom\u00e8tres par jour"
},
"type": {
"description": "Type de repr\u00e9sentation.",
"type": "string",
"enum": [
"column",
"value",
"areaspline",
"pie",
"topFive"
]
},
"realtime": {
"description": "Les donn\u00e9es de ce widget sont-elles en temps r\u00e9el.",
"type": "boolean",
"example": false
},
"position": {
"required": [
"col",
"row",
"width",
"height"
],
"properties": {
"col": {
"description": "Positionnement",
"type": "integer",
"example": 1
},
"row": {
"description": "Positionnement",
"type": "integer",
"example": 1
},
"width": {
"description": "Taille",
"type": "integer",
"example": 3
},
"height": {
"description": "Taille",
"type": "integer",
"example": 2
}
},
"type": "object"
},
"parameters": {
"description": "D\u00e9crit les param\u00e8tres optionnels support\u00e9s par le widget.",
"required": [
"deviceId",
"driverId",
"maxDaysRange"
],
"properties": {
"deviceId": {
"description": "Le widget peut-il \u00eatre demand\u00e9 pour un Device particulier ?",
"type": "bool",
"example": false
},
"driverId": {
"description": "Le widget peut-il \u00eatre demand\u00e9 pour un Driver particulier ?",
"type": "bool",
"example": true
},
"maxDaysRange": {
"description": "Indique la p\u00e9riode maximale en jours sur laquelle le widget agr\u00e8ge ses donn\u00e9es.",
"type": "integer",
"example": 7
}
},
"type": "object"
}
},
"type": "object"
}
},
"parameters": {
"fields": {
"name": "fields",
"in": "query",
"description": "Limite les champs retourn\u00e9s \u00e0 ceux sp\u00e9cifi\u00e9s : `...?fields=key1,key2`.",
"required": false,
"type": "array",
"items": "string",
"collectionFormat": "csv",
"uniqueItems": true
},
"sort": {
"name": "sort",
"in": "query",
"description": "Tri le r\u00e9sultat sur les champs sp\u00e9cifi\u00e9s. Un nom de champ pr\u00e9fix\u00e9 par '-' (le signe moins) est tri\u00e9 en DESC et un nom de champ sans pr\u00e9fixe est tri\u00e9 en ASC : `...?sort=key1,-key2`.",
"required": false,
"type": "array",
"items": "string",
"collectionFormat": "csv",
"uniqueItems": true
},
"equals": {
"name": "equals",
"in": "query",
"description": "Recherche (de mani\u00e8re stricte) les ressources r\u00e9pondant au(x) crit\u00e8re(s) : `...?equals=key1:valueA,key2:valueB`. Les crit\u00e8res imbriqu\u00e9s sont \u00e9galement filtrables `equals=state.where.poi.id:10,category.id:16`.",
"required": false,
"type": "array",
"items": "string",
"collectionFormat": "csv",
"uniqueItems": true
},
"like": {
"name": "like",
"in": "query",
"description": "Recherche (de mani\u00e8re souple) les ressources r\u00e9pondant au(x) crit\u00e8re(s) : `...?like=key1:valueA,key2:valueB`. Les crit\u00e8res imbriqu\u00e9s sont \u00e9galement filtrables `like=state.where.poi.id:10,category.id:16`.",
"required": false,
"type": "array",
"items": "string",
"collectionFormat": "csv",
"uniqueItems": true
},
"page": {
"name": "page",
"in": "query",
"description": "Num\u00e9ro de la page.",
"type": "integer"
},
"perpage": {
"name": "perpage",
"in": "query",
"description": "Nombre d'\u00e9l\u00e9ments affich\u00e9s par page.",
"required": false,
"type": "integer"
}
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"description": "Token Persistant",
"name": "Authorization",
"in": "header"
},
"oauth2": {
"type": "oauth2",
"description": "OAuth2 Password Grant",
"name": "login",
"in": "query",
"flow": "password",
"tokenUrl": "https://api.suivideflotte.net/users/oauth2"
},
"driverOauth2": {
"type": "oauth2",
"description": "OAuth2 Password Grant",
"name": "login",
"in": "query",
"flow": "password",
"tokenUrl": "https://api.suivideflotte.net/drivers/oauth2"
},
"internalsOauth2": {
"type": "oauth2",
"description": "OAuth2 Password Grant",
"name": "login",
"in": "query",
"flow": "password"
}
},
"tags": {
"0": {
"name": "Fleet/Devices",
"description": "Gestion des p\u00e9riph\u00e9riques g\u00e9olocalis\u00e9s"
},
"1": {
"name": "Fleet/Devices/Software",
"description": "Gestion des p\u00e9riph\u00e9riques g\u00e9olocalis\u00e9s logiciels"
},
"2": {
"name": "Fleet/Groups",
"description": "Tout sur les groupes de v\u00e9hicules de SuiviDeFlotte"
},
"3": {
"name": "Fleet/POIs",
"description": "Gestion des Points d'int\u00e9r\u00eat"
},
"4": {
"name": "Fleet/Reports",
"description": "Rapports d'activit\u00e9 des p\u00e9riph\u00e9riques g\u00e9olocalis\u00e9s. Conform\u00e9ment avec la CNIL, l'historique est limit\u00e9 \u00e0 60 jours."
},
"5": {
"name": "Widgets",
"description": "Consultation de statistiques sous forme de tableaux de bord et de widgets"
},
"7": {
"name": "Support",
"description": "Dialogue avec le Support Technique"
},
"8": {
"name": "Admin/Users",
"description": "Gestion des utilisateurs SuiviDeFlotte.net"
},
"9": {
"name": "Fleet/Maintenances",
"description": "Gestion des alertes entretiens"
},
"10": {
"name": "Fleet/Movements",
"description": "Gestion des alertes de mouvements"
},
"11": {
"name": "Missions/Accounts",
"description": "Gestion de compte"
},
"12": {
"name": "Missions/Assignees",
"description": "Gestion du personne terrain"
},
"13": {
"name": "Missions/Contacts",
"description": "Gestion des contacts d'un compte"
},
"14": {
"name": "Missions/Groups",
"description": "Gestion des groupes de personnel terrain"
},
"15": {
"name": "Missions/Messages",
"description": "Gestion des messages"
},
"16": {
"name": "Missions/Missions",
"description": "Gestion de mission"
},
"17": {
"name": "Beepiz/Identifications",
"description": "Gestion des cartes d'identification Beepiz"
},
"18": {
"name": "Beepiz/ActionPoints",
"description": "Gestion des groupes, zones et Action Points Beepiz (beacons, wifi, QRCodes...)"
},
"19": {
"name": "Beepiz/PlanEntities",
"description": "Gestion des Plans et de leur arborescence"
},
"20": {
"name": "Beepiz/Datis",
"description": "Gestion des balises Datis"
},
"21": {
"name": "Beepiz/Licences",
"description": "Gestion des licences Beepiz"
},
"22": {
"name": "Beepiz/Profiles",
"description": "Gestion des profils de configuration de balises Dati"
},
"23": {
"name": "Beepiz/Events",
"description": "Consultations des \u00e9v\u00e9nements envoy\u00e9s par la balise Dati"
},
"24": {
"name": "Beepiz/Groups",
"description": "Gestion des groupes d\u00e9finis par le client"
},
"25": {
"name": "Beepiz/Contacts",
"description": "Gestion des contacts de phonebooks"
},
"26": {
"name": "Beepiz/Phonebooks",
"description": "Gestion des phonebooks"
},
"27": {
"name": "Park/Vehicles",
"description": "Gestion des v\u00e9hicules dans la Gestion de parc"
},
"28": {
"name": "Park/Drivers",
"description": "Gestion des collaborateurs dans la Gestion de parc"
},
"29": {
"name": "Park/Groups",
"description": "Gestion des groupes dans la Gestion de parc"
}
}
}