NAV Navigation
Shell HTTP JavaScript Node.JS Ruby Python Java Go

API Kaliti v5.39.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Ceci est la documentation de référence officielle de l'API Kaliti. Elle est accessible depuis cette URL :

https://public-api-staging.kaliti.fr/v2/api/doc/fr

L'API Kaliti est un panel de méthodes donnant accès aux entreprises, phases, projets, réserves et utilisateurs du logiciel.

l'API Kaliti est organisé autour de REST et utilise des verbes et noms d'entités en HTTPS. Toutes les requêtes doivent avoir un paramêtre "accept" dans l'en-tête avec la valeur suivante :

accept: application/json or accept: */*

Les ressources sont compatibles avec la spécification HTTP1.1 RFC Les réponses sont formattées en JSON, encodées en UTF-8.

Notes de mise à jour

V5.37.0 - 16/12/2022

Ajouts :

Ressource PLANS, il est maintenant possible d’uploader / mettre à jour des plans via le format Base64. Méthodes concernées:

Ressource PROJETS, il est maintenant possible d’uploader / mettre à jour l’image du projet, le logo 1 et le logo 2 via le format Base64. Méthodes concernées:

Suppressions :

n/a

Modifications :

n/a

Corrections :

n/a

V5.36.1 - 07/12/2022

Ajouts :

Nouvelle section “Documents liés aux lots”

3 méthodes pour cette nouvelle fonctionnalité:

Suppressions :

n/a

Modifications :

n/a

Corrections :

n/a

v2.0.0 - 11/09/2019

Ajouts :

Suppressions :

Aucune

Modifications :

Corrections :

Securité

L'API Kaliti utilise le protocole OAuth 2.0 pour l'authentification et permet aux applications de soumettre des requêtes d'authentification.

Le type de flux OAuth2 est 'password'

Vous devez fournir :

Ce sont les informations spécifiques à chaque application requêtant l'API.

Ce sont les identifiants utilisateurs.

Demandez vos identifiants à votre chargé de compte Kaliti.

  1. Pour obtenir un jeton d’authentification OAuth 2.0, fournissez les identifiants encryptés de sécurité : client_id, client_secret, username et password La requête en POST est :

/oauth/v2/token, avec les données POST : client_id, client_secret, username et password

  1. Enfin, il faut inclure le token Bearer dans tous les appels à l'API Kaliti comme ci-dessous :

Authorization: Bearer d4ebdfa376de03e96f5f5c437193279224373287

Limitation de taux d'utilisation

Aucun actuellement

Pagination

Les routes qui listent les ressources ont 2 paramètres optionnels :

Ces paramètres sont utilisés pour parcourir les résultats de la réponse. Les résultats sont affichés par page (commençant à la page 1), avec un nombre de résultat par page défini par le paramètre limit.

Documentation de référence de l'API Kaliti

Base URLs:

Authentication

Scope Scope Description

Default

Télécharger un fichier

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/files/upload \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/files/upload HTTP/1.1

Content-Type: application/x-www-form-urlencoded


var headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/files/upload',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "file": "string",
  "fileUrl": "string",
  "fileBase64": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/files/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/files/upload',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/files/upload', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/files/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/x-www-form-urlencoded"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/files/upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/files/upload

Body parameter

file: string
fileUrl: string
fileBase64: string

Parameters

Parameter In Type Required Description
body body object false none
» file body string(binary) false Télécharger un fichier
» fileUrl body string false Upload file by URL
» fileBase64 body string(binary) false Upload base64 encoded file

Responses

Status Meaning Description Schema
201 Created Création réussie None
400 Bad Request Les données de la requête sont invalides None
403 Forbidden User doesn't have role to upload file or doesn't have access to this action None
404 Not Found l'URL saisie est invalide None

Compte client

Obtenir la liste de libellé du compte client

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/client-accounts/{clientAccount}/labels \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/client-accounts/{clientAccount}/labels HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/client-accounts/{clientAccount}/labels',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/client-accounts/{clientAccount}/labels',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/client-accounts/{clientAccount}/labels',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/client-accounts/{clientAccount}/labels', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/client-accounts/{clientAccount}/labels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/client-accounts/{clientAccount}/labels", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/client-accounts/{clientAccount}/labels

Parameters

Parameter In Type Required Description
clientAccount path string true filter on external code of client account
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées Inline
400 Bad Request Invalid data None
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [LabelDTO] false none none
» id integer false none Clé primaire
» name string false none Label name
» package PackageDTO false none none
»» id integer true none Clé primaire
»» name string false none Package name

Créer un libellé

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/client-accounts/{clientAccount}/labels \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/client-accounts/{clientAccount}/labels HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/client-accounts/{clientAccount}/labels',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "package": {
    "id": 1,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/client-accounts/{clientAccount}/labels',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/client-accounts/{clientAccount}/labels',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/client-accounts/{clientAccount}/labels', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/client-accounts/{clientAccount}/labels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/client-accounts/{clientAccount}/labels", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/client-accounts/{clientAccount}/labels

Body parameter

{
  "name": "string",
  "package": {
    "id": 1,
    "name": "string"
  }
}

Parameters

Parameter In Type Required Description
clientAccount path string true filter on external code of client account
locale query string false Langue
body body LabelDTO2 true Label body

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie LabelDTO
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Obtenir la liste des modèles de rapport du compte client

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/client-accounts/{clientAccount}/report-templates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/client-accounts/{clientAccount}/report-templates

Parameters

Parameter In Type Required Description
clientAccount path string true filter on external code of client account
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées Inline
400 Bad Request Invalid data None
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SettingDTO] false none none
» id integer true none Clé primaire
» name string false none Report template name

Obtenir la liste des zones du compte client

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/client-accounts/{clientAccount}/zones \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/client-accounts/{clientAccount}/zones HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/client-accounts/{clientAccount}/zones',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/client-accounts/{clientAccount}/zones',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/client-accounts/{clientAccount}/zones',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/client-accounts/{clientAccount}/zones', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/client-accounts/{clientAccount}/zones");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/client-accounts/{clientAccount}/zones", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/client-accounts/{clientAccount}/zones

Parameters

Parameter In Type Required Description
clientAccount path string true filter on external code of client account
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées Inline
400 Bad Request Invalid data None
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ZoneDTO] false none none
» id integer false none Clé primaire
» name string false none Zone title

Entreprise

Récupèrer la liste des entreprises

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/companies \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/companies HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/companies',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/companies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/companies',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/companies', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/companies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/companies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/companies

Parameters

Parameter In Type Required Description
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
counting query boolean false Disable total items counting for performance boost
locale query string false Langue
filters[project] query string false Filtrer sur le code externe du projet
filters[name] query string false Filtre sur la raison sociale de l'entreprise
filters[package] query string false Filtre sur le nom du lot de l'entreprise
filters[package_trade_code] query string false filter on trade code of package
filters[package_number] query string false Filtre sur le numéro du lot de l'entreprise
filters[external_code] query string false Filter sur le code externe de l'entreprise
filters[identification_code] query string false filter on siret/duns code of company
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées Inline
400 Bad Request Invalid data None
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CompanyDTO] false none none
» id integer false none Clé primaire
» name string true none Raison sociale de l'entreprise
» package [LinksCompaniesPackagesDTO] true none Package name
»» link_company_package_id integer false none Clé primaire
»» package_name string true none Package's name
»» package_number string false none Lot N°
»» package_trade_code string false none Package Trade code
»» color string false none Couleur (Exemple : fff000)
» address string false none Adresse
» category CompanyCategoryDTO true none none
»» id integer true none Clé primaire
»» name string false none Category name of the company (Example : Painting) * 1 - Intervenants * 2 - Concessionnaires * 3 - Entreprises
» zip_code string false none Code postal
» city string false none Nom de la ville
» sub_type string false none Sous-type (Exemple : éléctricité)
» external_code string false none Code externe
» identification_code string true none Code SIRET
» identification_type integer false none Identification Type Id
» legal_name string false none Legal name
» create_date string(date) false none Date de création
» last_update_date string(date) false none Date de dernière mise à jour

Récupèrer la liste des entreprises d'un projet

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/companies \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/companies HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/companies',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/companies', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/companies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/companies

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[name] query string false Filtre sur la raison sociale de l'entreprise
filters[package] query string false Filtre sur le nom du lot de l'entreprise
filters[package_trade_code] query string false filter on trade code of package
filters[package_number] query string false Filtre sur le numéro du lot de l'entreprise
filters[external_code] query string false Filter sur le code externe de l'entreprise
filters[identification_code] query string false filter on siret/duns code of company
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées Inline
400 Bad Request Invalid data None
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CompanyDTO2] false none none
» id integer false none Clé primaire
» name string true none Raison sociale de l'entreprise
» package [LinksCompaniesPackagesDTO] true none Package name
»» link_company_package_id integer false none Clé primaire
»» package_name string true none Package's name
»» package_number string false none Lot N°
»» package_trade_code string false none Package Trade code
»» color string false none Couleur (Exemple : fff000)
» address string false none Adresse
» category CompanyCategoryDTO true none none
»» id integer true none Clé primaire
»» name string false none Category name of the company (Example : Painting) * 1 - Intervenants * 2 - Concessionnaires * 3 - Entreprises
» zip_code string false none Code postal
» city string false none Nom de la ville
» sub_type string false none Sous-type (Exemple : éléctricité)
» external_code string false none Code externe
» identification_code string true none Code SIRET
» identification_type integer false none Identification Type Id
» legal_name string false none Legal name
» create_date string(date) false none Date de création
» last_update_date string(date) false none Date de dernière mise à jour

Créér l'entreprise

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/companies \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/companies HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "category": {
    "id": 1,
    "name": "string"
  },
  "zip_code": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/companies',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/companies', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/companies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/companies

Body parameter

{
  "name": "string",
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "category": {
    "id": 1,
    "name": "string"
  },
  "zip_code": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
locale query string false Langue
body body CompanyDTO3 true Détails de l'entreprise

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie CompanyDTO2
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Détails de l'entreprise

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/companies/{company} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/companies/{company} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{company}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{company}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/companies/{company}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/companies/{company}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{company}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/companies/{company}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/companies/{company}

Route pour récupérer l'ensemble des informations d'une entreprise

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
company path integer true ID de l'entreprise
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées CompanyDTO2
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Mise à jour de l'entreprise

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/companies/{company} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/companies/{company} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{company}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{company}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/companies/{company}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/companies/{company}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{company}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/companies/{company}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/companies/{company}

Mise à jour des champs d'une entreprise

Body parameter

{
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
company path integer true ID de l'entreprise
locale query string false Langue
body body CompanyDTO4 true Détails de l'entreprise

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès CompanyDTO2
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Supprimer corps d`état

Code samples

# You can also use wget
curl -X DELETE /api.kaliti.test/v2/projects/{project}/companies/{company} \
  -H 'Authorization: Bearer {access-token}'


DELETE /api.kaliti.test/v2/projects/{project}/companies/{company} HTTP/1.1


var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{company}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{company}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api.kaliti.test/v2/projects/{project}/companies/{company}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api.kaliti.test/v2/projects/{project}/companies/{company}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{company}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api.kaliti.test/v2/projects/{project}/companies/{company}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v2/projects/{project}/companies/{company}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
company path integer true Link company package ID

Responses

Status Meaning Description Schema
204 No Content Suppression effectuée avec succès None
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Tâche du tableau de bord

Liste des tâches du tableau de bord pour le projet courant

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/dashboard/tasks \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/dashboard/tasks HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/dashboard/tasks',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/dashboard/tasks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/dashboard/tasks',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/dashboard/tasks', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/dashboard/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/dashboard/tasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/dashboard/tasks

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des tâches de tableau de bord du projet courant Inline
403 Forbidden User can't access tasks in current project None
404 Not Found Tasks not found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [TaskDTO] false none none
» id integer false none Clé primaire
» number integer false none Numéro de la tâche du tableau de bord
» category CategoryDTO false none none
»» id integer false none Clé primaire
»» name string false none Nom de la phase du tableau de bord
» description string false none Description de la tâche du tableau de bord
» process string false none Traitement de la tâche du tableau de bord
» unit string false none Unité de la tâche du tableau de bord
» data string false none Données de la tâche du tableau de bord
» comment string false none Commentaires de la tâche du tableau de bord
» projects [ProjectDTO5] false none Projets de la tâche du tableau de bord
»» id integer false none Clé primaire
»» external_code string false none Code externe

Détails de la tâche du tableau de bord

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/dashboard/tasks/{task}

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
task path integer true Numéro de la tâche du tableau de bord
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Détails de la tâche du tableau de bord TaskDTO
403 Forbidden User can't access task in current project None
404 Not Found Tâche introuvable None

Modification de la tâche du tableau de bord

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "data": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/dashboard/tasks/{task}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/dashboard/tasks/{task}

Body parameter

{
  "data": "string"
}

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
task path integer true Numéro de la tâche du tableau de bord
locale query string false Langue
body body TaskDTO2 true none

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès TaskDTO
403 Forbidden User can't access task in current project None
404 Not Found Tâche introuvable None

Lot

Liste des lot pour l’utilisateur

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/lots \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/lots HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/lots',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/lots',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/lots',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/lots', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/lots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/lots", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/lots

Parameters

Parameter In Type Required Description
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
counting query boolean false Disable total items counting for performance boost
locale query string false Langue
filters[external_code] query string false Filter on external code

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of lots for current user LotDTO
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Liste des lots sur le projet

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/lots \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/lots HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lots',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lots',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/lots',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/lots', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/lots", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/lots

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[external_code] query string false Filter on external code

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of lots for current project LotDTO
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Créer lot

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/lots \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/lots HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lots',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lots',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/lots',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/lots', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/lots", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/lots

Body parameter

{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
locale query string false Langue
body body LotDTO2 true Lot body

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie LotDTO
403 Forbidden User does not have role to create lot or doesn't have access to the project None
404 Not Found Le projet n'existe pas None

Détail du lot

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/lots/{lot} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/lots/{lot} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lots/{lot}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/lots/{lot}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lots/{lot}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/lots/{lot}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/lots/{lot}

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
lot path string true Lot external code
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns exact lot LotDTO
403 Forbidden User can't see lots inside project or isn't linked to project None
404 Not Found l'URL saisie est invalide None

Mise à jour du lot

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/lots/{lot} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/lots/{lot} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lots/{lot}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/lots/{lot}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lots/{lot}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/lots/{lot}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/lots/{lot}

Body parameter

{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
lot path string true Lot external code
locale query string false Langue
body body LotDTO3 true none

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès LotDTO
403 Forbidden User does not have role to update lot or doesn't have access to the project None
404 Not Found Project or lot does not exist None

Patch up lot by id

Code samples

# You can also use wget
curl -X PATCH /api.kaliti.test/v2/projects/{project}/lots/{lot} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH /api.kaliti.test/v2/projects/{project}/lots/{lot} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lots/{lot}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api.kaliti.test/v2/projects/{project}/lots/{lot}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lots/{lot}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api.kaliti.test/v2/projects/{project}/lots/{lot}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /v2/projects/{project}/lots/{lot}

Body parameter

{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
lot path string true Lot external code
locale query string false Langue
body body LotDTO4 true none

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Patched up successfully LotDTO
403 Forbidden User does not have role to update lot or doesn't have access to the project None
404 Not Found Project or lot does not exist None

Suppression lot

Code samples

# You can also use wget
curl -X DELETE /api.kaliti.test/v2/projects/{project}/lots/{lot} \
  -H 'Authorization: Bearer {access-token}'


DELETE /api.kaliti.test/v2/projects/{project}/lots/{lot} HTTP/1.1


var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lots/{lot}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api.kaliti.test/v2/projects/{project}/lots/{lot}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api.kaliti.test/v2/projects/{project}/lots/{lot}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lots/{lot}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api.kaliti.test/v2/projects/{project}/lots/{lot}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v2/projects/{project}/lots/{lot}

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
lot path string true Lot external code

Responses

Status Meaning Description Schema
204 No Content Suppression effectuée avec succès None
403 Forbidden User doesn't have role to delete lot or doesn't have access to the project None
404 Not Found Project or lot does not exist None

Phase

Liste des phases

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[is_locked] query boolean false filter phases that are locked/not locked
filters[is_available_on_purchaser_access] query boolean false filter on phases that are available/not available to purchaser access
filters[name] query string false filter on phase name
filters[external_code] query string false Filtrer sur le code externe de la phase
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des phases du projet courant Inline
400 Bad Request Invalid data None
403 Forbidden User doesn't have access to project None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PhaseDTO] false none none
» id integer false none Clé primaire
» name string true none Nom de la phase
» sub_name string false none Surnom de la phase
» is_locked boolean true none Est-ce que la phase est vérouillée
» is_structural_work boolean true none Activer ou non les fonctionnalités liés au gros oeuvre sur cette phase
» is_available_on_purchaser_access boolean true none Activer ou non les fonctionnalités de l'acheteur sur cette phase
» type PhaseTypeDTO true none none
»» id integer true none Clé primaire
»» name string false none Phase type name * 1 - Raising Reserve * 2 - Delivery * 3 - Cover to 30 days * 5 - Audit * 6 - Structural work * 7 - Technical trades * 8 - Architectural trades * 9 - Witness * 10 - Purchasers visit * 11 - Operations prior to acceptance * 12 - Pre-delivery * 13 - Visit 7 days before delivery * 14 - Bienniale * 15 - TMA
» external_code string false none Code externe
» last_update_date string(date) false none Date de dernière mise à jour

Créer la phase

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/phases \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/phases HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/phases',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/phases', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/phases", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/phases

Body parameter

{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
locale query string false Langue
body body PhaseDTO2 true Détails d'une phase

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie PhaseDTO
403 Forbidden User does not have role to create phase or doesn't have access to the project None
404 Not Found l'URL saisie est invalide None

Détails de la phase

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases/{phase} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases/{phase} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases/{phase}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases/{phase}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases/{phase}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases/{phase}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK La phase a été trouvé PhaseDTO
403 Forbidden User isn't linked to specific phase None
404 Not Found l'URL saisie est invalide None

Mise à jour d'une phase

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/phases/{phase} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/phases/{phase} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/phases/{phase}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/phases/{phase}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/phases/{phase}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/phases/{phase}

Body parameter

{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
locale query string false Langue
body body PhaseDTO3 true Détails d'une phase

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès PhaseDTO
403 Forbidden L'utilisateur n'a pas accès à cette phase au sein du projet None
404 Not Found Le projet ou la phase n'existent pas None

Patch update phase

Code samples

# You can also use wget
curl -X PATCH /api.kaliti.test/v2/projects/{project}/phases/{phase} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH /api.kaliti.test/v2/projects/{project}/phases/{phase} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api.kaliti.test/v2/projects/{project}/phases/{phase}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api.kaliti.test/v2/projects/{project}/phases/{phase}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api.kaliti.test/v2/projects/{project}/phases/{phase}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /v2/projects/{project}/phases/{phase}

Body parameter

{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
locale query string false Langue
body body PhaseDTO4 true Détails d'une phase

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès PhaseDTO
403 Forbidden L'utilisateur n'a pas accès à cette phase au sein du projet None
404 Not Found Le projet ou la phase n'existent pas None

Plan

Liste des plans liés à l’utilisateur

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/plans \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/plans HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/plans',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/plans',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/plans',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/plans', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/plans

Liste des plans liés à l'utilisateur

Parameters

Parameter In Type Required Description
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
counting query boolean false Disable total items counting for performance boost
locale query string false Langue
filters[project_external_code] query string false Filtrer sur le code externe du projet
filters[building] query string false filter on building name
filters[floor] query string false filter on floor name (1st floor, 2nd...)
filters[number] query string false Filtre sur le numéro du plan
filters[zone_type] query string false Filtre sur le type de zone du plan
filters[external_code] query string false Filtrer sur le code externe du plan
filters[before_delivery_date] query string(full-date) false filter all the data whose the plan delivery date is before or equal to the specified date (YYYY-MM-DD)
filters[after_delivery_date] query string(full-date) false filter all the data whose the plan delivery date is after or equal to the specified date (YYYY-MM-DD)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des plans de l'utilisateur courant. Inline
400 Bad Request Invalid data None
403 Forbidden L'utilisateur n'a pas les droits de visualiser les plans None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PlanDTO] false none none
» id integer true none Clé primaire
» general_plan_name string false none Nom du plan général
» number string true none Numéro du plan (Exemple : B02)
» plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
» floor string true none Etage (Exemple : Rez-de-chaussée)
» building string true none Batiment (Exemple : batiment numéro 6)
» zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
» zone_category string false none Zone category
» lodgement_type string false none Type de logement (Exemple : House)
» index string true none Index du plan (exemple : 123)
» drawing_src string false none URL du plan
» delivery_date string(date) false none Date de livraison du lot
» external_code string false none Code externe
» last_update_date string(date) false none Date de dernière mise à jour
» project_id integer false none ID du projet
» phase_id integer false none Phase id
» plan_id integer false none Plan id
» sso_provider_id integer false none Sso provider id
» url string false none Url
» project_external_code string false none Code externe
» phases [PhaseDTO5] false none Phases
»» external_code string false none Code externe

Liste globale des plans

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/plans \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/plans HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/plans',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/plans',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/plans',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/plans', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/plans

Liste des plans liés au projet

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[building] query string false filter on building name
filters[floor] query string false filter on floor name (1st floor, 2nd...)
filters[number] query string false Filtre sur le numéro du plan
filters[zone_type] query string false Filtre sur le type de zone du plan
filters[external_code] query string false Filtrer sur le code externe du plan
filters[before_delivery_date] query string(full-date) false filter all the data whose the plan delivery date is before or equal to the specified date (YYYY-MM-DD)
filters[after_delivery_date] query string(full-date) false filter all the data whose the plan delivery date is after or equal to the specified date (YYYY-MM-DD)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des plans du projet courant Inline
400 Bad Request Invalid data None
403 Forbidden L'utilisateur n'a pas les droits de visualiser les plans None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PlanDTO] false none none
» id integer true none Clé primaire
» general_plan_name string false none Nom du plan général
» number string true none Numéro du plan (Exemple : B02)
» plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
» floor string true none Etage (Exemple : Rez-de-chaussée)
» building string true none Batiment (Exemple : batiment numéro 6)
» zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
» zone_category string false none Zone category
» lodgement_type string false none Type de logement (Exemple : House)
» index string true none Index du plan (exemple : 123)
» drawing_src string false none URL du plan
» delivery_date string(date) false none Date de livraison du lot
» external_code string false none Code externe
» last_update_date string(date) false none Date de dernière mise à jour
» project_id integer false none ID du projet
» phase_id integer false none Phase id
» plan_id integer false none Plan id
» sso_provider_id integer false none Sso provider id
» url string false none Url
» project_external_code string false none Code externe
» phases [PhaseDTO5] false none Phases
»» external_code string false none Code externe

Créer plan lié à toutes les phases

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/plans \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/plans HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/plans',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string",
  "phases": [
    {
      "external_code": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/plans',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/plans',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/plans', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/plans

Body parameter

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string",
  "phases": [
    {
      "external_code": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
locale query string false Langue
body body PlanDTO7 true Données d'entrée

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie PlanDTO6
400 Bad Request Les données de la requête sont invalides None
403 Forbidden User doesn't have role to create plan or doesn't have access to the project or isn't linked to project None
404 Not Found l'URL saisie est invalide None

Liste des plans

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases/{phase}/plans

Liste des plans liés au projet et à la phase

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[building] query string false filter on building name
filters[floor] query string false filter on floor name (1st floor, 2nd...)
filters[number] query string false Filtre sur le numéro du plan
filters[zone_type] query string false Filtre sur le type de zone du plan
filters[external_code] query string false Filtrer sur le code externe du plan
filters[before_delivery_date] query string(full-date) false filter all the data whose the plan delivery date is before or equal to the specified date (YYYY-MM-DD)
filters[after_delivery_date] query string(full-date) false filter all the data whose the plan delivery date is after or equal to the specified date (YYYY-MM-DD)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des plans du projet courant et de la phase courante Inline
400 Bad Request Invalid data None
403 Forbidden L'utilisateur n'est pas lié à cette phase ou n'a pas les droits de visualiser les plans None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PlanDTO] false none none
» id integer true none Clé primaire
» general_plan_name string false none Nom du plan général
» number string true none Numéro du plan (Exemple : B02)
» plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
» floor string true none Etage (Exemple : Rez-de-chaussée)
» building string true none Batiment (Exemple : batiment numéro 6)
» zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
» zone_category string false none Zone category
» lodgement_type string false none Type de logement (Exemple : House)
» index string true none Index du plan (exemple : 123)
» drawing_src string false none URL du plan
» delivery_date string(date) false none Date de livraison du lot
» external_code string false none Code externe
» last_update_date string(date) false none Date de dernière mise à jour
» project_id integer false none ID du projet
» phase_id integer false none Phase id
» plan_id integer false none Plan id
» sso_provider_id integer false none Sso provider id
» url string false none Url
» project_external_code string false none Code externe
» phases [PhaseDTO5] false none Phases
»» external_code string false none Code externe

Créer un plan

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/phases/{phase}/plans

Body parameter

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
locale query string false Langue
body body PlanDTO2 true Données d'entrée

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie PlanDTO
400 Bad Request Les données de la requête sont invalides None
403 Forbidden User doesn't have role to create plan or doesn't have access to the project or isn't linked to project None
404 Not Found l'URL saisie est invalide None

Détails du plan

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases/{phase}/plans/{plan}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Le plan a été trouvé PlanDTO
403 Forbidden L'utilisateur n'est pas lié à cette phase ou n'a pas les droits de visualiser les plans None
404 Not Found l'URL saisie est invalide None

Mise à jour d'un plan

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/phases/{phase}/plans/{plan}

Body parameter

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
locale query string false Langue
body body PlanDTO3 true Données d'entrée

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Mise à jour effectuée avec succès PlanDTO
400 Bad Request Les données de la requête sont invalides None
403 Forbidden User doesn't have role to create plan or doesn't have access to the project or isn't linked to project None
404 Not Found l'URL saisie est invalide None

Patch update plan

Code samples

# You can also use wget
curl -X PATCH /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /v2/projects/{project}/phases/{phase}/plans/{plan}

Body parameter

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
locale query string false Langue
body body PlanDTO4 true Données d'entrée

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Patch updated successfully PlanDTO
400 Bad Request Les données de la requête sont invalides None
403 Forbidden User doesn't have role to create plan or doesn't have access to the project or isn't linked to project None
404 Not Found l'URL saisie est invalide None

Supprimer un plan

Code samples

# You can also use wget
curl -X DELETE /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} \
  -H 'Authorization: Bearer {access-token}'


DELETE /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan} HTTP/1.1


var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v2/projects/{project}/phases/{phase}/plans/{plan}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan

Responses

Status Meaning Description Schema
204 No Content Le plan a été supprimé avec succès None
403 Forbidden L'utilisateur n'est pas lié à cette phase ou n'a pas les droits de visualiser les plans None
404 Not Found l'URL saisie est invalide None

Obtenir l’url du plan

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/url", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases/{phase}/plans/{plan}/url

Plan url generation

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtrer sur le code externe du plan
locale query string false Langue
email query string false Email

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the url for current plan Inline
403 Forbidden L'utilisateur n'a pas les droits de visualiser les plans None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [PlanDTO5] false none none
» phase_id integer false none Phase id
» plan_id integer false none Plan id
» sso_provider_id integer false none Sso provider id
» url string false none Url

Projet

Liste des projets

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects

Liste des projets liés à l'utilisateur

Parameters

Parameter In Type Required Description
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
counting query boolean false Disable total items counting for performance boost
filters[title] query string false Filtre sur le titre du projet
filters[external_code] query string false Filtrer sur le code externe du projet
filters[after_delivery_date] query string(date-time) false Filtre tous les projets dont la date de livraison est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_delivery_date] query string(date-time) false Filtre tous les projets dont la date de livraison est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des projets Inline
400 Bad Request Invalid data None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ProjectDTO] false none none
» id integer false none Clé primaire
» title string true none Titre du projet
» image string false none URL de l'image principale du projet
» logo string false none URL du premier logo du projet
» logo2 string false none URL du deuxième logo du projet
» external_code string true none Code externe
» delivery_date string(date) false none Date de livraison du projet
» last_update_date string(date) false none Date de dernière mise à jour
» client_internal_number string false none Client Internal N°
» client_account ClientAccountDTO false none none
»» id integer false none Clé primaire
»» name string true none Nom de la phase
»» external_code string false none Code externe

Créer projet

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects

Body parameter

{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}

Parameters

Parameter In Type Required Description
body body ProjectDTO2 true Données d'entrée

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie ProjectDTO
400 Bad Request Les données de la requête sont invalides None
403 Forbidden User doesn't have role to create project None
404 Not Found l'URL saisie est invalide None

Détails du projet

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne le projet ProjectDTO
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Mise à jour d'un projet via l'identifiant

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}

Body parameter

{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
body body ProjectDTO3 true Données d'entrée

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès ProjectDTO
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Patch up the project by id

Code samples

# You can also use wget
curl -X PATCH /api.kaliti.test/v2/projects/{project} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH /api.kaliti.test/v2/projects/{project} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api.kaliti.test/v2/projects/{project}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api.kaliti.test/v2/projects/{project}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api.kaliti.test/v2/projects/{project}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /v2/projects/{project}

Body parameter

{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
body body ProjectDTO4 true Données d'entrée

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Patched up successfully ProjectDTO
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Acheteur

Liste des acheteurs pour l'utilisateur courant

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/purchasers \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/purchasers HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/purchasers',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/purchasers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/purchasers',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/purchasers', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/purchasers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/purchasers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/purchasers

Parameters

Parameter In Type Required Description
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
counting query boolean false Disable total items counting for performance boost
locale query string false Langue
filters[project_external_code] query string false Filtrer sur le code externe du projet
filters[name] query string false Filtre sur le nom de famille de l'acheteur
filters[occupant_is_active] query boolean false Filtre sur l'acheteur qui a des locataires ou non
filters[occupant_name] query string false Filtre sur le nom du locataire (à utiliser en combinaison avec occupant_is_active_filter)
filters[occupant_email] query string false Filtre sur l'email du locataire (à utiliser en combinaison avec occupant_is_active_filter)
filters[purchaser_code] query string false Filtre sur le code de l'acheteur
filters[lot] query string false filter on lot name
filters[lot_external_code] query string false filter on lot external code
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des acheteurs pour l'utilisateur courant PurchaserDTO
400 Bad Request Invalid data None
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Liste des acheteurs pour le projet courant

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/purchasers \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/purchasers HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchasers',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchasers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/purchasers',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/purchasers', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchasers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/purchasers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/purchasers

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[name] query string false Filtre sur le nom de famille de l'acheteur
filters[occupant_is_active] query boolean false Filtre sur l'acheteur qui a des locataires ou non
filters[occupant_name] query string false Filtre sur le nom du locataire (à utiliser en combinaison avec occupant_is_active_filter)
filters[occupant_email] query string false Filtre sur l'email du locataire (à utiliser en combinaison avec occupant_is_active_filter)
filters[purchaser_code] query string false Filtre sur le code de l'acheteur
filters[lot] query string false filter on lot name
filters[lot_external_code] query string false filter on lot external code
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des acheteurs pour le projet courant PurchaserDTO
400 Bad Request Invalid data None
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Créer un acheteur

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/purchasers \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/purchasers HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchasers',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchasers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/purchasers',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/purchasers', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchasers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/purchasers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/purchasers

Body parameter

{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
locale query string false Langue
body body PurchaserDTO2 true Détails de l'acheteur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie PurchaserDTO
403 Forbidden User does not have role to create purchaser or doesn't have access to the project None
404 Not Found Le projet n'existe pas None

Détails de l'acheteur

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/purchasers/{purchaser}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
purchaser path string true Filtre sur le code de l'acheteur
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne les données de l'acheteur PurchaserDTO
403 Forbidden User can't see purchasers inside project or isn't linked to project None
404 Not Found l'URL saisie est invalide None

Mise à jour acheteur

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/purchasers/{purchaser}

Body parameter

{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
purchaser path string true Filtre sur le code de l'acheteur
locale query string false Langue
body body PurchaserDTO3 true none

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès PurchaserDTO
403 Forbidden User does not have role to update purchaser or doesn't have access to the project None
404 Not Found Le projet ou l'acheteur n'existent pas None

Patch up purchaser

Code samples

# You can also use wget
curl -X PATCH /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /v2/projects/{project}/purchasers/{purchaser}

Body parameter

{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
purchaser path string true Filtre sur le code de l'acheteur
locale query string false Langue
body body PurchaserDTO4 true none

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Patched up successfully PurchaserDTO
403 Forbidden User does not have role to update purchaser or doesn't have access to the project None
404 Not Found Le projet ou l'acheteur n'existent pas None

Supprimer l'acheteur

Code samples

# You can also use wget
curl -X DELETE /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} \
  -H 'Authorization: Bearer {access-token}'


DELETE /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser} HTTP/1.1


var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v2/projects/{project}/purchasers/{purchaser}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
purchaser path string true Filtre sur le code de l'acheteur

Responses

Status Meaning Description Schema
204 No Content Suppression effectuée avec succès None
403 Forbidden User doesn't have role to delete purchaser or doesn't have access to the project None
404 Not Found Le projet ou l'acheteur n'existent pas None

Envoi invitation acheteur

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/purchasers/{purchaser}/invitation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/purchasers/{purchaser}/invitation

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
purchaser path string true Filtre sur le code de l'acheteur
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie PurchaserDTO
403 Forbidden User does not have role to send purchaser invitation or doesn't have access to the project None
404 Not Found Le projet n'existe pas None

Dates jalons

Récupère la liste des dates de réceptions, Dates de fin GPA, Dates de fin décennale pour un projet

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/receptions \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/receptions HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/receptions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/receptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/receptions',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/receptions', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/receptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/receptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/receptions

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
filters[zone_category] query string false Filter by plan zone category
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of receptions in a specific project ReceptionDTO
404 Not Found l'URL saisie est invalide None

Récupère la liste des dates de livraison, dates de lettre à 30 jours pour tous les lots d'un projet

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/delivery \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/delivery HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/delivery',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/delivery',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/delivery',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/delivery', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/delivery");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/delivery", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/delivery

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
filters[external_code] query string false Filter on lot external code
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of delivery dates + cover to 30 days dates of all lots of a specific project DeliveryDTO
404 Not Found l'URL saisie est invalide None

Handover protocol / visit report

Liste des PV de livraison pour le projet

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/handover-protocols \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/handover-protocols HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/handover-protocols',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/handover-protocols',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/handover-protocols',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/handover-protocols', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/handover-protocols");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/handover-protocols", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/handover-protocols

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
filters[phase_external_code] query string false Filtrer sur le code externe de la phase
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[purchaser_id] query integer false Identifiant de l'acheteur
filters[purchaser_code] query string false Filtre sur le code de l'acheteur
filters[lot_id] query integer false Lot ID
filters[lot_external_code] query string false Lot external code

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of handover protocols Inline
403 Forbidden User can't access handover protocols None
404 Not Found No handover protocol has been found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [HandoverProtocolDTO] false none none
» id integer false none Clé primaire
» name string false none Report name
» create_date string(date) false none Date de création
» url string false none Report URL
» purchasers [PurchaserDTO5] false none Fiche preneurs
»» id integer true none Clé primaire
»» external_code string false none Purchaser code
» project ProjectDTO5 false none none
»» id integer false none Clé primaire
»» external_code string false none Code externe
» phase integer false none none
» phase_external_code string false none Code externe

Liste des PV de livraison pour le projet et acheteur spécifique

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/purchaser/{purchaser}/handover-protocols", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/purchaser/{purchaser}/handover-protocols

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
filters[phase_external_code] query string false Filtrer sur le code externe de la phase
purchaser path string true Filtre sur le code de l'acheteur
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[lot_id] query integer false Lot ID
filters[lot_external_code] query string false Lot external code

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of handover protocols Inline
403 Forbidden User can't access handover protocols None
404 Not Found No handover protocol has been found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [HandoverProtocolDTO] false none none
» id integer false none Clé primaire
» name string false none Report name
» create_date string(date) false none Date de création
» url string false none Report URL
» purchasers [PurchaserDTO5] false none Fiche preneurs
»» id integer true none Clé primaire
»» external_code string false none Purchaser code
» project ProjectDTO5 false none none
»» id integer false none Clé primaire
»» external_code string false none Code externe
» phase integer false none none
» phase_external_code string false none Code externe

Liste des PV de livraison pour le projet et lot

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/lot/{lot}/handover-protocols", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/lot/{lot}/handover-protocols

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
filters[phase_external_code] query string false Filtrer sur le code externe de la phase
lot path string true Lot external code
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[purchaser_id] query integer false Identifiant de l'acheteur
filters[purchaser_code] query string false Filtre sur le code de l'acheteur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of handover protocols Inline
403 Forbidden User can't access handover protocols None
404 Not Found No handover protocol has been found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [HandoverProtocolDTO] false none none
» id integer false none Clé primaire
» name string false none Report name
» create_date string(date) false none Date de création
» url string false none Report URL
» purchasers [PurchaserDTO5] false none Fiche preneurs
»» id integer true none Clé primaire
»» external_code string false none Purchaser code
» project ProjectDTO5 false none none
»» id integer false none Clé primaire
»» external_code string false none Code externe
» phase integer false none none
» phase_external_code string false none Code externe

Réserve

Liste des réserves liés à l'utilisateur

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/snags \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/snags HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/snags',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/snags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/snags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/snags', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/snags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/snags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/snags

Parameters

Parameter In Type Required Description
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
counting query boolean false Disable total items counting for performance boost
locale query string false Langue
filters[project_external_code] query string false Filtrer sur le code externe du projet
filters[phase_external_code] query string false Filtrer sur le code externe de la phase
filters[plan_external_code] query string false Filtrer sur le code externe du plan
filters[plan_number] query string false Filtre sur le numéro du plan
filters[company] query integer false Filtre sur l'entreprise qui a crée la réserve
filters[company.external_code] query string false Filter sur le code externe de l'entreprise
filters[sub_company] query integer false Filtre sur la sous-entreprise qui a crée la réserve
filters[responsible] query integer false Filtre sur l'entreprise qui est responsable de la réserve
filters[transmitter] query integer false Filtre sur l'entreprise qui a transmis la réserve
filters[label] query string false Filtre sur le libellé de la réserve
filters[status] query string false Filtre sur le statut de la réserve (red, purple, darkorange, blue, green, darkgreen)
filters[after_sales_code] query string false Filtrer sur le code SAV de la réserve
filters[number] query integer false Filtre sur le numéro de la réserve
filters[after_diffusion_date] query string(date-time) false Filtre toutes les réserves dont la date de diffusion est égale ou postérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[before_diffusion_date] query string(date-time) false Filtre toutes les réserves dont la date de diffusion est égale ou antérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[after_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou postérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[before_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou antérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[compensation_id] query integer false filter on compensation id
filters[lot] query string false filter on lot name
filters[lot_external_code] query string false filter on lot external code
filters[purchaser_code] query string false Filtre sur le code de l'acheteur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des réserves pour l'utilisateur courant Inline
400 Bad Request Invalid data None
403 Forbidden L'utilisateur n'a pas le rôle d'accès à la visualisation des réserves None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SnagDTO] false none none
» id integer false none Clé primaire
» number integer false none Numéro de la réserve
» label string false none Libellé de la réserve
» status string false none Snag status * red * purple * darkorange * blue * light green * dark green
» support string false none Réserve
» nature string false none Nature de la réserve
» type string false none Type de la réserve
» item string false none Snag item
» issue string false none Snag issue
» zone string false none Zone de la réserve
» visit_date string(date) false none Date de visite de la réserve
» diffusion_date string(date) false none Date de diffusion de la réserve
» end_date string(date) false none Date de fin de la réserve
» create_date string(date) false none Date de création de la réserve
» create_account_id integer true none Identifiant du compte ayant créé la réserve
» last_update_date string(date) false none Date de dernière mise à jour de la réserve
» last_update_account_id integer false none Identifiant du compte ayant modifié la réserve
» check_date_enterprise string(date) false none Date de vérification par l'entreprise de la réserve
» check_enterprise_account_id integer false none Identifiant du compte de l'entreprise qui a vérifié la réserve
» check_date_eg string(date) false none Date de vérification de la réserve de l'entreprise générale
» check_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a vérifié la réserve
» check_date_moe string(date) false none Date de vérification de la réserve de la MOE
» check_moe_account_id integer false none Identifiant du compte de la MOE qui a vérifié la réserve
» check_date_mo string(date) false none Date de vérification de la réserve de la MO
» check_mo_account_id integer false none Identifiant du compte de la MO qui a vérifié la réserve
» check_date_purchaser string(date) false none Snag check date of purchaser
» check_purchaser_account_id integer false none Account ID of purchaser that checked the snag
» comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
» comment_moe string false none Comentaire de la MO sur la réserve
» photo1 string false none URL de la première photo de la réserve
» photo2 string false none URL de la deuxième phoot de la réserve
» x number true none Coordonée X de la réserve
» y number true none Coordonnée Y de la réserve
» z integer false none Coordonnée Z de la réserve
» last_refuse_ent_date string(date) false none Dernière date de refus de l'entreprise
» last_refuse_ent_account_id integer false none Identifiant du compte de l'entreprise qui a refusé la réserve
» last_refuse_eg_date string(date) false none Date de refus de l'entreprise générale
» last_refuse_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a refusé la réserve
» last_refuse_moe_date string(date) false none Date de refus de la MOE
» last_refuse_moe_account_id integer false none Identifiant du compte de la MOE ayant refusé la réserve
» acceptance_date string(date) false none Date d'acceptation de la réserve
» acceptance_comment string false none Commentaire de l'acceptation de la réserve
» signature_ent string false none Signature de l'entreprise
» signatory_ent string false none Nom du signataire de l'entreprise
» signature_eg string false none Signature de l'entreprise générale
» signatory_eg string false none Nom du signataire de l'entreprise générale
» signature_moe string false none Signature de la MOE
» signatory_moe string false none Nom du signataire de la MOE
» signature_mo string false none Signature de la MO
» signatory_mo string false none Nom du signataire de la MO
» signature_purchaser string false none Snag purchaser signature
» signatory_purchaser string false none Snag purchaser signatory
» after_sales_code string false none Code SAV de la réserve
» compensation_id integer false none Compensation ID
» commitment_time integer false none Snag compensation time
» commitment_deadline string(date) false none Snag commitment deadline
» discharge string false none Discharge source URL
» intervention_slip string false none Intervention slip source URL
» deadline_date_type_id integer false none Snag deadline date type id
» deadline_nb_days integer false none Snag deadline number of days
» deadline_day_type_id integer false none Snag deadline day type id
» deadline_penalty_fee integer false none Snag deadline penalty fee
» company CompanyDTO5 false none none
»» id integer false none Clé primaire
»» name string true none Raison sociale de l'entreprise
»» package [LinksCompaniesPackagesDTO] true none Package name
»»» link_company_package_id integer false none Clé primaire
»»» package_name string true none Package's name
»»» package_number string false none Lot N°
»»» package_trade_code string false none Package Trade code
»»» color string false none Couleur (Exemple : fff000)
»» external_code string false none Code externe
» sub_company CompanyDTO5 false none none
» responsible CompanyDTO5 false none none
» transmitter CompanyDTO5 false none none
» priority PriorityDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de la priorité (Exemple : La plus haute)
» acceptance AcceptanceDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de l'acceptance (Accepté refusé)
» project_id integer false none ID du projet
» project_external_code string false none Code externe
» phase_id integer false none Identifiant de la phase
» phase_external_code string false none Code externe
» plan_id integer false none Identifiant du plan
» plan_number string false none Numéro du plan (Exemple : B02)
» plan_external_code string false none Code externe
» purchaser_code string false none Purchaser code
» lot_external_code string false none Lot external code

Liste des réserves liés au projet

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/snags \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/snags HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/snags',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/snags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/snags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/snags', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/snags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/snags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/snags

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[phase_external_code] query string false Filtrer sur le code externe de la phase
filters[plan_external_code] query string false Filtrer sur le code externe du plan
filters[plan_number] query string false Filtre sur le numéro du plan
filters[company] query integer false Filtre sur l'entreprise qui a crée la réserve
filters[sub_company] query integer false Filtre sur la sous-entreprise qui a crée la réserve
filters[responsible] query integer false Filtre sur l'entreprise qui est responsable de la réserve
filters[transmitter] query integer false Filtre sur l'entreprise qui a transmis la réserve
filters[label] query string false Filtre sur le libellé de la réserve
filters[status] query string false Filtre sur le statut de la réserve (red, purple, darkorange, blue, green, darkgreen)
filters[after_sales_code] query string false Filtrer sur le code SAV de la réserve
filters[number] query integer false Filtre sur le numéro de la réserve
filters[after_diffusion_date] query string(date-time) false Filtre toutes les réserves dont la date de diffusion est égale ou postérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[before_diffusion_date] query string(date-time) false Filtre toutes les réserves dont la date de diffusion est égale ou antérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[after_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou postérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[before_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou antérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[compensation_id] query integer false filter on compensation id
filters[lot] query string false filter on lot name
filters[lot_external_code] query string false filter on lot external code
filters[purchaser_code] query string false Filtre sur le code de l'acheteur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des réserves de ce projet Inline
400 Bad Request Invalid data None
403 Forbidden L'utilisateur n'a pas le rôle d'accès à la visualisation des réserves None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SnagDTO] false none none
» id integer false none Clé primaire
» number integer false none Numéro de la réserve
» label string false none Libellé de la réserve
» status string false none Snag status * red * purple * darkorange * blue * light green * dark green
» support string false none Réserve
» nature string false none Nature de la réserve
» type string false none Type de la réserve
» item string false none Snag item
» issue string false none Snag issue
» zone string false none Zone de la réserve
» visit_date string(date) false none Date de visite de la réserve
» diffusion_date string(date) false none Date de diffusion de la réserve
» end_date string(date) false none Date de fin de la réserve
» create_date string(date) false none Date de création de la réserve
» create_account_id integer true none Identifiant du compte ayant créé la réserve
» last_update_date string(date) false none Date de dernière mise à jour de la réserve
» last_update_account_id integer false none Identifiant du compte ayant modifié la réserve
» check_date_enterprise string(date) false none Date de vérification par l'entreprise de la réserve
» check_enterprise_account_id integer false none Identifiant du compte de l'entreprise qui a vérifié la réserve
» check_date_eg string(date) false none Date de vérification de la réserve de l'entreprise générale
» check_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a vérifié la réserve
» check_date_moe string(date) false none Date de vérification de la réserve de la MOE
» check_moe_account_id integer false none Identifiant du compte de la MOE qui a vérifié la réserve
» check_date_mo string(date) false none Date de vérification de la réserve de la MO
» check_mo_account_id integer false none Identifiant du compte de la MO qui a vérifié la réserve
» check_date_purchaser string(date) false none Snag check date of purchaser
» check_purchaser_account_id integer false none Account ID of purchaser that checked the snag
» comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
» comment_moe string false none Comentaire de la MO sur la réserve
» photo1 string false none URL de la première photo de la réserve
» photo2 string false none URL de la deuxième phoot de la réserve
» x number true none Coordonée X de la réserve
» y number true none Coordonnée Y de la réserve
» z integer false none Coordonnée Z de la réserve
» last_refuse_ent_date string(date) false none Dernière date de refus de l'entreprise
» last_refuse_ent_account_id integer false none Identifiant du compte de l'entreprise qui a refusé la réserve
» last_refuse_eg_date string(date) false none Date de refus de l'entreprise générale
» last_refuse_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a refusé la réserve
» last_refuse_moe_date string(date) false none Date de refus de la MOE
» last_refuse_moe_account_id integer false none Identifiant du compte de la MOE ayant refusé la réserve
» acceptance_date string(date) false none Date d'acceptation de la réserve
» acceptance_comment string false none Commentaire de l'acceptation de la réserve
» signature_ent string false none Signature de l'entreprise
» signatory_ent string false none Nom du signataire de l'entreprise
» signature_eg string false none Signature de l'entreprise générale
» signatory_eg string false none Nom du signataire de l'entreprise générale
» signature_moe string false none Signature de la MOE
» signatory_moe string false none Nom du signataire de la MOE
» signature_mo string false none Signature de la MO
» signatory_mo string false none Nom du signataire de la MO
» signature_purchaser string false none Snag purchaser signature
» signatory_purchaser string false none Snag purchaser signatory
» after_sales_code string false none Code SAV de la réserve
» compensation_id integer false none Compensation ID
» commitment_time integer false none Snag compensation time
» commitment_deadline string(date) false none Snag commitment deadline
» discharge string false none Discharge source URL
» intervention_slip string false none Intervention slip source URL
» deadline_date_type_id integer false none Snag deadline date type id
» deadline_nb_days integer false none Snag deadline number of days
» deadline_day_type_id integer false none Snag deadline day type id
» deadline_penalty_fee integer false none Snag deadline penalty fee
» company CompanyDTO5 false none none
»» id integer false none Clé primaire
»» name string true none Raison sociale de l'entreprise
»» package [LinksCompaniesPackagesDTO] true none Package name
»»» link_company_package_id integer false none Clé primaire
»»» package_name string true none Package's name
»»» package_number string false none Lot N°
»»» package_trade_code string false none Package Trade code
»»» color string false none Couleur (Exemple : fff000)
»» external_code string false none Code externe
» sub_company CompanyDTO5 false none none
» responsible CompanyDTO5 false none none
» transmitter CompanyDTO5 false none none
» priority PriorityDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de la priorité (Exemple : La plus haute)
» acceptance AcceptanceDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de l'acceptance (Accepté refusé)
» project_id integer false none ID du projet
» project_external_code string false none Code externe
» phase_id integer false none Identifiant de la phase
» phase_external_code string false none Code externe
» plan_id integer false none Identifiant du plan
» plan_number string false none Numéro du plan (Exemple : B02)
» plan_external_code string false none Code externe
» purchaser_code string false none Purchaser code
» lot_external_code string false none Lot external code

Liste des réserves liés à ce projet et ce plan

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/plans/{plan}/snags \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/plans/{plan}/snags HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/plans/{plan}/snags',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/plans/{plan}/snags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/plans/{plan}/snags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/plans/{plan}/snags', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/plans/{plan}/snags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/plans/{plan}/snags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/plans/{plan}/snags

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
plan path string true Filtre sur le numéro du plan
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[company] query integer false Filtre sur l'entreprise qui a crée la réserve
filters[sub_company] query integer false Filtre sur la sous-entreprise qui a crée la réserve
filters[responsible] query integer false Filtre sur l'entreprise qui est responsable de la réserve
filters[transmitter] query integer false Filtre sur l'entreprise qui a transmis la réserve
filters[label] query string false Filtre sur le libellé de la réserve
filters[status] query string false Filtre sur le statut de la réserve (red, purple, darkorange, blue, green, darkgreen)
filters[number] query integer false Filtre sur le numéro de la réserve
filters[after_sales_code] query string false Filtrer sur le code SAV de la réserve
filters[after_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou postérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[before_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou antérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[compensation_id] query integer false filter on compensation id
filters[lot] query string false filter on lot name
filters[lot_external_code] query string false filter on lot external code
filters[purchaser_code] query string false Filtre sur le code de l'acheteur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des réserves pour ce projet et ce plan Inline
400 Bad Request Invalid data None
403 Forbidden L'utilisateur n'a pas le rôle d'accès à la visualisation des réserves None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SnagDTO] false none none
» id integer false none Clé primaire
» number integer false none Numéro de la réserve
» label string false none Libellé de la réserve
» status string false none Snag status * red * purple * darkorange * blue * light green * dark green
» support string false none Réserve
» nature string false none Nature de la réserve
» type string false none Type de la réserve
» item string false none Snag item
» issue string false none Snag issue
» zone string false none Zone de la réserve
» visit_date string(date) false none Date de visite de la réserve
» diffusion_date string(date) false none Date de diffusion de la réserve
» end_date string(date) false none Date de fin de la réserve
» create_date string(date) false none Date de création de la réserve
» create_account_id integer true none Identifiant du compte ayant créé la réserve
» last_update_date string(date) false none Date de dernière mise à jour de la réserve
» last_update_account_id integer false none Identifiant du compte ayant modifié la réserve
» check_date_enterprise string(date) false none Date de vérification par l'entreprise de la réserve
» check_enterprise_account_id integer false none Identifiant du compte de l'entreprise qui a vérifié la réserve
» check_date_eg string(date) false none Date de vérification de la réserve de l'entreprise générale
» check_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a vérifié la réserve
» check_date_moe string(date) false none Date de vérification de la réserve de la MOE
» check_moe_account_id integer false none Identifiant du compte de la MOE qui a vérifié la réserve
» check_date_mo string(date) false none Date de vérification de la réserve de la MO
» check_mo_account_id integer false none Identifiant du compte de la MO qui a vérifié la réserve
» check_date_purchaser string(date) false none Snag check date of purchaser
» check_purchaser_account_id integer false none Account ID of purchaser that checked the snag
» comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
» comment_moe string false none Comentaire de la MO sur la réserve
» photo1 string false none URL de la première photo de la réserve
» photo2 string false none URL de la deuxième phoot de la réserve
» x number true none Coordonée X de la réserve
» y number true none Coordonnée Y de la réserve
» z integer false none Coordonnée Z de la réserve
» last_refuse_ent_date string(date) false none Dernière date de refus de l'entreprise
» last_refuse_ent_account_id integer false none Identifiant du compte de l'entreprise qui a refusé la réserve
» last_refuse_eg_date string(date) false none Date de refus de l'entreprise générale
» last_refuse_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a refusé la réserve
» last_refuse_moe_date string(date) false none Date de refus de la MOE
» last_refuse_moe_account_id integer false none Identifiant du compte de la MOE ayant refusé la réserve
» acceptance_date string(date) false none Date d'acceptation de la réserve
» acceptance_comment string false none Commentaire de l'acceptation de la réserve
» signature_ent string false none Signature de l'entreprise
» signatory_ent string false none Nom du signataire de l'entreprise
» signature_eg string false none Signature de l'entreprise générale
» signatory_eg string false none Nom du signataire de l'entreprise générale
» signature_moe string false none Signature de la MOE
» signatory_moe string false none Nom du signataire de la MOE
» signature_mo string false none Signature de la MO
» signatory_mo string false none Nom du signataire de la MO
» signature_purchaser string false none Snag purchaser signature
» signatory_purchaser string false none Snag purchaser signatory
» after_sales_code string false none Code SAV de la réserve
» compensation_id integer false none Compensation ID
» commitment_time integer false none Snag compensation time
» commitment_deadline string(date) false none Snag commitment deadline
» discharge string false none Discharge source URL
» intervention_slip string false none Intervention slip source URL
» deadline_date_type_id integer false none Snag deadline date type id
» deadline_nb_days integer false none Snag deadline number of days
» deadline_day_type_id integer false none Snag deadline day type id
» deadline_penalty_fee integer false none Snag deadline penalty fee
» company CompanyDTO5 false none none
»» id integer false none Clé primaire
»» name string true none Raison sociale de l'entreprise
»» package [LinksCompaniesPackagesDTO] true none Package name
»»» link_company_package_id integer false none Clé primaire
»»» package_name string true none Package's name
»»» package_number string false none Lot N°
»»» package_trade_code string false none Package Trade code
»»» color string false none Couleur (Exemple : fff000)
»» external_code string false none Code externe
» sub_company CompanyDTO5 false none none
» responsible CompanyDTO5 false none none
» transmitter CompanyDTO5 false none none
» priority PriorityDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de la priorité (Exemple : La plus haute)
» acceptance AcceptanceDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de l'acceptance (Accepté refusé)
» project_id integer false none ID du projet
» project_external_code string false none Code externe
» phase_id integer false none Identifiant de la phase
» phase_external_code string false none Code externe
» plan_id integer false none Identifiant du plan
» plan_number string false none Numéro du plan (Exemple : B02)
» plan_external_code string false none Code externe
» purchaser_code string false none Purchaser code
» lot_external_code string false none Lot external code

Liste des réserves liés au projet et à la phase

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/snags \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/snags HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/snags',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/snags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases/{phase}/snags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases/{phase}/snags', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/snags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/snags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases/{phase}/snags

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[plan_external_code] query string false Filtrer sur le code externe du plan
filters[plan_number] query string false Filtre sur le numéro du plan
filters[company] query integer false Filtre sur l'entreprise qui a crée la réserve
filters[sub_company] query integer false Filtre sur la sous-entreprise qui a crée la réserve
filters[responsible] query integer false Filtre sur l'entreprise qui est responsable de la réserve
filters[transmitter] query integer false Filtre sur l'entreprise qui a transmis la réserve
filters[label] query string false Filtre sur le libellé de la réserve
filters[status] query string false Filtre sur le statut de la réserve (red, purple, darkorange, blue, green, darkgreen)
filters[after_sales_code] query string false Filtrer sur le code SAV de la réserve
filters[number] query integer false Filtre sur le numéro de la réserve
filters[after_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou postérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[before_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou antérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[compensation_id] query integer false filter on compensation id
filters[lot] query string false filter on lot name
filters[lot_external_code] query string false filter on lot external code
filters[purchaser_code] query string false Filtre sur le code de l'acheteur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des réserves de ce projet et de cette phase Inline
400 Bad Request Invalid data None
403 Forbidden User has no role to view snags or isn't linked to phase None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SnagDTO] false none none
» id integer false none Clé primaire
» number integer false none Numéro de la réserve
» label string false none Libellé de la réserve
» status string false none Snag status * red * purple * darkorange * blue * light green * dark green
» support string false none Réserve
» nature string false none Nature de la réserve
» type string false none Type de la réserve
» item string false none Snag item
» issue string false none Snag issue
» zone string false none Zone de la réserve
» visit_date string(date) false none Date de visite de la réserve
» diffusion_date string(date) false none Date de diffusion de la réserve
» end_date string(date) false none Date de fin de la réserve
» create_date string(date) false none Date de création de la réserve
» create_account_id integer true none Identifiant du compte ayant créé la réserve
» last_update_date string(date) false none Date de dernière mise à jour de la réserve
» last_update_account_id integer false none Identifiant du compte ayant modifié la réserve
» check_date_enterprise string(date) false none Date de vérification par l'entreprise de la réserve
» check_enterprise_account_id integer false none Identifiant du compte de l'entreprise qui a vérifié la réserve
» check_date_eg string(date) false none Date de vérification de la réserve de l'entreprise générale
» check_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a vérifié la réserve
» check_date_moe string(date) false none Date de vérification de la réserve de la MOE
» check_moe_account_id integer false none Identifiant du compte de la MOE qui a vérifié la réserve
» check_date_mo string(date) false none Date de vérification de la réserve de la MO
» check_mo_account_id integer false none Identifiant du compte de la MO qui a vérifié la réserve
» check_date_purchaser string(date) false none Snag check date of purchaser
» check_purchaser_account_id integer false none Account ID of purchaser that checked the snag
» comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
» comment_moe string false none Comentaire de la MO sur la réserve
» photo1 string false none URL de la première photo de la réserve
» photo2 string false none URL de la deuxième phoot de la réserve
» x number true none Coordonée X de la réserve
» y number true none Coordonnée Y de la réserve
» z integer false none Coordonnée Z de la réserve
» last_refuse_ent_date string(date) false none Dernière date de refus de l'entreprise
» last_refuse_ent_account_id integer false none Identifiant du compte de l'entreprise qui a refusé la réserve
» last_refuse_eg_date string(date) false none Date de refus de l'entreprise générale
» last_refuse_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a refusé la réserve
» last_refuse_moe_date string(date) false none Date de refus de la MOE
» last_refuse_moe_account_id integer false none Identifiant du compte de la MOE ayant refusé la réserve
» acceptance_date string(date) false none Date d'acceptation de la réserve
» acceptance_comment string false none Commentaire de l'acceptation de la réserve
» signature_ent string false none Signature de l'entreprise
» signatory_ent string false none Nom du signataire de l'entreprise
» signature_eg string false none Signature de l'entreprise générale
» signatory_eg string false none Nom du signataire de l'entreprise générale
» signature_moe string false none Signature de la MOE
» signatory_moe string false none Nom du signataire de la MOE
» signature_mo string false none Signature de la MO
» signatory_mo string false none Nom du signataire de la MO
» signature_purchaser string false none Snag purchaser signature
» signatory_purchaser string false none Snag purchaser signatory
» after_sales_code string false none Code SAV de la réserve
» compensation_id integer false none Compensation ID
» commitment_time integer false none Snag compensation time
» commitment_deadline string(date) false none Snag commitment deadline
» discharge string false none Discharge source URL
» intervention_slip string false none Intervention slip source URL
» deadline_date_type_id integer false none Snag deadline date type id
» deadline_nb_days integer false none Snag deadline number of days
» deadline_day_type_id integer false none Snag deadline day type id
» deadline_penalty_fee integer false none Snag deadline penalty fee
» company CompanyDTO5 false none none
»» id integer false none Clé primaire
»» name string true none Raison sociale de l'entreprise
»» package [LinksCompaniesPackagesDTO] true none Package name
»»» link_company_package_id integer false none Clé primaire
»»» package_name string true none Package's name
»»» package_number string false none Lot N°
»»» package_trade_code string false none Package Trade code
»»» color string false none Couleur (Exemple : fff000)
»» external_code string false none Code externe
» sub_company CompanyDTO5 false none none
» responsible CompanyDTO5 false none none
» transmitter CompanyDTO5 false none none
» priority PriorityDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de la priorité (Exemple : La plus haute)
» acceptance AcceptanceDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de l'acceptance (Accepté refusé)
» project_id integer false none ID du projet
» project_external_code string false none Code externe
» phase_id integer false none Identifiant de la phase
» phase_external_code string false none Code externe
» plan_id integer false none Identifiant du plan
» plan_number string false none Numéro du plan (Exemple : B02)
» plan_external_code string false none Code externe
» purchaser_code string false none Purchaser code
» lot_external_code string false none Lot external code

Liste des réserves

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases/{phase}/plans/{plan}/snags

Liste des réserves liés au projet, à la phase, au plan

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[company] query integer false Filtre sur l'entreprise qui a crée la réserve
filters[sub_company] query integer false Filtre sur la sous-entreprise qui a crée la réserve
filters[responsible] query integer false Filtre sur l'entreprise qui est responsable de la réserve
filters[transmitter] query integer false Filtre sur l'entreprise qui a transmis la réserve
filters[label] query string false Filtre sur le libellé de la réserve
filters[status] query string false Filtre sur le statut de la réserve (red, purple, darkorange, blue, green, darkgreen)
filters[after_sales_code] query string false Filtrer sur le code SAV de la réserve
filters[number] query integer false Filtre sur le numéro de la réserve
filters[after_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou postérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[before_visit_date] query string(date-time) false Filtre toutes les réserves dont la date de visite est égale ou antérieure à la date spécifiée (YYYY-MM-DD hh:mm:ss)
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[compensation_id] query integer false filter on compensation id
filters[lot] query string false filter on lot name
filters[lot_external_code] query string false filter on lot external code
filters[purchaser_code] query string false Filtre sur le code de l'acheteur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Retourne la liste des réserves pour ce projet, cette phase et ce plan Inline
400 Bad Request Invalid data None
403 Forbidden L'utilisateur n'est pas liés à cette phase ou n'a pas accès à la visualisation des réserves None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SnagDTO] false none none
» id integer false none Clé primaire
» number integer false none Numéro de la réserve
» label string false none Libellé de la réserve
» status string false none Snag status * red * purple * darkorange * blue * light green * dark green
» support string false none Réserve
» nature string false none Nature de la réserve
» type string false none Type de la réserve
» item string false none Snag item
» issue string false none Snag issue
» zone string false none Zone de la réserve
» visit_date string(date) false none Date de visite de la réserve
» diffusion_date string(date) false none Date de diffusion de la réserve
» end_date string(date) false none Date de fin de la réserve
» create_date string(date) false none Date de création de la réserve
» create_account_id integer true none Identifiant du compte ayant créé la réserve
» last_update_date string(date) false none Date de dernière mise à jour de la réserve
» last_update_account_id integer false none Identifiant du compte ayant modifié la réserve
» check_date_enterprise string(date) false none Date de vérification par l'entreprise de la réserve
» check_enterprise_account_id integer false none Identifiant du compte de l'entreprise qui a vérifié la réserve
» check_date_eg string(date) false none Date de vérification de la réserve de l'entreprise générale
» check_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a vérifié la réserve
» check_date_moe string(date) false none Date de vérification de la réserve de la MOE
» check_moe_account_id integer false none Identifiant du compte de la MOE qui a vérifié la réserve
» check_date_mo string(date) false none Date de vérification de la réserve de la MO
» check_mo_account_id integer false none Identifiant du compte de la MO qui a vérifié la réserve
» check_date_purchaser string(date) false none Snag check date of purchaser
» check_purchaser_account_id integer false none Account ID of purchaser that checked the snag
» comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
» comment_moe string false none Comentaire de la MO sur la réserve
» photo1 string false none URL de la première photo de la réserve
» photo2 string false none URL de la deuxième phoot de la réserve
» x number true none Coordonée X de la réserve
» y number true none Coordonnée Y de la réserve
» z integer false none Coordonnée Z de la réserve
» last_refuse_ent_date string(date) false none Dernière date de refus de l'entreprise
» last_refuse_ent_account_id integer false none Identifiant du compte de l'entreprise qui a refusé la réserve
» last_refuse_eg_date string(date) false none Date de refus de l'entreprise générale
» last_refuse_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a refusé la réserve
» last_refuse_moe_date string(date) false none Date de refus de la MOE
» last_refuse_moe_account_id integer false none Identifiant du compte de la MOE ayant refusé la réserve
» acceptance_date string(date) false none Date d'acceptation de la réserve
» acceptance_comment string false none Commentaire de l'acceptation de la réserve
» signature_ent string false none Signature de l'entreprise
» signatory_ent string false none Nom du signataire de l'entreprise
» signature_eg string false none Signature de l'entreprise générale
» signatory_eg string false none Nom du signataire de l'entreprise générale
» signature_moe string false none Signature de la MOE
» signatory_moe string false none Nom du signataire de la MOE
» signature_mo string false none Signature de la MO
» signatory_mo string false none Nom du signataire de la MO
» signature_purchaser string false none Snag purchaser signature
» signatory_purchaser string false none Snag purchaser signatory
» after_sales_code string false none Code SAV de la réserve
» compensation_id integer false none Compensation ID
» commitment_time integer false none Snag compensation time
» commitment_deadline string(date) false none Snag commitment deadline
» discharge string false none Discharge source URL
» intervention_slip string false none Intervention slip source URL
» deadline_date_type_id integer false none Snag deadline date type id
» deadline_nb_days integer false none Snag deadline number of days
» deadline_day_type_id integer false none Snag deadline day type id
» deadline_penalty_fee integer false none Snag deadline penalty fee
» company CompanyDTO5 false none none
»» id integer false none Clé primaire
»» name string true none Raison sociale de l'entreprise
»» package [LinksCompaniesPackagesDTO] true none Package name
»»» link_company_package_id integer false none Clé primaire
»»» package_name string true none Package's name
»»» package_number string false none Lot N°
»»» package_trade_code string false none Package Trade code
»»» color string false none Couleur (Exemple : fff000)
»» external_code string false none Code externe
» sub_company CompanyDTO5 false none none
» responsible CompanyDTO5 false none none
» transmitter CompanyDTO5 false none none
» priority PriorityDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de la priorité (Exemple : La plus haute)
» acceptance AcceptanceDTO false none none
»» id integer true none Clé primaire
»» name string false none Libellé de l'acceptance (Accepté refusé)
» project_id integer false none ID du projet
» project_external_code string false none Code externe
» phase_id integer false none Identifiant de la phase
» phase_external_code string false none Code externe
» plan_id integer false none Identifiant du plan
» plan_number string false none Numéro du plan (Exemple : B02)
» plan_external_code string false none Code externe
» purchaser_code string false none Purchaser code
» lot_external_code string false none Lot external code

Création réclamation

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/phases/{phase}/plans/{plan}/snags

Body parameter

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
locale query string false Langue
body body SnagDTO3 true Détails de la réserve

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie SnagDTO2
403 Forbidden L'utilisateur n'a pas accès au plan ou n'est pas autorisé à créer une réserve None
404 Not Found l'URL saisie est invalide None

Récupère les détails de la réserve lié au projet et à la phase

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
snag path integer true Filtre sur le numéro de la réserve
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Détails de la réserve SnagDTO
403 Forbidden L'utilisateur n'a pas le rôle d'accès à la visualisation des réserves None
404 Not Found l'URL saisie est invalide None

Mise à jour d'une réserve

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}

Body parameter

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
snag path integer true Filtre sur le numéro de la réserve
locale query string false Langue
body body SnagDTO5 true Détails de la réserve

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès SnagDTO4
403 Forbidden L'utilisateur n'a pas accès au plan ou n'est pas autorisé à mettre à jour une réserve None
404 Not Found l'URL saisie est invalide None

Patch update snag

Code samples

# You can also use wget
curl -X PATCH /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "status": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "item": "string",
  "issue": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}

Body parameter

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "status": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "item": "string",
  "issue": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
snag path integer true Filtre sur le numéro de la réserve
locale query string false Langue
body body SnagDTO7 true Détails de la réserve

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Mise à jour effectuée avec succès SnagDTO6
403 Forbidden L'utilisateur n'a pas accès au plan ou n'est pas autorisé à mettre à jour une réserve None
404 Not Found l'URL saisie est invalide None

Supprimer une réserve

Code samples

# You can also use wget
curl -X DELETE /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} \
  -H 'Authorization: Bearer {access-token}'


DELETE /api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag} HTTP/1.1


var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api.kaliti.test/v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v2/projects/{project}/phases/{phase}/plans/{plan}/snags/{snag}

Parameters

Parameter In Type Required Description
project path string true Filtrer sur le code externe du projet
phase path string true Filtrer sur le code externe de la phase
plan path string true Filtre sur le numéro du plan
snag path integer true Filtre sur le numéro de la réserve

Responses

Status Meaning Description Schema
204 No Content Suppression effectuée avec succès None
403 Forbidden User doesn't have access to delete snag None
404 Not Found l'URL saisie est invalide None

Documents liés aux lots

Documents liés aux lots

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/lot/{lot}/document \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/lot/{lot}/document HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lot/{lot}/document',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lot/{lot}/document',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/lot/{lot}/document',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/lot/{lot}/document', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lot/{lot}/document");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/lot/{lot}/document", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/lot/{lot}/document

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
lot path string true Lot external code
locale query string false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Returns the list of documents in a specific project and lot StorageFilesDTO
403 Forbidden User isn't linked to project None
404 Not Found l'URL saisie est invalide None

Deletes document

Code samples

# You can also use wget
curl -X DELETE /api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document} \
  -H 'Authorization: Bearer {access-token}'


DELETE /api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document} HTTP/1.1


var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/{document}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v2/projects/{project}/lot/{lot}/document/{document}

Parameters

Parameter In Type Required Description
document path integer true Document ID
project path string true Code externe du projet
lot path string true Lot external code

Responses

Status Meaning Description Schema
204 No Content Suppression effectuée avec succès None
403 Forbidden User doesn't have role to delete lot or doesn't have access to the project None
404 Not Found File or lot does not exist None

Télécharger un fichier

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload HTTP/1.1

Content-Type: application/x-www-form-urlencoded


var headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "fileUrl": "string",
  "fileBase64": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/x-www-form-urlencoded',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/x-www-form-urlencoded"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/lot/{lot}/document/upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/lot/{lot}/document/upload

Body parameter

fileUrl: string
fileBase64: string

Parameters

Parameter In Type Required Description
project path string true Code externe du projet
lot path string true Lot external code
body body object false none
» fileUrl body string false Upload file by URL
» fileBase64 body string(binary) false Upload base64 encoded file

Responses

Status Meaning Description Schema
201 Created Création réussie None
400 Bad Request Les données de la requête sont invalides None
403 Forbidden User doesn't have role to upload file or doesn't have access to this action None
404 Not Found l'URL saisie est invalide None

Utilisateur

Récupère la liste des utilisateurs de cette entreprise

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/companies/{linkCompanyPackage}/users

Parameters

Parameter In Type Required Description
project path integer true Code externe du projet
linkCompanyPackage path integer true ID lien entreprise corps d’état
page query integer false Numéro de page
limit query integer false Nombre de résultats par page
locale query string false Langue
filters[name] query string false Filtre sur le nom de l'utilisateur
filters[external_code] query string false Filter sur le code externe de l'utilisateur
filters[after_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou postérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)
filters[before_last_update_date] query string(date-time) false Filtre toutes les données dont la date de dernière modification est égale ou antérieure à la date spécifiée en UTC (YYYY-MM-DD hh:mm:ss)

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées Inline
400 Bad Request Invalid data None
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [UserDTO] false none none
» id integer false none Clé primaire
» name string true none Nom de l'utilisateur
» phone string false none Numéro de téléphone de l'utilisateur
» mobile_phone string false none Numéro de téléphone mobile de l'utilisateur
» email string false none Email de l'utilisateur
» is_recipient boolean false none Est-ce que cet utilisateur est le destinataire principal des emails envoyés à l'entrerprise
» last_update_date string(date) false none Date de dernière mise à jour
» external_code string false none Code externe
» position PositionDTO false none none
»» id integer true none Clé primaire
»» name string false none Nom du poste du compte

Créer un utilisateur

Code samples

# You can also use wget
curl -X POST /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


POST /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v2/projects/{project}/companies/{linkCompanyPackage}/users

Body parameter

{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}

Parameters

Parameter In Type Required Description
project path integer true Code externe du projet
linkCompanyPackage path integer true ID lien entreprise corps d’état
locale query string false Langue
body body UserDTO2 true Détails d'un utilisateur

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Création réussie UserDTO
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Détails d'un utilisateur

Code samples

# You can also use wget
curl -X GET /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


GET /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} HTTP/1.1

Accept: */*


var headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}

Parameters

Parameter In Type Required Description
project path integer true Code externe du projet
linkCompanyPackage path integer true ID lien entreprise corps d’état
employee path integer true Identifiant de l'utilisateur
locale query string false Langue

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Les données ont été trouvées UserDTO
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Mise à jour d'un utilisateur

Code samples

# You can also use wget
curl -X PUT /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PUT /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}

Body parameter

{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}

Parameters

Parameter In Type Required Description
project path integer true Code externe du projet
linkCompanyPackage path integer true ID lien entreprise corps d’état
employee path integer true Identifiant de l'utilisateur
locale query string false Langue
body body UserDTO3 true none

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Création réussie UserDTO
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Patch user

Code samples

# You can also use wget
curl -X PATCH /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'


PATCH /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} HTTP/1.1

Content-Type: application/json
Accept: */*


var headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}

Body parameter

{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}

Parameters

Parameter In Type Required Description
project path integer true Code externe du projet
linkCompanyPackage path integer true ID lien entreprise corps d’état
employee path integer true Identifiant de l'utilisateur
locale query string false Langue
body body UserDTO4 true none

Enumerated Values

Parameter Value
locale en
locale fr

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Création réussie UserDTO
403 Forbidden Accès interdit None
404 Not Found l'URL saisie est invalide None

Supprimer un utilisateur

Code samples

# You can also use wget
curl -X DELETE /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} \
  -H 'Authorization: Bearer {access-token}'


DELETE /api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee} HTTP/1.1


var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}', params={

}, headers = headers)

print r.json()


URL obj = new URL("/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api.kaliti.test/v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v2/projects/{project}/companies/{linkCompanyPackage}/users/{employee}

Parameters

Parameter In Type Required Description
project path integer true Code externe du projet
linkCompanyPackage path integer true ID lien entreprise corps d’état
employee path integer true Identifiant de l'utilisateur

Responses

Status Meaning Description Schema
204 No Content Suppression effectuée avec succès None
403 Forbidden User doesn't have access to delete this user. None
404 Not Found l'URL saisie est invalide None

Schemas

LabelDTO

{
  "id": 0,
  "name": "string",
  "package": {
    "id": 1,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string false none Label name
package PackageDTO false none none

LabelDTO2

{
  "name": "string",
  "package": {
    "id": 1,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
name string false none Label name
package PackageDTO false none none

SettingDTO

{
  "id": 1,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Report template name

ZoneDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string false none Zone title

CompanyDTO

{
  "id": 1,
  "name": "string",
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "category": {
    "id": 1,
    "name": "string"
  },
  "zip_code": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1,
  "legal_name": "string",
  "create_date": "2023-01-12",
  "last_update_date": "2023-01-12"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string true none Raison sociale de l'entreprise
package [LinksCompaniesPackagesDTO] true none Package name
address string false none Adresse
category CompanyCategoryDTO true none none
zip_code string false none Code postal
city string false none Nom de la ville
sub_type string false none Sous-type (Exemple : éléctricité)
external_code string false none Code externe
identification_code string true none Code SIRET
identification_type integer false none Identification Type Id
legal_name string false none Legal name
create_date string(date) false none Date de création
last_update_date string(date) false none Date de dernière mise à jour

CompanyDTO2

{
  "id": 1,
  "name": "string",
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "category": {
    "id": 1,
    "name": "string"
  },
  "zip_code": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1,
  "legal_name": "string",
  "create_date": "2023-01-12",
  "last_update_date": "2023-01-12"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string true none Raison sociale de l'entreprise
package [LinksCompaniesPackagesDTO] true none Package name
address string false none Adresse
category CompanyCategoryDTO true none none
zip_code string false none Code postal
city string false none Nom de la ville
sub_type string false none Sous-type (Exemple : éléctricité)
external_code string false none Code externe
identification_code string true none Code SIRET
identification_type integer false none Identification Type Id
legal_name string false none Legal name
create_date string(date) false none Date de création
last_update_date string(date) false none Date de dernière mise à jour

CompanyDTO3

{
  "name": "string",
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "category": {
    "id": 1,
    "name": "string"
  },
  "zip_code": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1
}

Properties

Name Type Required Restrictions Description
name string true none Raison sociale de l'entreprise
package [LinksCompaniesPackagesDTO] true none Package name
address string false none Adresse
category CompanyCategoryDTO true none none
zip_code string false none Code postal
city string false none Nom de la ville
sub_type string false none Sous-type (Exemple : éléctricité)
external_code string false none Code externe
identification_code string true none Code SIRET
identification_type integer false none Identification Type Id

CompanyDTO4

{
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "address": "string",
  "city": "string",
  "sub_type": "string",
  "external_code": "string",
  "identification_code": "string",
  "identification_type": 1
}

Properties

Name Type Required Restrictions Description
package [LinksCompaniesPackagesDTO] true none Package name
address string false none Adresse
city string false none Nom de la ville
sub_type string false none Sous-type (Exemple : éléctricité)
external_code string false none Code externe
identification_code string true none Code SIRET
identification_type integer false none Identification Type Id

TaskDTO

{
  "id": 1,
  "number": 1,
  "category": {
    "id": 1,
    "name": "string"
  },
  "description": "string",
  "process": "string",
  "unit": "string",
  "data": "string",
  "comment": "string",
  "projects": [
    {
      "id": 0,
      "external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
number integer false none Numéro de la tâche du tableau de bord
category CategoryDTO false none none
description string false none Description de la tâche du tableau de bord
process string false none Traitement de la tâche du tableau de bord
unit string false none Unité de la tâche du tableau de bord
data string false none Données de la tâche du tableau de bord
comment string false none Commentaires de la tâche du tableau de bord
projects [ProjectDTO5] false none Projets de la tâche du tableau de bord

TaskDTO2

{
  "data": "string"
}

Properties

Name Type Required Restrictions Description
data string false none Données de la tâche du tableau de bord

LotDTO

{
  "id": 1,
  "name": "string",
  "project_id": 0,
  "project_external_code": "string",
  "compensation_fee_paid": 0,
  "last_transmitted_request_date": "2023-01-12",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "compensation_fee": 0,
  "date_final_commit_pv": "2023-01-12",
  "external_code": "string",
  "create_date": "2023-01-12",
  "create_account_id": 0,
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string false none Lot name
project_id integer false none Project id
project_external_code string false none Code externe du projet
compensation_fee_paid number false none Compensation fee paid
last_transmitted_request_date string(date) false none Last transmitted request date
plans [PlanDTO8] false none Lot plans
compensation_fee number false none Compensation fee (in progress)
date_final_commit_pv string(date) false none Pv commit final date
external_code string true none Lot external name
create_date string(date) false none Lot creation date
create_account_id integer true none Account ID that created the lot
purchasers [LinksLotPurchaserDTO] false none Lot purchaser links

LotDTO2

{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string false none Lot name
plans [PlanDTO8] false none Lot plans
external_code string true none Lot external name
purchasers [LinksLotPurchaserDTO] false none Lot purchaser links

LotDTO3

{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string false none Lot name
plans [PlanDTO8] false none Lot plans
external_code string true none Lot external name
purchasers [LinksLotPurchaserDTO] false none Lot purchaser links

LotDTO4

{
  "name": "string",
  "plans": [
    {
      "id": 0,
      "number": "string",
      "external_code": "string"
    }
  ],
  "external_code": "string",
  "purchasers": [
    {
      "category_id": 0,
      "category_name": "string",
      "purchaser_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string false none Lot name
plans [PlanDTO8] false none Lot plans
external_code string true none Lot external name
purchasers [LinksLotPurchaserDTO] false none Lot purchaser links

PhaseDTO

{
  "id": 0,
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string",
  "last_update_date": "2023-01-12"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string true none Nom de la phase
sub_name string false none Surnom de la phase
is_locked boolean true none Est-ce que la phase est vérouillée
is_structural_work boolean true none Activer ou non les fonctionnalités liés au gros oeuvre sur cette phase
is_available_on_purchaser_access boolean true none Activer ou non les fonctionnalités de l'acheteur sur cette phase
type PhaseTypeDTO true none none
external_code string false none Code externe
last_update_date string(date) false none Date de dernière mise à jour

PhaseDTO2

{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
name string true none Nom de la phase
sub_name string false none Surnom de la phase
is_locked boolean true none Est-ce que la phase est vérouillée
is_structural_work boolean true none Activer ou non les fonctionnalités liés au gros oeuvre sur cette phase
is_available_on_purchaser_access boolean true none Activer ou non les fonctionnalités de l'acheteur sur cette phase
type PhaseTypeDTO2 true none none
external_code string false none Code externe

PhaseDTO3

{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
name string true none Nom de la phase
sub_name string false none Surnom de la phase
is_locked boolean true none Est-ce que la phase est vérouillée
is_structural_work boolean true none Activer ou non les fonctionnalités liés au gros oeuvre sur cette phase
is_available_on_purchaser_access boolean true none Activer ou non les fonctionnalités de l'acheteur sur cette phase
type PhaseTypeDTO3 true none none
external_code string false none Code externe

PhaseDTO4

{
  "name": "string",
  "sub_name": "string",
  "is_locked": true,
  "is_structural_work": true,
  "is_available_on_purchaser_access": true,
  "type": {
    "id": 0,
    "name": "string"
  },
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
name string true none Nom de la phase
sub_name string false none Surnom de la phase
is_locked boolean true none Est-ce que la phase est vérouillée
is_structural_work boolean true none Activer ou non les fonctionnalités liés au gros oeuvre sur cette phase
is_available_on_purchaser_access boolean true none Activer ou non les fonctionnalités de l'acheteur sur cette phase
type PhaseTypeDTO4 true none none
external_code string false none Code externe

PlanDTO

{
  "id": 0,
  "general_plan_name": "string",
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "zone_category": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string",
  "last_update_date": "2023-01-12",
  "project_id": 0,
  "phase_id": 0,
  "plan_id": 0,
  "sso_provider_id": 0,
  "url": "string",
  "project_external_code": "string",
  "phases": [
    {
      "external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
general_plan_name string false none Nom du plan général
number string true none Numéro du plan (Exemple : B02)
plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
floor string true none Etage (Exemple : Rez-de-chaussée)
building string true none Batiment (Exemple : batiment numéro 6)
zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
zone_category string false none Zone category
lodgement_type string false none Type de logement (Exemple : House)
index string true none Index du plan (exemple : 123)
drawing_src string false none URL du plan
delivery_date string(date) false none Date de livraison du lot
external_code string false none Code externe
last_update_date string(date) false none Date de dernière mise à jour
project_id integer false none ID du projet
phase_id integer false none Phase id
plan_id integer false none Plan id
sso_provider_id integer false none Sso provider id
url string false none Url
project_external_code string false none Code externe
phases [PhaseDTO5] false none Phases

PlanDTO2

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
number string true none Numéro du plan (Exemple : B02)
plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
floor string true none Etage (Exemple : Rez-de-chaussée)
building string true none Batiment (Exemple : batiment numéro 6)
zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
lodgement_type string false none Type de logement (Exemple : House)
index string true none Index du plan (exemple : 123)
drawing_src string false none URL du plan
delivery_date string(date) false none Date de livraison du lot
external_code string false none Code externe

PlanDTO3

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
number string true none Numéro du plan (Exemple : B02)
plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
floor string true none Etage (Exemple : Rez-de-chaussée)
building string true none Batiment (Exemple : batiment numéro 6)
zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
lodgement_type string false none Type de logement (Exemple : House)
index string true none Index du plan (exemple : 123)
drawing_src string false none URL du plan
delivery_date string(date) false none Date de livraison du lot
external_code string false none Code externe

PlanDTO4

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
number string true none Numéro du plan (Exemple : B02)
plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
floor string true none Etage (Exemple : Rez-de-chaussée)
building string true none Batiment (Exemple : batiment numéro 6)
zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
lodgement_type string false none Type de logement (Exemple : House)
index string true none Index du plan (exemple : 123)
drawing_src string false none URL du plan
delivery_date string(date) false none Date de livraison du lot
external_code string false none Code externe

PlanDTO5

{
  "phase_id": 0,
  "plan_id": 0,
  "sso_provider_id": 0,
  "url": "string"
}

Properties

Name Type Required Restrictions Description
phase_id integer false none Phase id
plan_id integer false none Plan id
sso_provider_id integer false none Sso provider id
url string false none Url

PlanDTO6

{
  "id": 0,
  "general_plan_name": "string",
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "zone_category": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string",
  "last_update_date": "2023-01-12",
  "project_id": 0,
  "project_external_code": "string",
  "phases": [
    {
      "external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
general_plan_name string false none Nom du plan général
number string true none Numéro du plan (Exemple : B02)
plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
floor string true none Etage (Exemple : Rez-de-chaussée)
building string true none Batiment (Exemple : batiment numéro 6)
zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
zone_category string false none Zone category
lodgement_type string false none Type de logement (Exemple : House)
index string true none Index du plan (exemple : 123)
drawing_src string false none URL du plan
delivery_date string(date) false none Date de livraison du lot
external_code string false none Code externe
last_update_date string(date) false none Date de dernière mise à jour
project_id integer false none ID du projet
project_external_code string false none Code externe
phases [PhaseDTO5] false none Phases

PlanDTO7

{
  "number": "string",
  "plan_type": "string",
  "floor": "string",
  "building": "string",
  "zone_type": "string",
  "lodgement_type": "string",
  "index": "string",
  "drawing_src": "string",
  "delivery_date": "2023-01-12",
  "external_code": "string",
  "phases": [
    {
      "external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
number string true none Numéro du plan (Exemple : B02)
plan_type string false none Plan type (Example : Architect) * 1 - Architect * 2 - Electricity * 3 - Plumbing * 4 - Sales plan * 5 - TMA * 6 - Synthesis * 7 - Formwork * 8 - Reinforcement * 9 - Vertical reinforcement * 10 - Slab reinforcement * 11 - Cutting * 12 - Floor plan
floor string true none Etage (Exemple : Rez-de-chaussée)
building string true none Batiment (Exemple : batiment numéro 6)
zone_type string true none Zone type (Example : Kitchen) * 1 - Flat * 2 - House * 3 - Parking * 4 - Cellar * 5 - Commercial space * 6 - Offices * 7 - Circulation * 8 - Roofing * 9 - Outside * 10 - Facade * 11 - Etage * 13 - Local technique * 15 - Salle * 16 - Plan Masse * 17 - Villa * 18 - Entrepot * 19 - Sanitaires * 20 - Chambre * 21 - Restaurant * 22 - Coffrage * 23 - Compartiment * 24 - Architecte * 25 - Suite * 26 - Palier * 27 - Cinéma * 28 - Fondations * 29 - Balcon * 30 - TTZ * 31 - Architecture * 32 - Toiture Terrasse * 33 - Travaux pratiques * 34 - Gaine technique * 35 - Accueil * 36 - Circulations Horizontales * 37 - Circulations verticales * 38 - Enseignement théorique * 39 - L.E.M. * 40 - Plan de butonnage * 41 - Structure * 42 - Niveau * 43 - Local * 44 - Elévation * 45 - Coupe
lodgement_type string false none Type de logement (Exemple : House)
index string true none Index du plan (exemple : 123)
drawing_src string false none URL du plan
delivery_date string(date) false none Date de livraison du lot
external_code string false none Code externe
phases [PhaseDTO5] false none Phases

ProjectDTO

{
  "id": 0,
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "last_update_date": "2023-01-12",
  "client_internal_number": "string",
  "client_account": {
    "id": 0,
    "name": "string",
    "external_code": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
title string true none Titre du projet
image string false none URL de l'image principale du projet
logo string false none URL du premier logo du projet
logo2 string false none URL du deuxième logo du projet
external_code string true none Code externe
delivery_date string(date) false none Date de livraison du projet
last_update_date string(date) false none Date de dernière mise à jour
client_internal_number string false none Client Internal N°
client_account ClientAccountDTO false none none

ProjectDTO2

{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}

Properties

Name Type Required Restrictions Description
title string true none Titre du projet
image string false none URL de l'image principale du projet
logo string false none URL du premier logo du projet
logo2 string false none URL du deuxième logo du projet
external_code string true none Code externe
client_internal_number string false none Client Internal N°
report_templates [SettingDTO2] false none Report templates
client_account ClientAccountDTO2 false none none

ProjectDTO3

{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}

Properties

Name Type Required Restrictions Description
title string true none Titre du projet
image string false none URL de l'image principale du projet
logo string false none URL du premier logo du projet
logo2 string false none URL du deuxième logo du projet
external_code string true none Code externe
delivery_date string(date) false none Date de livraison du projet
client_internal_number string false none Client Internal N°
report_templates [SettingDTO2] false none Report templates
client_account ClientAccountDTO2 false none none

ProjectDTO4

{
  "title": "string",
  "image": "string",
  "logo": "string",
  "logo2": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "client_internal_number": "string",
  "report_templates": [
    {
      "id": 1
    }
  ],
  "client_account": {
    "id": 0,
    "external_code": "string"
  }
}

Properties

Name Type Required Restrictions Description
title string true none Titre du projet
image string false none URL de l'image principale du projet
logo string false none URL du premier logo du projet
logo2 string false none URL du deuxième logo du projet
external_code string true none Code externe
delivery_date string(date) false none Date de livraison du projet
client_internal_number string false none Client Internal N°
report_templates [SettingDTO2] false none Report templates
client_account ClientAccountDTO2 false none none

PurchaserDTO

{
  "id": 1,
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "last_update_date": "2023-01-12",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "project_id": 0,
  "project_external_code": "string",
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string true none Nom de l'acheteur
address string false none Adresse postale de l'acheteur
code_postal string false none Code postal de l'acheteur
city string false none Nom de la ville de l'acheteur
phone string false none Numéro de téléphone de l'acheteur
comment string false none Commentaire sur l'acheteur
parking string false none Numéro de parking de l'acheteur
garage string false none Numéro de garage de l'acheteur
cave string false none Numéro de cave de l'acheteur
external_code string true none Purchaser code
occupant_is_active boolean false none Est-ce que l'occupant est différent de l'acheteur
occupant_name string false none Nom de l'occupant (peut être vide)
occupant_email string false none Email de l'occupant (peut être vide)
email string false none Purchaser email (can be empty)
occupant_tel string false none Numéro de téléphone de l'occupant (peut être vide)
last_update_date string(date) false none Date de dernière mise à jour
sso_provider_id integer false none Purchaser sso provider id (can be empty)
main_purchaser_id integer false none Main purchaser id (can be empty)
project_id integer false none ID du projet
project_external_code string false none Code externe
lots [LinksLotPurchaserDTO2] false none Purchaser's linked lots

PurchaserDTO2

{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nom de l'acheteur
address string false none Adresse postale de l'acheteur
code_postal string false none Code postal de l'acheteur
city string false none Nom de la ville de l'acheteur
phone string false none Numéro de téléphone de l'acheteur
comment string false none Commentaire sur l'acheteur
parking string false none Numéro de parking de l'acheteur
garage string false none Numéro de garage de l'acheteur
cave string false none Numéro de cave de l'acheteur
external_code string true none Purchaser code
occupant_is_active boolean false none Est-ce que l'occupant est différent de l'acheteur
occupant_name string false none Nom de l'occupant (peut être vide)
occupant_email string false none Email de l'occupant (peut être vide)
email string false none Purchaser email (can be empty)
occupant_tel string false none Numéro de téléphone de l'occupant (peut être vide)
sso_provider_id integer false none Purchaser sso provider id (can be empty)
main_purchaser_id integer false none Main purchaser id (can be empty)
lots [LinksLotPurchaserDTO2] false none Purchaser's linked lots

PurchaserDTO3

{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nom de l'acheteur
address string false none Adresse postale de l'acheteur
code_postal string false none Code postal de l'acheteur
city string false none Nom de la ville de l'acheteur
phone string false none Numéro de téléphone de l'acheteur
comment string false none Commentaire sur l'acheteur
parking string false none Numéro de parking de l'acheteur
garage string false none Numéro de garage de l'acheteur
cave string false none Numéro de cave de l'acheteur
external_code string true none Purchaser code
occupant_is_active boolean false none Est-ce que l'occupant est différent de l'acheteur
occupant_name string false none Nom de l'occupant (peut être vide)
occupant_email string false none Email de l'occupant (peut être vide)
email string false none Purchaser email (can be empty)
occupant_tel string false none Numéro de téléphone de l'occupant (peut être vide)
sso_provider_id integer false none Purchaser sso provider id (can be empty)
main_purchaser_id integer false none Main purchaser id (can be empty)
lots [LinksLotPurchaserDTO2] false none Purchaser's linked lots

PurchaserDTO4

{
  "name": "string",
  "address": "string",
  "code_postal": "string",
  "city": "string",
  "phone": "string",
  "comment": "string",
  "parking": "string",
  "garage": "string",
  "cave": "string",
  "external_code": "string",
  "occupant_is_active": true,
  "occupant_name": "string",
  "occupant_email": "string",
  "email": "string",
  "occupant_tel": "string",
  "sso_provider_id": 0,
  "main_purchaser_id": 0,
  "lots": [
    {
      "category_id": 0,
      "category_name": "string",
      "lot_external_code": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nom de l'acheteur
address string false none Adresse postale de l'acheteur
code_postal string false none Code postal de l'acheteur
city string false none Nom de la ville de l'acheteur
phone string false none Numéro de téléphone de l'acheteur
comment string false none Commentaire sur l'acheteur
parking string false none Numéro de parking de l'acheteur
garage string false none Numéro de garage de l'acheteur
cave string false none Numéro de cave de l'acheteur
external_code string true none Purchaser code
occupant_is_active boolean false none Est-ce que l'occupant est différent de l'acheteur
occupant_name string false none Nom de l'occupant (peut être vide)
occupant_email string false none Email de l'occupant (peut être vide)
email string false none Purchaser email (can be empty)
occupant_tel string false none Numéro de téléphone de l'occupant (peut être vide)
sso_provider_id integer false none Purchaser sso provider id (can be empty)
main_purchaser_id integer false none Main purchaser id (can be empty)
lots [LinksLotPurchaserDTO2] false none Purchaser's linked lots

ReceptionDTO

{
  "id": 1,
  "name": "string",
  "reception_date": "2023-01-12",
  "gpa_end_date": "2023-01-12",
  "gbf_end_date": "2023-01-12",
  "decennial_end_dates": "2023-01-12",
  "zone_concerned": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string false none Nom
reception_date string(date) false none Reception date
gpa_end_date string(date) false none GPA end date
gbf_end_date string(date) false none GBF end date
decennial_end_dates string(date) false none Decennial end date
zone_concerned string false none Zone concerned

DeliveryDTO

{
  "id": 1,
  "name": "string",
  "external_code": "string",
  "delivery_date": "2023-01-12",
  "cover_to_30_days_end_date": "2023-01-12"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string false none Lot name
external_code string false none Lot external name
delivery_date string(date) false none Date de livraison
cover_to_30_days_end_date string(date) false none Cover to 30 days end date

HandoverProtocolDTO

{
  "id": 1,
  "name": "string",
  "create_date": "2023-01-12",
  "url": "string",
  "purchasers": [
    {
      "id": 1,
      "external_code": "string"
    }
  ],
  "project": {
    "id": 0,
    "external_code": "string"
  },
  "phase": 0,
  "phase_external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string false none Report name
create_date string(date) false none Date de création
url string false none Report URL
purchasers [PurchaserDTO5] false none Fiche preneurs
project ProjectDTO5 false none none
phase integer false none none
phase_external_code string false none Code externe

SnagDTO

{
  "id": 0,
  "number": 0,
  "label": "string",
  "status": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "item": "string",
  "issue": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "diffusion_date": "2023-01-12",
  "end_date": "2023-01-12",
  "create_date": "2023-01-12",
  "create_account_id": 0,
  "last_update_date": "2023-01-12",
  "last_update_account_id": 0,
  "check_date_enterprise": "2023-01-12",
  "check_enterprise_account_id": 0,
  "check_date_eg": "2023-01-12",
  "check_eg_account_id": 0,
  "check_date_moe": "2023-01-12",
  "check_moe_account_id": 0,
  "check_date_mo": "2023-01-12",
  "check_mo_account_id": 0,
  "check_date_purchaser": "2023-01-12",
  "check_purchaser_account_id": 0,
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "z": 0,
  "last_refuse_ent_date": "2023-01-12",
  "last_refuse_ent_account_id": 0,
  "last_refuse_eg_date": "2023-01-12",
  "last_refuse_eg_account_id": 0,
  "last_refuse_moe_date": "2023-01-12",
  "last_refuse_moe_account_id": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "signature_ent": "string",
  "signatory_ent": "string",
  "signature_eg": "string",
  "signatory_eg": "string",
  "signature_moe": "string",
  "signatory_moe": "string",
  "signature_mo": "string",
  "signatory_mo": "string",
  "signature_purchaser": "string",
  "signatory_purchaser": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "commitment_deadline": "2023-01-12",
  "discharge": "string",
  "intervention_slip": "string",
  "deadline_date_type_id": 0,
  "deadline_nb_days": 0,
  "deadline_day_type_id": 0,
  "deadline_penalty_fee": 0,
  "company": {
    "id": 1,
    "name": "string",
    "package": [
      {
        "link_company_package_id": 1,
        "package_name": "string",
        "package_number": "string",
        "package_trade_code": "string",
        "color": "string"
      }
    ],
    "external_code": "string"
  },
  "sub_company": {
    "id": 1,
    "name": "string",
    "package": [
      {
        "link_company_package_id": 1,
        "package_name": "string",
        "package_number": "string",
        "package_trade_code": "string",
        "color": "string"
      }
    ],
    "external_code": "string"
  },
  "responsible": {
    "id": 1,
    "name": "string",
    "package": [
      {
        "link_company_package_id": 1,
        "package_name": "string",
        "package_number": "string",
        "package_trade_code": "string",
        "color": "string"
      }
    ],
    "external_code": "string"
  },
  "transmitter": {
    "id": 1,
    "name": "string",
    "package": [
      {
        "link_company_package_id": 1,
        "package_name": "string",
        "package_number": "string",
        "package_trade_code": "string",
        "color": "string"
      }
    ],
    "external_code": "string"
  },
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  },
  "project_id": 0,
  "project_external_code": "string",
  "phase_id": 0,
  "phase_external_code": "string",
  "plan_id": 0,
  "plan_number": "string",
  "plan_external_code": "string",
  "purchaser_code": "string",
  "lot_external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
number integer false none Numéro de la réserve
label string false none Libellé de la réserve
status string false none Snag status * red * purple * darkorange * blue * light green * dark green
support string false none Réserve
nature string false none Nature de la réserve
type string false none Type de la réserve
item string false none Snag item
issue string false none Snag issue
zone string false none Zone de la réserve
visit_date string(date) false none Date de visite de la réserve
diffusion_date string(date) false none Date de diffusion de la réserve
end_date string(date) false none Date de fin de la réserve
create_date string(date) false none Date de création de la réserve
create_account_id integer true none Identifiant du compte ayant créé la réserve
last_update_date string(date) false none Date de dernière mise à jour de la réserve
last_update_account_id integer false none Identifiant du compte ayant modifié la réserve
check_date_enterprise string(date) false none Date de vérification par l'entreprise de la réserve
check_enterprise_account_id integer false none Identifiant du compte de l'entreprise qui a vérifié la réserve
check_date_eg string(date) false none Date de vérification de la réserve de l'entreprise générale
check_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a vérifié la réserve
check_date_moe string(date) false none Date de vérification de la réserve de la MOE
check_moe_account_id integer false none Identifiant du compte de la MOE qui a vérifié la réserve
check_date_mo string(date) false none Date de vérification de la réserve de la MO
check_mo_account_id integer false none Identifiant du compte de la MO qui a vérifié la réserve
check_date_purchaser string(date) false none Snag check date of purchaser
check_purchaser_account_id integer false none Account ID of purchaser that checked the snag
comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
comment_moe string false none Comentaire de la MO sur la réserve
photo1 string false none URL de la première photo de la réserve
photo2 string false none URL de la deuxième phoot de la réserve
x number true none Coordonée X de la réserve
y number true none Coordonnée Y de la réserve
z integer false none Coordonnée Z de la réserve
last_refuse_ent_date string(date) false none Dernière date de refus de l'entreprise
last_refuse_ent_account_id integer false none Identifiant du compte de l'entreprise qui a refusé la réserve
last_refuse_eg_date string(date) false none Date de refus de l'entreprise générale
last_refuse_eg_account_id integer false none Identifiant du compte de l'entreprise générale qui a refusé la réserve
last_refuse_moe_date string(date) false none Date de refus de la MOE
last_refuse_moe_account_id integer false none Identifiant du compte de la MOE ayant refusé la réserve
acceptance_date string(date) false none Date d'acceptation de la réserve
acceptance_comment string false none Commentaire de l'acceptation de la réserve
signature_ent string false none Signature de l'entreprise
signatory_ent string false none Nom du signataire de l'entreprise
signature_eg string false none Signature de l'entreprise générale
signatory_eg string false none Nom du signataire de l'entreprise générale
signature_moe string false none Signature de la MOE
signatory_moe string false none Nom du signataire de la MOE
signature_mo string false none Signature de la MO
signatory_mo string false none Nom du signataire de la MO
signature_purchaser string false none Snag purchaser signature
signatory_purchaser string false none Snag purchaser signatory
after_sales_code string false none Code SAV de la réserve
compensation_id integer false none Compensation ID
commitment_time integer false none Snag compensation time
commitment_deadline string(date) false none Snag commitment deadline
discharge string false none Discharge source URL
intervention_slip string false none Intervention slip source URL
deadline_date_type_id integer false none Snag deadline date type id
deadline_nb_days integer false none Snag deadline number of days
deadline_day_type_id integer false none Snag deadline day type id
deadline_penalty_fee integer false none Snag deadline penalty fee
company CompanyDTO5 false none none
sub_company CompanyDTO5 false none none
responsible CompanyDTO5 false none none
transmitter CompanyDTO5 false none none
priority PriorityDTO false none none
acceptance AcceptanceDTO false none none
project_id integer false none ID du projet
project_external_code string false none Code externe
phase_id integer false none Identifiant de la phase
phase_external_code string false none Code externe
plan_id integer false none Identifiant du plan
plan_number string false none Numéro du plan (Exemple : B02)
plan_external_code string false none Code externe
purchaser_code string false none Purchaser code
lot_external_code string false none Lot external code

SnagDTO2

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "item": "string",
  "issue": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
company_id integer false none Snag main contractor companyId
sub_company_id integer false none Snag subcompanyId. The snag is assigned to this company
responsible_id integer false none CompanyId that is responsible of snag
transmitter_id integer false none CompanyId that has emitted the snag
label string false none Libellé de la réserve
support string false none Réserve
nature string false none Nature de la réserve
type string false none Type de la réserve
item string false none Snag item
issue string false none Snag issue
zone string false none Zone de la réserve
visit_date string(date) false none Date de visite de la réserve
end_date string(date) false none Date de fin de la réserve
comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
comment_moe string false none Comentaire de la MO sur la réserve
photo1 string false none URL de la première photo de la réserve
photo2 string false none URL de la deuxième phoot de la réserve
x number true none Coordonée X de la réserve
y number true none Coordonnée Y de la réserve
acceptance_date string(date) false none Date d'acceptation de la réserve
acceptance_comment string false none Commentaire de l'acceptation de la réserve
after_sales_code string false none Code SAV de la réserve
compensation_id integer false none Compensation ID
commitment_time integer false none Snag compensation time
discharge string false none Discharge source URL
intervention_slip string false none Intervention slip source URL
priority PriorityDTO false none none
acceptance AcceptanceDTO false none none

SnagDTO3

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
company_id integer false none Snag main contractor companyId
sub_company_id integer false none Snag subcompanyId. The snag is assigned to this company
responsible_id integer false none CompanyId that is responsible of snag
transmitter_id integer false none CompanyId that has emitted the snag
label string false none Libellé de la réserve
support string false none Réserve
nature string false none Nature de la réserve
type string false none Type de la réserve
zone string false none Zone de la réserve
visit_date string(date) false none Date de visite de la réserve
end_date string(date) false none Date de fin de la réserve
comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
comment_moe string false none Comentaire de la MO sur la réserve
photo1 string false none URL de la première photo de la réserve
photo2 string false none URL de la deuxième phoot de la réserve
x number true none Coordonée X de la réserve
y number true none Coordonnée Y de la réserve
acceptance_date string(date) false none Date d'acceptation de la réserve
acceptance_comment string false none Commentaire de l'acceptation de la réserve
after_sales_code string false none Code SAV de la réserve
compensation_id integer false none Compensation ID
commitment_time integer false none Snag compensation time
discharge string false none Discharge source URL
intervention_slip string false none Intervention slip source URL
priority PriorityDTO false none none
acceptance AcceptanceDTO false none none

SnagDTO4

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "item": "string",
  "issue": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "deadline_date_type_id": 0,
  "deadline_nb_days": 0,
  "deadline_day_type_id": 0,
  "deadline_penalty_fee": 0,
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
company_id integer false none Snag main contractor companyId
sub_company_id integer false none Snag subcompanyId. The snag is assigned to this company
responsible_id integer false none CompanyId that is responsible of snag
transmitter_id integer false none CompanyId that has emitted the snag
label string false none Libellé de la réserve
support string false none Réserve
nature string false none Nature de la réserve
type string false none Type de la réserve
item string false none Snag item
issue string false none Snag issue
zone string false none Zone de la réserve
visit_date string(date) false none Date de visite de la réserve
end_date string(date) false none Date de fin de la réserve
comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
comment_moe string false none Comentaire de la MO sur la réserve
photo1 string false none URL de la première photo de la réserve
photo2 string false none URL de la deuxième phoot de la réserve
x number true none Coordonée X de la réserve
y number true none Coordonnée Y de la réserve
acceptance_date string(date) false none Date d'acceptation de la réserve
acceptance_comment string false none Commentaire de l'acceptation de la réserve
after_sales_code string false none Code SAV de la réserve
compensation_id integer false none Compensation ID
commitment_time integer false none Snag compensation time
discharge string false none Discharge source URL
intervention_slip string false none Intervention slip source URL
deadline_date_type_id integer false none Snag deadline date type id
deadline_nb_days integer false none Snag deadline number of days
deadline_day_type_id integer false none Snag deadline day type id
deadline_penalty_fee integer false none Snag deadline penalty fee
priority PriorityDTO false none none
acceptance AcceptanceDTO false none none

SnagDTO5

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
company_id integer false none Snag main contractor companyId
sub_company_id integer false none Snag subcompanyId. The snag is assigned to this company
responsible_id integer false none CompanyId that is responsible of snag
transmitter_id integer false none CompanyId that has emitted the snag
label string false none Libellé de la réserve
support string false none Réserve
nature string false none Nature de la réserve
type string false none Type de la réserve
zone string false none Zone de la réserve
visit_date string(date) false none Date de visite de la réserve
end_date string(date) false none Date de fin de la réserve
comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
comment_moe string false none Comentaire de la MO sur la réserve
photo1 string false none URL de la première photo de la réserve
photo2 string false none URL de la deuxième phoot de la réserve
x number true none Coordonée X de la réserve
y number true none Coordonnée Y de la réserve
acceptance_date string(date) false none Date d'acceptation de la réserve
acceptance_comment string false none Commentaire de l'acceptation de la réserve
after_sales_code string false none Code SAV de la réserve
compensation_id integer false none Compensation ID
commitment_time integer false none Snag compensation time
discharge string false none Discharge source URL
intervention_slip string false none Intervention slip source URL
priority PriorityDTO false none none
acceptance AcceptanceDTO false none none

SnagDTO6

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "status": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "item": "string",
  "issue": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "deadline_date_type_id": 0,
  "deadline_nb_days": 0,
  "deadline_day_type_id": 0,
  "deadline_penalty_fee": 0,
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
company_id integer false none Snag main contractor companyId
sub_company_id integer false none Snag subcompanyId. The snag is assigned to this company
responsible_id integer false none CompanyId that is responsible of snag
transmitter_id integer false none CompanyId that has emitted the snag
label string false none Libellé de la réserve
status string false none Snag status * red * purple * darkorange * blue * light green * dark green
support string false none Réserve
nature string false none Nature de la réserve
type string false none Type de la réserve
item string false none Snag item
issue string false none Snag issue
zone string false none Zone de la réserve
visit_date string(date) false none Date de visite de la réserve
end_date string(date) false none Date de fin de la réserve
comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
comment_moe string false none Comentaire de la MO sur la réserve
photo1 string false none URL de la première photo de la réserve
photo2 string false none URL de la deuxième phoot de la réserve
x number true none Coordonée X de la réserve
y number true none Coordonnée Y de la réserve
acceptance_date string(date) false none Date d'acceptation de la réserve
acceptance_comment string false none Commentaire de l'acceptation de la réserve
after_sales_code string false none Code SAV de la réserve
compensation_id integer false none Compensation ID
commitment_time integer false none Snag compensation time
discharge string false none Discharge source URL
intervention_slip string false none Intervention slip source URL
deadline_date_type_id integer false none Snag deadline date type id
deadline_nb_days integer false none Snag deadline number of days
deadline_day_type_id integer false none Snag deadline day type id
deadline_penalty_fee integer false none Snag deadline penalty fee
priority PriorityDTO false none none
acceptance AcceptanceDTO false none none

SnagDTO7

{
  "company_id": 0,
  "sub_company_id": 0,
  "responsible_id": 0,
  "transmitter_id": 0,
  "label": "string",
  "status": "string",
  "support": "string",
  "nature": "string",
  "type": "string",
  "item": "string",
  "issue": "string",
  "zone": "string",
  "visit_date": "2023-01-12",
  "end_date": "2023-01-12",
  "comment_on_check_enterprise": "string",
  "comment_moe": "string",
  "photo1": "string",
  "photo2": "string",
  "x": 0,
  "y": 0,
  "acceptance_date": "2023-01-12",
  "acceptance_comment": "string",
  "after_sales_code": "string",
  "compensation_id": 0,
  "commitment_time": 1,
  "discharge": "string",
  "intervention_slip": "string",
  "priority": {
    "id": 0,
    "name": "string"
  },
  "acceptance": {
    "id": 0,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
company_id integer false none Snag main contractor companyId
sub_company_id integer false none Snag subcompanyId. The snag is assigned to this company
responsible_id integer false none CompanyId that is responsible of snag
transmitter_id integer false none CompanyId that has emitted the snag
label string false none Libellé de la réserve
status string false none Snag status * red * purple * darkorange * blue * light green * dark green
support string false none Réserve
nature string false none Nature de la réserve
type string false none Type de la réserve
item string false none Snag item
issue string false none Snag issue
zone string false none Zone de la réserve
visit_date string(date) false none Date de visite de la réserve
end_date string(date) false none Date de fin de la réserve
comment_on_check_enterprise string false none Commentaire de l'entreprise sur la réserve
comment_moe string false none Comentaire de la MO sur la réserve
photo1 string false none URL de la première photo de la réserve
photo2 string false none URL de la deuxième phoot de la réserve
x number true none Coordonée X de la réserve
y number true none Coordonnée Y de la réserve
acceptance_date string(date) false none Date d'acceptation de la réserve
acceptance_comment string false none Commentaire de l'acceptation de la réserve
after_sales_code string false none Code SAV de la réserve
compensation_id integer false none Compensation ID
commitment_time integer false none Snag compensation time
discharge string false none Discharge source URL
intervention_slip string false none Intervention slip source URL
priority PriorityDTO false none none
acceptance AcceptanceDTO false none none

StorageFilesDTO

{
  "id": 1,
  "folder_id": 0,
  "name": "string",
  "subtitle": "string",
  "src": "string",
  "thumbnail": "string",
  "type": "string",
  "size": 0,
  "create_date": "2023-01-12",
  "update_date": "2023-01-12",
  "create_user_id": 0,
  "update_user_id": 0,
  "update_purchaser_id": 0,
  "create_purchaser_id": 0
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
folder_id integer false none Folder id
name string false none Storage file name
subtitle string false none Storage file subtitle
src string false none Storage file src
thumbnail string false none Storage file thumbnail
type string false none Storage file type
size integer false none Storage file size
create_date string(date) false none Storage file creation date
update_date string(date) false none Storage file update date
create_user_id integer true none User ID that created a storage file
update_user_id integer true none User ID that updated a storage file
update_purchaser_id integer true none Purchaser ID that created a storage file
create_purchaser_id integer true none Purchaser ID that updated a storage file

UserDTO

{
  "id": 1,
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "last_update_date": "2023-01-12",
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string true none Nom de l'utilisateur
phone string false none Numéro de téléphone de l'utilisateur
mobile_phone string false none Numéro de téléphone mobile de l'utilisateur
email string false none Email de l'utilisateur
is_recipient boolean false none Est-ce que cet utilisateur est le destinataire principal des emails envoyés à l'entrerprise
last_update_date string(date) false none Date de dernière mise à jour
external_code string false none Code externe
position PositionDTO false none none

UserDTO2

{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
name string true none Nom de l'utilisateur
phone string false none Numéro de téléphone de l'utilisateur
mobile_phone string false none Numéro de téléphone mobile de l'utilisateur
email string false none Email de l'utilisateur
is_recipient boolean false none Est-ce que cet utilisateur est le destinataire principal des emails envoyés à l'entrerprise
external_code string false none Code externe
position PositionDTO false none none

UserDTO3

{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
name string true none Nom de l'utilisateur
phone string false none Numéro de téléphone de l'utilisateur
mobile_phone string false none Numéro de téléphone mobile de l'utilisateur
email string false none Email de l'utilisateur
is_recipient boolean false none Est-ce que cet utilisateur est le destinataire principal des emails envoyés à l'entrerprise
external_code string false none Code externe
position PositionDTO false none none

UserDTO4

{
  "name": "string",
  "phone": "string",
  "mobile_phone": "string",
  "email": "string",
  "is_recipient": true,
  "external_code": "string",
  "position": {
    "id": 1,
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
name string true none Nom de l'utilisateur
phone string false none Numéro de téléphone de l'utilisateur
mobile_phone string false none Numéro de téléphone mobile de l'utilisateur
email string false none Email de l'utilisateur
is_recipient boolean false none Est-ce que cet utilisateur est le destinataire principal des emails envoyés à l'entrerprise
external_code string false none Code externe
position PositionDTO false none none

PackageDTO

{
  "id": 1,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Package name

LinksCompaniesPackagesDTO

{
  "link_company_package_id": 1,
  "package_name": "string",
  "package_number": "string",
  "package_trade_code": "string",
  "color": "string"
}

Properties

Name Type Required Restrictions Description
link_company_package_id integer false none Clé primaire
package_name string true none Package's name
package_number string false none Lot N°
package_trade_code string false none Package Trade code
color string false none Couleur (Exemple : fff000)

CompanyCategoryDTO

{
  "id": 1,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Category name of the company (Example : Painting) * 1 - Intervenants * 2 - Concessionnaires * 3 - Entreprises

CategoryDTO

{
  "id": 1,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string false none Nom de la phase du tableau de bord

ProjectDTO5

{
  "id": 0,
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
external_code string false none Code externe

PlanDTO8

{
  "id": 0,
  "number": "string",
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
number string true none Numéro du plan (Exemple : B02)
external_code string false none Code externe

LinksLotPurchaserDTO

{
  "category_id": 0,
  "category_name": "string",
  "purchaser_code": "string"
}

Properties

Name Type Required Restrictions Description
category_id integer true none Purchaser category id * 1 - Buyer * 2 - Tenant * 3 - Buyer's representative * 4 - Tenant's representative * 5 - Condominium association * 6 - Trustee * 7 - Investor * 8 - Occupant * 9 - Maintainer * 10 - Delivery Purchaser * 11 - Lessor
category_name string false none Purchaser category name
purchaser_code string false none Purchaser code

PhaseTypeDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Phase type name * 1 - Raising Reserve * 2 - Delivery * 3 - Cover to 30 days * 5 - Audit * 6 - Structural work * 7 - Technical trades * 8 - Architectural trades * 9 - Witness * 10 - Purchasers visit * 11 - Operations prior to acceptance * 12 - Pre-delivery * 13 - Visit 7 days before delivery * 14 - Bienniale * 15 - TMA

PhaseTypeDTO2

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Phase type name * 1 - Raising Reserve * 2 - Delivery * 3 - Cover to 30 days * 5 - Audit * 6 - Structural work * 7 - Technical trades * 8 - Architectural trades * 9 - Witness * 10 - Purchasers visit * 11 - Operations prior to acceptance * 12 - Pre-delivery * 13 - Visit 7 days before delivery * 14 - Bienniale * 15 - TMA

PhaseTypeDTO3

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Phase type name * 1 - Raising Reserve * 2 - Delivery * 3 - Cover to 30 days * 5 - Audit * 6 - Structural work * 7 - Technical trades * 8 - Architectural trades * 9 - Witness * 10 - Purchasers visit * 11 - Operations prior to acceptance * 12 - Pre-delivery * 13 - Visit 7 days before delivery * 14 - Bienniale * 15 - TMA

PhaseTypeDTO4

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Phase type name * 1 - Raising Reserve * 2 - Delivery * 3 - Cover to 30 days * 5 - Audit * 6 - Structural work * 7 - Technical trades * 8 - Architectural trades * 9 - Witness * 10 - Purchasers visit * 11 - Operations prior to acceptance * 12 - Pre-delivery * 13 - Visit 7 days before delivery * 14 - Bienniale * 15 - TMA

PhaseDTO5

{
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
external_code string false none Code externe

ClientAccountDTO

{
  "id": 0,
  "name": "string",
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string true none Nom de la phase
external_code string false none Code externe

SettingDTO2

{
  "id": 1
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire

ClientAccountDTO2

{
  "id": 0,
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
external_code string false none Code externe

LinksLotPurchaserDTO2

{
  "category_id": 0,
  "category_name": "string",
  "lot_external_code": "string"
}

Properties

Name Type Required Restrictions Description
category_id integer true none Purchaser category id * 1 - Buyer * 2 - Tenant * 3 - Buyer's representative * 4 - Tenant's representative * 5 - Condominium association * 6 - Trustee * 7 - Investor * 8 - Occupant * 9 - Maintainer * 10 - Delivery Purchaser * 11 - Lessor
category_name string false none Purchaser category name
lot_external_code string false none Lot external code

PurchaserDTO5

{
  "id": 1,
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
external_code string false none Purchaser code

CompanyDTO5

{
  "id": 1,
  "name": "string",
  "package": [
    {
      "link_company_package_id": 1,
      "package_name": "string",
      "package_number": "string",
      "package_trade_code": "string",
      "color": "string"
    }
  ],
  "external_code": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none Clé primaire
name string true none Raison sociale de l'entreprise
package [LinksCompaniesPackagesDTO] true none Package name
external_code string false none Code externe

PriorityDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Libellé de la priorité (Exemple : La plus haute)

AcceptanceDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Libellé de l'acceptance (Accepté refusé)

PositionDTO

{
  "id": 1,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer true none Clé primaire
name string false none Nom du poste du compte

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access a kitten with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The kitten requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
Shell HTTP JavaScript Node.JS Ruby Python Java Go