Leads2Keys public API v1.0.16
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Leads2Keys public API
Base URLs:
Terms of service Email: Support
Authentication
oAuth2 authentication. Leads2Keys API use oauth2 with the implicit authorization code flow
- Flow: authorizationCode
- Authorization URL = /auth/authorization
- Token URL = /auth/token
| Scope | Scope Description |
|---|---|
| account:read | Read account information |
| mandates:read | Read mandates information |
Default
api version
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/
fetch('https://api.l2k.io/',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.get 'https://api.l2k.io/',
params: {
}
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
r = requests.get('https://api.l2k.io/')
print(r.json())
GET /
general information about the service
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | None |
| 400 | Bad Request | Invalid status value | None |
Oauth2
Operations about OAuth2 authorization
Authorization Endpoint
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/auth/authorization?client_id=string
fetch('https://api.l2k.io/auth/authorization?client_id=string',
{
method: 'GET'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.get 'https://api.l2k.io/auth/authorization',
params: {
'client_id' => 'string'
}
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/auth/authorization', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
r = requests.get('https://api.l2k.io/auth/authorization', params={
'client_id': 'string'
})
print(r.json())
GET /auth/authorization
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| client_id | query | string | true | none |
| state | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 302 | Found | Redirect to OAuth provider | None |
bypass the html form and post user identifiant directly
Code samples
# You can also use wget
curl -X POST https://api.l2k.io/auth/authorization \
-H 'Content-Type: application/x-www-form-urlencoded'
const inputBody = '{
"login": "string",
"password": "string",
"client_id": "string",
"state": "string"
}';
const headers = {
'Content-Type':'application/x-www-form-urlencoded'
};
fetch('https://api.l2k.io/auth/authorization',
{
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'
}
result = RestClient.post 'https://api.l2k.io/auth/authorization',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/x-www-form-urlencoded',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.l2k.io/auth/authorization', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Content-Type': 'application/x-www-form-urlencoded'
}
r = requests.post('https://api.l2k.io/auth/authorization', headers = headers)
print(r.json())
POST /auth/authorization
Body parameter
login: string
password: string
client_id: string
state: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | post.authorization | true | body |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 302 | Found | Redirect to OAuth provider | None |
Request Access Token
Code samples
# You can also use wget
curl -X POST https://api.l2k.io/auth/token \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json'
const inputBody = '{
"grant_type": "authorization_code",
"code": "string"
}';
const headers = {
'Content-Type':'application/x-www-form-urlencoded',
'Accept':'application/json'
};
fetch('https://api.l2k.io/auth/token',
{
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',
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.l2k.io/auth/token',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/x-www-form-urlencoded',
'Accept' => 'application/json',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.l2k.io/auth/token', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Accept': 'application/json'
}
r = requests.post('https://api.l2k.io/auth/token', headers = headers)
print(r.json())
POST /auth/token
Partner makes a request to the token endpoint by adding the following parameters described below
Body parameter
grant_type: authorization_code
code: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| » grant_type | body | string | true | Value MUST be set to "authorization_code" as per RFC |
| » code | body | string | true | The code received in the query string when redirected from authorization |
Detailed descriptions
» code: The code received in the query string when redirected from authorization page
Enumerated Values
| Parameter | Value |
|---|---|
| » grant_type | authorization_code |
Example responses
Authorisation token (Bearer)
{
"access_token": "ACCESS_TOKEN",
"token_type": "Bearer",
"expires_in": 3600
}
As per RFC authorisation server responds with 400 in case of error
{
"error": "invalid_request"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Authorisation token (Bearer) | token |
| 400 | Bad Request | As per RFC authorisation server responds with 400 in case of error | error |
Invalidate access token
Code samples
# You can also use wget
curl -X DELETE https://api.l2k.io/auth/token
fetch('https://api.l2k.io/auth/token',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.delete 'https://api.l2k.io/auth/token',
params: {
}
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','https://api.l2k.io/auth/token', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
r = requests.delete('https://api.l2k.io/auth/token')
print(r.json())
DELETE /auth/token
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Empty body with 200 code | None |
| 403 | Forbidden | Access Token already invalidated or not found | None |
| 500 | Internal Server Error | Internal server error | None |
Account
Operations about account
user's account
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/account \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/account',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.l2k.io/account',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/account', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/account', headers = headers)
print(r.json())
GET /account
Example responses
200 Response
{
"id": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"picture": "string",
"agencies": {
"id": "string",
"name": "string",
"contact": {
"email": "string",
"phone": "string",
"fax": "string",
"web": "string"
},
"picture": "string",
"place": {
"id": "string",
"address": "string",
"location": {
"lat": 0,
"lng": 0
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | account |
| 400 | Bad Request | Invalid status value | None |
Mandate
Operation about mandates
agency's mandates
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/agency/:agency/mandates \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/mandates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.l2k.io/agency/:agency/mandates',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/agency/:agency/mandates', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/agency/:agency/mandates', headers = headers)
print(r.json())
GET /agency/:agency/mandates
get an array of agency mandates
Example responses
200 Response
[
{
"id": "string",
"project": {
"id": "string",
"type": "string"
},
"place": {
"id": "string",
"address": "string",
"location": {
"lat": 0,
"lng": 0
}
},
"good": {
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"picture": [
"string"
]
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [mandate] | false | none | none |
| » id | string | false | none | none |
| » project | project | false | none | none |
| »» id | string | false | none | none |
| »» type | string | false | none | none |
| » place | place | false | none | none |
| »» id | string | false | none | none |
| »» address | string | false | none | none |
| »» location | location | false | none | none |
| »»» lat | number | false | none | none |
| »»» lng | number | false | none | none |
| » good | good | false | none | none |
| »» type | string | false | none | none |
| »» description | description | false | none | none |
| »»» plus | [string] | false | none | none |
| »»» moins | [string] | false | none | none |
| »»» informatif | [string] | false | none | none |
| »»» qualitatif | [string] | false | none | none |
| »»» quantitatif | [string] | false | none | none |
| »» picture | [string] | false | none | none |
document from id
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/document/:document \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/document/:document',
{
method: 'GET',
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.get 'https://api.l2k.io/document/:document',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/document/:document', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/document/:document', headers = headers)
print(r.json())
GET /document/:document
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | None |
| 400 | Bad Request | Invalid status value | None |
Place
search place from postcode, street and number
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/place/search?postcode=string&street=string&number=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/place/search?postcode=string&street=string&number=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.l2k.io/place/search',
params: {
'postcode' => 'string',
'street' => 'string',
'number' => 'string'
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/place/search', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/place/search', params={
'postcode': 'string', 'street': 'string', 'number': 'string'
}, headers = headers)
print(r.json())
GET /place/search
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| postcode | query | string | true | none |
| street | query | string | true | none |
| number | query | string | true | none |
Example responses
200 Response
[
{
"id": "string",
"address": "string",
"location": {
"lat": 0,
"lng": 0
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [place] | false | none | none |
| » id | string | false | none | none |
| » address | string | false | none | none |
| » location | location | false | none | none |
| »» lat | number | false | none | none |
| »» lng | number | false | none | none |
Get array of every agency's place IDs
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/agency/:agency/places \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/places',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.l2k.io/agency/:agency/places',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/agency/:agency/places', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/agency/:agency/places', headers = headers)
print(r.json())
GET /agency/:agency/places
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| skip | query | number | false | none |
| limit | query | number | false | none |
Example responses
200 Response
{
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | agence.place |
| 400 | Bad Request | Invalid status value | None |
Get agence place
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/agency/:agency/place/:place \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/place/:place',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.l2k.io/agency/:agency/place/:place',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/agency/:agency/place/:place', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/agency/:agency/place/:place', headers = headers)
print(r.json())
GET /agency/:agency/place/:place
Example responses
200 Response
{
"status": "string",
"cas": "string",
"value": {
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » cas | string | false | none | none |
| » value | agence.place | false | none | none |
| »» agence | string | false | none | none |
| »» place | string | false | none | none |
| »» name | string | false | none | none |
| »» address | string | false | none | none |
| »» date | date | false | none | none |
| »»» created | string | false | none | iso 8601 creation date |
| »»» modified | string | false | none | iso 8601 modification date |
| »» immeuble | [immeuble] | true | none | none |
| »»» id | string | false | none | none |
| »»» name | string | false | none | none |
| »»» digicode | string | false | none | none |
| »»» comment | string | false | none | none |
| »»» description | description | false | none | none |
| »»»» plus | [string] | false | none | none |
| »»»» moins | [string] | false | none | none |
| »»»» informatif | [string] | false | none | none |
| »»»» qualitatif | [string] | false | none | none |
| »»»» quantitatif | [string] | false | none | none |
| »»» photo | [document] | false | none | none |
| »»»» id | string | false | none | none |
| »»»» mime | string | false | none | none |
| »»»» description | string | false | none | none |
| »»»» date | string | false | none | iso 8601 |
| »»» escalier | [escalier] | false | none | none |
| »»»» id | string | false | none | none |
| »»»» name | string | false | none | none |
| »»»» photo | [document] | false | none | none |
| »»»» bal | [bal] | false | none | none |
| »»»»» id | string | false | none | none |
| »»»»» palier | integer | false | none | none |
| »»»»» numero | integer | false | none | none |
| »»»»» porte | string | false | none | none |
| »»»»» type | string | false | none | valid values Logement,Commerce,Bureau |
| »»»»» description | description | false | none | none |
| »»»»» photo | [document] | false | none | none |
| »»»»» entreprise | [entreprise] | false | none | none |
| »»»»»» id | string | false | none | none |
| »»»»»» name | string | false | none | none |
| »»»»»» status | string | false | none | none |
| »»»»»» activity | string | false | none | none |
| string | false | none | none | |
| »»»»»» phone | string | false | none | none |
| »»»»»» fax | string | false | none | none |
| »»»»»» web | string | false | none | none |
| »»»»»» comments | string | false | none | none |
| »»»»» person | [person] | false | none | none |
| »»»»»» id | string | false | none | none |
| »»»»»» civility | string | false | none | none |
| »»»»»» firstname | string | false | none | none |
| »»»»»» lastname | string | false | none | none |
| »»»»»» job | string | false | none | none |
| »»»»»» phone | string | false | none | none |
| »»»»»» mobile | string | false | none | none |
| string | false | none | none | |
| »»»»»» web | string | false | none | none |
| »»»»»» comment | string | false | none | none |
| »»»»»» meteo | integer | false | none | none |
Post new agence place
Code samples
# You can also use wget
curl -X POST https://api.l2k.io/agency/:agency/place/:place \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const inputBody = '{
"value": {
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/place/:place',
{
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' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.l2k.io/agency/:agency/place/:place',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.l2k.io/agency/:agency/place/:place', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.l2k.io/agency/:agency/place/:place', headers = headers)
print(r.json())
POST /agency/:agency/place/:place
Body parameter
{
"value": {
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | post.agence.place | true | body |
Example responses
200 Response
{
"status": "string",
"cas": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » cas | string | false | none | none |
Update an agence place
Code samples
# You can also use wget
curl -X PUT https://api.l2k.io/agency/:agency/place/:place \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const inputBody = '{
"cas": "string",
"value": {
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/place/:place',
{
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' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.l2k.io/agency/:agency/place/:place',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.l2k.io/agency/:agency/place/:place', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.l2k.io/agency/:agency/place/:place', headers = headers)
print(r.json())
PUT /agency/:agency/place/:place
Body parameter
{
"cas": "string",
"value": {
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | put.agence.place | true | body |
Example responses
200 Response
{
"status": "string",
"cas": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » cas | string | false | none | none |
Get user place
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/agency/:agency/place/:place/project \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/place/:place/project',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.l2k.io/agency/:agency/place/:place/project',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/agency/:agency/place/:place/project', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/agency/:agency/place/:place/project', headers = headers)
print(r.json())
GET /agency/:agency/place/:place/project
Example responses
200 Response
{
"status": "string",
"cas": "string",
"value": {
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » cas | string | false | none | none |
| » value | user.place | false | none | none |
| »» user | string | false | none | none |
| »» agence | string | false | none | none |
| »» place | string | false | none | none |
| »» date | date | false | none | none |
| »»» created | string | false | none | iso 8601 creation date |
| »»» modified | string | false | none | iso 8601 modification date |
| »» bal | [user.bal] | false | none | none |
| »»» bal | string | false | none | bal identifiant |
| »»» action | [user.action] | false | none | BaL actions |
| »»»» type | string | false | none | none |
| »»»» date | string | false | none | none |
| »»»» comment | string | false | none | none |
| »»» projet | [user.project] | false | none | none |
| »»»» id | string | false | none | none |
| »»»» type | string | false | none | project type identifiant |
| »»»» date | string | false | none | iso 8601 date |
| »»»» expiration | string | false | none | iso 8601 date |
| »»»» comment | string | false | none | none |
| »»»» appointements | [user.appointement] | false | none | [a rendez-vous] |
| »»»»» type | string | false | none | none |
| »»»»» date | string | false | none | iso 8601 date |
| »»»»» meteo | integer | false | none | none |
| »»»»» comment | string | false | none | none |
| »»»» mandat | [user.mandat] | false | none | [mandat or contract] |
| »»»»» id | string | false | none | none |
| »»»»» agence | string | false | none | agence identifiant |
| »»»»» type | string | false | none | none |
| »»»»» expiration | string | false | none | iso 8601 date |
| »»»»» numero | string | false | none | mandat or contract number |
| »»»»» name | string | false | none | mandat or contract name |
| »»»»» steps | [user.mandat.step] | false | none | none |
| »»»»»» date | string | false | none | iso 8601 date |
| »»»»»» name | string | false | none | [signature,suivi,avenant,sans suite] |
| »»»»»» prix | number | false | none | price change |
| »»»»» photo | [document] | false | none | none |
| »»»»»» id | string | false | none | none |
| »»»»»» mime | string | false | none | none |
| »»»»»» description | string | false | none | none |
| »»»»»» date | string | false | none | iso 8601 |
| »»»» phase | [user.document] | false | none | none |
| »»»»» type | string | false | none | none |
| »»»»» status | [user.document.status] | false | none | none |
| »»»»»» date | string | false | none | iso 8601 date |
| »»»»»» step | string | false | none | [En cours,Accepté,Réalisé,Sans suite,Stand bye] |
| »»»»» photo | [document] | false | none | none |
| »»»»» comments | string | false | none | none |
| »» action | [user.action] | false | none | Place actions |
Post new user place
Code samples
# You can also use wget
curl -X POST https://api.l2k.io/agency/:agency/place/:place/project \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const inputBody = '{
"value": {
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/place/:place/project',
{
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' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.l2k.io/agency/:agency/place/:place/project',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','https://api.l2k.io/agency/:agency/place/:place/project', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.l2k.io/agency/:agency/place/:place/project', headers = headers)
print(r.json())
POST /agency/:agency/place/:place/project
Body parameter
{
"value": {
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | post.user.place | true | body |
Example responses
200 Response
{
"status": "string",
"cas": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » cas | string | false | none | none |
Update an user place
Code samples
# You can also use wget
curl -X PUT https://api.l2k.io/agency/:agency/place/:place/project \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const inputBody = '{
"cas": "string",
"value": {
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/place/:place/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' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.l2k.io/agency/:agency/place/:place/project',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','https://api.l2k.io/agency/:agency/place/:place/project', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://api.l2k.io/agency/:agency/place/:place/project', headers = headers)
print(r.json())
PUT /agency/:agency/place/:place/project
Body parameter
{
"cas": "string",
"value": {
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | put.user.place | true | body |
Example responses
200 Response
{
"status": "string",
"cas": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » cas | string | false | none | none |
Get all project types
Code samples
# You can also use wget
curl -X GET https://api.l2k.io/agency/:agency/project.types \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.l2k.io/agency/:agency/project.types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.l2k.io/agency/:agency/project.types',
params: {
}, headers: headers
p JSON.parse(result)
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://api.l2k.io/agency/:agency/project.types', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.l2k.io/agency/:agency/project.types', headers = headers)
print(r.json())
GET /agency/:agency/project.types
Example responses
200 Response
{
"status": "string",
"result": [
{
"id": "string",
"name": "string",
"document": [
"string"
],
"mandat": [
"string"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
| 400 | Bad Request | Invalid status value | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » result | [project.type] | false | none | none |
| »» id | string | false | none | none |
| »» name | string | false | none | none |
| »» document | [string] | false | none | document types |
| »» mandat | [string] | false | none | mandat types |
Schemas
post.authorization
{
"login": "string",
"password": "string",
"client_id": "string",
"state": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| login | string | true | none | none |
| password | string | true | none | none |
| client_id | string | true | none | none |
| state | string | true | none | your session identifiant or random string |
account
{
"id": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"picture": "string",
"agencies": {
"id": "string",
"name": "string",
"contact": {
"email": "string",
"phone": "string",
"fax": "string",
"web": "string"
},
"picture": "string",
"place": {
"id": "string",
"address": "string",
"location": {
"lat": 0,
"lng": 0
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| firstname | string | false | none | none |
| lastname | string | false | none | none |
| string | false | none | none | |
| picture | string | false | none | none |
| agencies | agency | false | none | none |
agency
{
"id": "string",
"name": "string",
"contact": {
"email": "string",
"phone": "string",
"fax": "string",
"web": "string"
},
"picture": "string",
"place": {
"id": "string",
"address": "string",
"location": {
"lat": 0,
"lng": 0
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| name | string | false | none | none |
| contact | contact | false | none | none |
| picture | string | false | none | none |
| place | place | false | none | none |
contact
{
"email": "string",
"phone": "string",
"fax": "string",
"web": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| string | false | none | none | |
| phone | string | false | none | none |
| fax | string | false | none | none |
| web | string | false | none | none |
description
{
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| plus | [string] | false | none | none |
| moins | [string] | false | none | none |
| informatif | [string] | false | none | none |
| qualitatif | [string] | false | none | none |
| quantitatif | [string] | false | none | none |
good
{
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"picture": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| description | description | false | none | none |
| picture | [string] | false | none | none |
location
{
"lat": 0,
"lng": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lat | number | false | none | none |
| lng | number | false | none | none |
mandate
{
"id": "string",
"project": {
"id": "string",
"type": "string"
},
"place": {
"id": "string",
"address": "string",
"location": {
"lat": 0,
"lng": 0
}
},
"good": {
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"picture": [
"string"
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| project | project | false | none | none |
| place | place | false | none | none |
| good | good | false | none | none |
place
{
"id": "string",
"address": "string",
"location": {
"lat": 0,
"lng": 0
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| address | string | false | none | none |
| location | location | false | none | none |
put.agence.place
{
"cas": "string",
"value": {
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cas | string | false | none | none |
| value | agence.place | false | none | none |
post.agence.place
{
"value": {
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | agence.place | false | none | none |
agence.place
{
"agence": "string",
"place": "string",
"name": "string",
"address": "string",
"date": {
"created": "string",
"modified": "string"
},
"immeuble": [
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| agence | string | false | none | none |
| place | string | false | none | none |
| name | string | false | none | none |
| address | string | false | none | none |
| date | date | false | none | none |
| immeuble | [immeuble] | true | none | none |
date
{
"created": "string",
"modified": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | string | false | none | iso 8601 creation date |
| modified | string | false | none | iso 8601 modification date |
immeuble
{
"id": "string",
"name": "string",
"digicode": "string",
"comment": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"escalier": [
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| name | string | false | none | none |
| digicode | string | false | none | none |
| comment | string | false | none | none |
| description | description | false | none | none |
| photo | [document] | false | none | none |
| escalier | [escalier] | false | none | none |
escalier
{
"id": "string",
"name": "string",
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"bal": [
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| name | string | false | none | none |
| photo | [document] | false | none | none |
| bal | [bal] | false | none | none |
bal
{
"id": "string",
"palier": 0,
"numero": 0,
"porte": "string",
"type": "string",
"description": {
"plus": [
"string"
],
"moins": [
"string"
],
"informatif": [
"string"
],
"qualitatif": [
"string"
],
"quantitatif": [
"string"
]
},
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"entreprise": [
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
],
"person": [
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| palier | integer | false | none | none |
| numero | integer | false | none | none |
| porte | string | false | none | none |
| type | string | false | none | valid values Logement,Commerce,Bureau |
| description | description | false | none | none |
| photo | [document] | false | none | none |
| entreprise | [entreprise] | false | none | none |
| person | [person] | false | none | none |
entreprise
{
"id": "string",
"name": "string",
"status": "string",
"activity": "string",
"email": "string",
"phone": "string",
"fax": "string",
"web": "string",
"comments": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| name | string | false | none | none |
| status | string | false | none | none |
| activity | string | false | none | none |
| string | false | none | none | |
| phone | string | false | none | none |
| fax | string | false | none | none |
| web | string | false | none | none |
| comments | string | false | none | none |
person
{
"id": "string",
"civility": "string",
"firstname": "string",
"lastname": "string",
"job": "string",
"phone": "string",
"mobile": "string",
"email": "string",
"web": "string",
"comment": "string",
"meteo": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| civility | string | false | none | none |
| firstname | string | false | none | none |
| lastname | string | false | none | none |
| job | string | false | none | none |
| phone | string | false | none | none |
| mobile | string | false | none | none |
| string | false | none | none | |
| web | string | false | none | none |
| comment | string | false | none | none |
| meteo | integer | false | none | none |
document
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| mime | string | false | none | none |
| description | string | false | none | none |
| date | string | false | none | iso 8601 |
project
{
"id": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| type | string | false | none | none |
put.user.place
{
"cas": "string",
"value": {
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cas | string | false | none | none |
| value | user.place | false | none | none |
post.user.place
{
"value": {
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | user.place | false | none | none |
user.place
{
"user": "string",
"agence": "string",
"place": "string",
"date": {
"created": "string",
"modified": "string"
},
"bal": [
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
],
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| user | string | false | none | none |
| agence | string | false | none | none |
| place | string | false | none | none |
| date | date | false | none | none |
| bal | [user.bal] | false | none | none |
| action | [user.action] | false | none | Place actions |
user.bal
{
"bal": "string",
"action": [
{
"type": "string",
"date": "string",
"comment": "string"
}
],
"projet": [
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bal | string | false | none | bal identifiant |
| action | [user.action] | false | none | BaL actions |
| projet | [user.project] | false | none | none |
user.action
{
"type": "string",
"date": "string",
"comment": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| date | string | false | none | none |
| comment | string | false | none | none |
project.type
{
"id": "string",
"name": "string",
"document": [
"string"
],
"mandat": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| name | string | false | none | none |
| document | [string] | false | none | document types |
| mandat | [string] | false | none | mandat types |
user.project
{
"id": "string",
"type": "string",
"date": "string",
"expiration": "string",
"comment": "string",
"appointements": [
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
],
"mandat": [
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
],
"phase": [
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| type | string | false | none | project type identifiant |
| date | string | false | none | iso 8601 date |
| expiration | string | false | none | iso 8601 date |
| comment | string | false | none | none |
| appointements | [user.appointement] | false | none | [a rendez-vous] |
| mandat | [user.mandat] | false | none | [mandat or contract] |
| phase | [user.document] | false | none | none |
user.document
{
"type": "string",
"status": [
{
"date": "string",
"step": "string"
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
],
"comments": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| status | [user.document.status] | false | none | none |
| photo | [document] | false | none | none |
| comments | string | false | none | none |
user.document.status
{
"date": "string",
"step": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string | false | none | iso 8601 date |
| step | string | false | none | [En cours,Accepté,Réalisé,Sans suite,Stand bye] |
user.mandat
{
"id": "string",
"agence": "string",
"type": "string",
"expiration": "string",
"numero": "string",
"name": "string",
"steps": [
{
"date": "string",
"name": "string",
"prix": 0
}
],
"photo": [
{
"id": "string",
"mime": "string",
"description": "string",
"date": "string"
}
]
}
mandat or contract
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| agence | string | false | none | agence identifiant |
| type | string | false | none | none |
| expiration | string | false | none | iso 8601 date |
| numero | string | false | none | mandat or contract number |
| name | string | false | none | mandat or contract name |
| steps | [user.mandat.step] | false | none | none |
| photo | [document] | false | none | none |
user.mandat.step
{
"date": "string",
"name": "string",
"prix": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string | false | none | iso 8601 date |
| name | string | false | none | [signature,suivi,avenant,sans suite] |
| prix | number | false | none | price change |
user.appointement
{
"type": "string",
"date": "string",
"meteo": 0,
"comment": "string"
}
a rendez-vous
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| date | string | false | none | iso 8601 date |
| meteo | integer | false | none | none |
| comment | string | false | none | none |
token
{
"access_token": "string",
"refresh_token": "string",
"token_type": "Bearer",
"expires_in": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| access_token | string | false | none | The access token value |
| refresh_token | string | false | none | The refresh token value |
| token_type | string | false | none | Type of the token is set to "Bearer" |
| expires_in | integer(int32) | false | none | The lifetime in seconds of the access token |
Enumerated Values
| Property | Value |
|---|---|
| token_type | Bearer |
error
{
"error": "invalid_request",
"error_description": "string",
"error_uri": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | string | false | none | none |
| error_description | string | false | none | Human-readable text providing additional information |
| error_uri | string | false | none | A URI identifying a human-readable web page with information about the error |
Enumerated Values
| Property | Value |
|---|---|
| error | invalid_request |
| error | invalid_client |
| error | invalid_grant |
| error | unauthorized_client |
| error | unsupported_grant_type |