MENU navbar-image

Introduction

Documentation de l'API de l'application Programme 31 Jours

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {VOTRE_TOKEN_JWT}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Obtenez un jeton JWT Keycloak via le front (connexion SSO) ou l’endpoint POST /api/login. Dans Try it out, saisissez le token dans l’en-tête Authorization (préfixe Bearer déjà inclus dans l’exemple). Le même token est réutilisé sur tous les endpoints tant que la page reste ouverte.

01 - User Authentication

POST /api/logout

requires authentication

Logout the user's session

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/logout" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/logout"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/logout';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

POST api/logout

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST /api/login

Request a token for a user's session after providing credentials

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"admin@admin.com\",
    \"password\": \"admin\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "admin@admin.com",
    "password": "admin"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/login';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'admin@admin.com',
            'password' => 'admin',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "accessToken": "eyJhbGciOiJSUz...O3pGQ",
    "refreshToken": "eyJhbGci...RT8",
    "accessExpiresIn": 1800,
    "refreshExpiresIn": 1800,
    "tokenType": "Bearer",
    "scope": "openid profile email"
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Invalid user credentials"
}

Request      

POST api/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The user's email. value doit être une adresse e-mail valide. Example: admin@admin.com

password   string   

The user's password. Example: admin

POST /api/forgot-password

Forgot password process

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/forgot-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/forgot-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/forgot-password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/forgot-password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET /api/userinfo

requires authentication

Get the user's information

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/profile" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/profile"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/profile';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 1,
    "name": "Admin",
    "email": "admin@admin.com",
    "firstname": "Admin",
    "birthdate": null,
    "civilite": "Mr",
    "civil_status": null,
    "mobile_phone": null,
    "secteur_gf": null,
    "reseau_md": null,
    "autre_departement": null,
    "genre": null,
    "created_at": null,
    "updated_at": "2022-01-11 13:15:54",
    "is_active": 1,
    "roles": [
        {
            "id": 1,
            "title": "Admin système"
        },
        {}
    ]
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/profile

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET /api/profils

requires authentication

Get the profile's list

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/profiles" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/profiles"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/profiles';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


[
    {
        "id": "76c378c8-bf14-4460-b350-fd7a0fc6da3a",
        "name": "Prog31 Administrateurs",
        "path": "/Prog31 Administrateurs",
        "profil_code": "administrateur",
        "profil_name": "Administrateur"
    },
    {
        "...": "..."
    }
]

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/profiles

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get new token from refresh token

Get a new token from refresh token

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"refresh_token\": \"ut\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/refresh"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "refresh_token": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/refresh';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'refresh_token' => 'ut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "accessToken": "eyJhbGciOiJSUz...O3pGQ",
    "refreshToken": null,
    "accessExpiresIn": 1800,
    "refreshExpiresIn": 1800,
    "tokenType": "Bearer",
    "scope": "openid profile email"
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Invalid user credentials"
}

Request      

POST api/refresh

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

refresh_token   string   

Example: ut

02 - Utilisateurs

Lister les utilisateurs

requires authentication

Permet de recuperer la liste des utilisateurs avec leurs roles et leur team

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/users" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/users

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Créer un utilisateur

requires authentication

Permet de créer une nouvel utilisateur

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Doe\",
    \"email\": \"john.doe@localhost.com\",
    \"firstname\": \"John\",
    \"mobile_phone\": \"01-23-45-67-89\",
    \"genre\": \"Homme\",
    \"profils\": {
        \"a\": \"Profil a\",
        \"b\": \"profil b\",
        \"c\": \"profil c\"
    }
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Doe",
    "email": "john.doe@localhost.com",
    "firstname": "John",
    "mobile_phone": "01-23-45-67-89",
    "genre": "Homme",
    "profils": {
        "a": "Profil a",
        "b": "profil b",
        "c": "profil c"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/users';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Doe',
            'email' => 'john.doe@localhost.com',
            'firstname' => 'John',
            'mobile_phone' => '01-23-45-67-89',
            'genre' => 'Homme',
            'profils' => [
                'a' => 'Profil a',
                'b' => 'profil b',
                'c' => 'profil c',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 1,
    "name": "Admin",
    "email": "admin@admin.com",
    "firstname": "Admin",
    "birthdate": null,
    "civilite": "Mr",
    "civil_status": null,
    "mobile_phone": null,
    "secteur_gf": null,
    "reseau_md": null,
    "autre_departement": null,
    "genre": null,
    "created_at": null,
    "updated_at": "2022-01-11 13:15:54",
    "is_active": 1,
    "roles": [
        {
            "id": 1,
            "title": "Admin système"
        },
        {}
    ]
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/users

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Nom de l'utilisateur. Example: Doe

email   string   

Email de de l'utilisateur. Example: john.doe@localhost.com

firstname   string   

Prénom de l'utilisateur. Example: John

mobile_phone   string  optional  

Téléphone mobile de l'utilisateur. Example: 01-23-45-67-89

genre   string  optional  

Homme ou Femme. Example: Homme

profils   object  optional  

Liste des profils à affecter.

Afficher un utilisateur

requires authentication

Permet de récupérer les détails d'un utilisateur

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/users/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/users/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 1,
    "name": "Admin",
    "email": "admin@admin.com",
    "firstname": "Admin",
    "birthdate": null,
    "civilite": "Mr",
    "civil_status": null,
    "mobile_phone": null,
    "secteur_gf": null,
    "reseau_md": null,
    "autre_departement": null,
    "genre": null,
    "created_at": null,
    "updated_at": "2022-01-11 13:15:54",
    "is_active": 1,
    "roles": [
        {
            "id": 1,
            "title": "Admin système"
        },
        {}
    ]
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/users/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

Modifier un utilisateur

requires authentication

Permet de modifier un utilisateur

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Doe\",
    \"roles\": [
        5
    ],
    \"firstname\": \"John\",
    \"birthdate\": \"2022-01-11\",
    \"mobile_phone\": \"01-23-45-67-89\",
    \"reseau_md\": \"MD A\",
    \"autre_departement\": \"iste\",
    \"genre\": \"Homme\",
    \"civilite\": \"Mr\",
    \"civil_status\": \"Célibataire\",
    \"is_active\": true
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Doe",
    "roles": [
        5
    ],
    "firstname": "John",
    "birthdate": "2022-01-11",
    "mobile_phone": "01-23-45-67-89",
    "reseau_md": "MD A",
    "autre_departement": "iste",
    "genre": "Homme",
    "civilite": "Mr",
    "civil_status": "Célibataire",
    "is_active": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/users/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Doe',
            'roles' => [
                5,
            ],
            'firstname' => 'John',
            'birthdate' => '2022-01-11',
            'mobile_phone' => '01-23-45-67-89',
            'reseau_md' => 'MD A',
            'autre_departement' => 'iste',
            'genre' => 'Homme',
            'civilite' => 'Mr',
            'civil_status' => 'Célibataire',
            'is_active' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 1,
    "name": "Admin",
    "email": "admin@admin.com",
    "firstname": "Admin",
    "birthdate": null,
    "civilite": "Mr",
    "civil_status": null,
    "mobile_phone": null,
    "secteur_gf": null,
    "reseau_md": null,
    "autre_departement": null,
    "genre": null,
    "created_at": null,
    "updated_at": "2022-01-11 13:15:54",
    "is_active": 1,
    "roles": [
        {
            "id": 1,
            "title": "Admin système"
        },
        {}
    ]
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/users/{id}

PATCH api/v1/users/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

Body Parameters

name   string  optional  

Nom de l'utilisateur. Example: Doe

roles   integer[]  optional  
firstname   string  optional  

Prénom de l'utilisateur. Example: John

birthdate   string  optional  

Date de naissance de l'utilisateur. Must be a valid date in the format Y-m-d. Example: 2022-01-11

mobile_phone   string  optional  

Téléphone mobile de l'utilisateur. Example: 01-23-45-67-89

reseau_md   string  optional  

Réseau de MD de l'utilisateur. Example: MD A

autre_departement   string  optional  

Example: iste

genre   string  optional  

Homme ou Femme. Example: Homme

civilite   string  optional  

Mr, Mme ou Mlle. Example: Mr

civil_status   string  optional  

Marié(e), Célibataire, Veuf(ve), Divorc(é).... Example: Célibataire

is_active   boolean   

indique si le compte est actif ou non. Example: true

Supprimer un utilisateur

requires authentication

Permet de supprimer un utilisateur (soft delete)

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/users/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/users/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

DELETE api/v1/users/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

Listes des genres

requires authentication

Permet de récupérer la liste des genres (Homme ou Femme)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/user-genres" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-genres"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-genres';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/user-genres

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Quota par utilisateur

requires authentication

Permet de recuperer le qutota de suivi par utilisateur

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/user-quota" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-quota"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-quota';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/user-quota

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Listes des civilités

requires authentication

Permet de récupérer les civilités (Mr Mme Mlle)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/user-civilites" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-civilites"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-civilites';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/user-civilites

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Listes des états civils

requires authentication

Permet de récupérer les civilités (Mr Mme Mlle)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/user-etat-civils" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-etat-civils"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-etat-civils';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/user-etat-civils

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Trouver des utilisateurs

requires authentication

Permet de récupérer les détails d'un utilisateur

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-find" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pattern\": \"corporis\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-find"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "pattern": "corporis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-find';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'pattern' => 'corporis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 1,
    "name": "Admin",
    "email": "admin@admin.com",
    "firstname": "Admin",
    "birthdate": null,
    "civilite": "Mr",
    "civil_status": null,
    "mobile_phone": null,
    "secteur_gf": null,
    "reseau_md": null,
    "autre_departement": null,
    "genre": null,
    "created_at": null,
    "updated_at": "2022-01-11 13:15:54",
    "is_active": 1,
    "roles": [
        {
            "id": 1,
            "title": "Admin système"
        },
        {}
    ]
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

POST api/v1/user-find

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

pattern   string   

motif de recherche. Example: corporis

03 - Contacts

Lister les contacts

requires authentication

Permet de recuperer la liste des utilisateurs avec leurs roles et leur team

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contacts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contacts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Créer un contact

requires authentication

Permet de créer une nouveau contact

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lastname\": \"qui\",
    \"firstname\": \"Jean\",
    \"etat_civil\": \"Marié(e)\",
    \"birthdate\": \"2022-01-11\",
    \"metier\": \"Agriculteur\",
    \"telephone\": \"01-23-45-67-89\",
    \"email\": \"pink.predovic@example.net\",
    \"genre\": \"Homme\",
    \"civilite\": \"Mr\",
    \"est_mineur\": false,
    \"source_id\": 1,
    \"subscription_date\": \"2022-01-11\",
    \"ville\": \"Le Blanc-Mesnil\",
    \"code_postal\": \"93150\",
    \"secteur_gf\": \"Secteur 1\",
    \"adresse_postale\": \"7 rue Isaac Newton\",
    \"nationalite\": \"deleniti\",
    \"langue_parlee\": \"esse\",
    \"autre_telephone\": \"eligendi\",
    \"num_personne_foyer\": \"nihil\",
    \"invite_par\": \"ullam\",
    \"date_conversion\": \"2026-05-27\",
    \"conseiller_nc\": \"eveniet\",
    \"est_candidat_prog31\": true,
    \"est_candidat_visite\": false,
    \"est_converti_cec\": false,
    \"is_livre\": false,
    \"observations\": \"et\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lastname": "qui",
    "firstname": "Jean",
    "etat_civil": "Marié(e)",
    "birthdate": "2022-01-11",
    "metier": "Agriculteur",
    "telephone": "01-23-45-67-89",
    "email": "pink.predovic@example.net",
    "genre": "Homme",
    "civilite": "Mr",
    "est_mineur": false,
    "source_id": 1,
    "subscription_date": "2022-01-11",
    "ville": "Le Blanc-Mesnil",
    "code_postal": "93150",
    "secteur_gf": "Secteur 1",
    "adresse_postale": "7 rue Isaac Newton",
    "nationalite": "deleniti",
    "langue_parlee": "esse",
    "autre_telephone": "eligendi",
    "num_personne_foyer": "nihil",
    "invite_par": "ullam",
    "date_conversion": "2026-05-27",
    "conseiller_nc": "eveniet",
    "est_candidat_prog31": true,
    "est_candidat_visite": false,
    "est_converti_cec": false,
    "is_livre": false,
    "observations": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contacts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lastname' => 'qui',
            'firstname' => 'Jean',
            'etat_civil' => 'Marié(e)',
            'birthdate' => '2022-01-11',
            'metier' => 'Agriculteur',
            'telephone' => '01-23-45-67-89',
            'email' => 'pink.predovic@example.net',
            'genre' => 'Homme',
            'civilite' => 'Mr',
            'est_mineur' => false,
            'source_id' => 1,
            'subscription_date' => '2022-01-11',
            'ville' => 'Le Blanc-Mesnil',
            'code_postal' => '93150',
            'secteur_gf' => 'Secteur 1',
            'adresse_postale' => '7 rue Isaac Newton',
            'nationalite' => 'deleniti',
            'langue_parlee' => 'esse',
            'autre_telephone' => 'eligendi',
            'num_personne_foyer' => 'nihil',
            'invite_par' => 'ullam',
            'date_conversion' => '2026-05-27',
            'conseiller_nc' => 'eveniet',
            'est_candidat_prog31' => true,
            'est_candidat_visite' => false,
            'est_converti_cec' => false,
            'is_livre' => false,
            'observations' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "Dupont",
        "firstname": "Marie",
        "etat_civil": "Marié(e)",
        "birthdate": "2022-01-11",
        "metier": "Institutrice",
        "telephone": "01-23-45-67-89",
        "email": "est",
        "genre": "Femme",
        "civilite": "Mme",
        "est_mineur": false,
        "liste_id": 2,
        "source_id": 2,
        "updated_at": "2022-01-12 14:07:21",
        "created_at": "2022-01-12 14:07:21",
        "id": 2,
        "subscription_date": "2023-07-24 16:05:24",
        "ville": null,
        "code_postal": null,
        "secteur_gf": null,
        "adresse_postale": null,
        "liste": {
            "id": 2,
            "libelle": "Persévérance",
            "code": "PSV",
            "description": "Liste des contacts dont le suivi est suspendu"
        },
        "source": {
            "id": 2,
            "libelle": "Evangélisation",
            "code": "EVG",
            "description": "Contact provenant d'une campagne d'évangélisation"
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/contacts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lastname   string   

Example: qui

firstname   string   

Prénom du contact. Example: Jean

etat_civil   string  optional  

Etat civil du contact. Example: Marié(e)

birthdate   string  optional  

Date de naissance du contact. Must be a valid date in the format Y-m-d. Example: 2022-01-11

metier   string  optional  

Métier du contact. Example: Agriculteur

telephone   string  optional  

Téléphone mobile du contact. Example: 01-23-45-67-89

email   string  optional  

Example: pink.predovic@example.net

genre   string  optional  

Homme ou Femme. Example: Homme

civilite   string  optional  

Mr, Mme ou Mlle. Example: Mr

est_mineur   boolean  optional  

Example: false

source_id   integer   

Id d'origine d'inscription du contact. Example: 1

subscription_date   string   

Date d'inscription ou de conversion. Must be a valid date in the format Y-m-d. Example: 2022-01-11

ville   string  optional  

Ville de résidence du contact. Example: Le Blanc-Mesnil

code_postal   string  optional  

Code postal de résidence du contact. Example: 93150

secteur_gf   string  optional  

Secteur de GF de résidence. Example: Secteur 1

adresse_postale   string  optional  

Adresse postale du contact. Example: 7 rue Isaac Newton

nationalite   string  optional  

Example: deleniti

langue_parlee   string  optional  

Example: esse

autre_telephone   string  optional  

Example: eligendi

num_personne_foyer   string  optional  

Example: nihil

invite_par   string  optional  

Example: ullam

date_conversion   string  optional  

Must be a valid date in the format Y-m-d. Example: 2026-05-27

conseiller_nc   string  optional  

Example: eveniet

est_candidat_prog31   boolean  optional  

Example: true

est_candidat_visite   boolean  optional  

Example: false

est_converti_cec   boolean  optional  

Example: false

is_livre   boolean  optional  

Indique si le contact a reçu le livre "31 Jours". Example: false

observations   string  optional  

Example: et

Afficher un contact

requires authentication

Permet de récupérer les détails d'un contact

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "Dupont",
        "firstname": "Marie",
        "etat_civil": "Marié(e)",
        "birthdate": "2022-01-11",
        "metier": "Institutrice",
        "telephone": "01-23-45-67-89",
        "email": "est",
        "genre": "Femme",
        "civilite": "Mme",
        "est_mineur": false,
        "liste_id": 2,
        "source_id": 2,
        "updated_at": "2022-01-12 14:07:21",
        "created_at": "2022-01-12 14:07:21",
        "id": 2,
        "subscription_date": "2023-07-24 16:05:24",
        "ville": null,
        "code_postal": null,
        "secteur_gf": null,
        "adresse_postale": null,
        "liste": {
            "id": 2,
            "libelle": "Persévérance",
            "code": "PSV",
            "description": "Liste des contacts dont le suivi est suspendu"
        },
        "source": {
            "id": 2,
            "libelle": "Evangélisation",
            "code": "EVG",
            "description": "Contact provenant d'une campagne d'évangélisation"
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

GET api/v1/contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the contact. Example: 291

Modifier un contact

requires authentication

Permet de modifier un contact

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lastname\": \"et\",
    \"firstname\": \"Jean\",
    \"etat_civil\": \"Marié(e)\",
    \"birthdate\": \"2022-01-11\",
    \"metier\": \"Agriculteur\",
    \"telephone\": \"01-23-45-67-89\",
    \"email\": \"fiona.prosacco@example.com\",
    \"genre\": \"Homme\",
    \"civilite\": \"Mr\",
    \"est_mineur\": true,
    \"liste_id\": 1,
    \"source_id\": 1,
    \"subscription_date\": \"2022-01-11\",
    \"ville\": \"Le Blanc-Mesnil\",
    \"code_postal\": \"93150\",
    \"secteur_gf\": \"Secteur 1\",
    \"adresse_postale\": \"7 rue Isaac Newton\",
    \"is_livre\": false
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lastname": "et",
    "firstname": "Jean",
    "etat_civil": "Marié(e)",
    "birthdate": "2022-01-11",
    "metier": "Agriculteur",
    "telephone": "01-23-45-67-89",
    "email": "fiona.prosacco@example.com",
    "genre": "Homme",
    "civilite": "Mr",
    "est_mineur": true,
    "liste_id": 1,
    "source_id": 1,
    "subscription_date": "2022-01-11",
    "ville": "Le Blanc-Mesnil",
    "code_postal": "93150",
    "secteur_gf": "Secteur 1",
    "adresse_postale": "7 rue Isaac Newton",
    "is_livre": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'lastname' => 'et',
            'firstname' => 'Jean',
            'etat_civil' => 'Marié(e)',
            'birthdate' => '2022-01-11',
            'metier' => 'Agriculteur',
            'telephone' => '01-23-45-67-89',
            'email' => 'fiona.prosacco@example.com',
            'genre' => 'Homme',
            'civilite' => 'Mr',
            'est_mineur' => true,
            'liste_id' => 1,
            'source_id' => 1,
            'subscription_date' => '2022-01-11',
            'ville' => 'Le Blanc-Mesnil',
            'code_postal' => '93150',
            'secteur_gf' => 'Secteur 1',
            'adresse_postale' => '7 rue Isaac Newton',
            'is_livre' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "Dupont",
        "firstname": "Marie",
        "etat_civil": "Marié(e)",
        "birthdate": "2022-01-11",
        "metier": "Institutrice",
        "telephone": "01-23-45-67-89",
        "email": "est",
        "genre": "Femme",
        "civilite": "Mme",
        "est_mineur": false,
        "liste_id": 2,
        "source_id": 2,
        "updated_at": "2022-01-12 14:07:21",
        "created_at": "2022-01-12 14:07:21",
        "id": 2,
        "subscription_date": "2023-07-24 16:05:24",
        "ville": null,
        "code_postal": null,
        "secteur_gf": null,
        "adresse_postale": null,
        "liste": {
            "id": 2,
            "libelle": "Persévérance",
            "code": "PSV",
            "description": "Liste des contacts dont le suivi est suspendu"
        },
        "source": {
            "id": 2,
            "libelle": "Evangélisation",
            "code": "EVG",
            "description": "Contact provenant d'une campagne d'évangélisation"
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/contacts/{id}

PATCH api/v1/contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the contact. Example: 291

Body Parameters

lastname   string   

Example: et

firstname   string   

Prénom du contact. Example: Jean

etat_civil   string  optional  

Etat civil du contact. Example: Marié(e)

birthdate   string  optional  

Date de naissance du contact. Must be a valid date in the format Y-m-d. Example: 2022-01-11

metier   string  optional  

Métier du contact. Example: Agriculteur

telephone   string  optional  

Téléphone mobile du contact. Example: 01-23-45-67-89

email   string  optional  

Example: fiona.prosacco@example.com

genre   string  optional  

Homme ou Femme. Example: Homme

civilite   string  optional  

Mr, Mme ou Mlle. Example: Mr

est_mineur   boolean  optional  

Example: true

liste_id   integer  optional  

Id de liste de suivi du contact. Example: 1

source_id   integer   

Id d'origine d'inscription du contact. Example: 1

subscription_date   string  optional  

Date d'inscription ou de conversion. Must be a valid date in the format Y-m-d. Example: 2022-01-11

ville   string  optional  

Ville de résidence du contact. Example: Le Blanc-Mesnil

code_postal   string  optional  

Code postal de résidence du contact. Example: 93150

secteur_gf   string  optional  

Secteur de GF de résidence. Example: Secteur 1

adresse_postale   string  optional  

Adresse postale du contact. Example: 7 rue Isaac Newton

is_livre   boolean  optional  

Indique si le contact a reçu le livre "31 Jours". Example: false

Supprimer un contact

requires authentication

Permet de supprimer un contact (soft delete)

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contacts/291';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

DELETE api/v1/contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the contact. Example: 291

Listes des genres

requires authentication

Permet de récupérer la liste des genres (Homme ou Femme)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-genres" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-genres"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-genres';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

GET api/v1/contact-genres

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste principale

requires authentication

Permet de recuperer la liste des contacts de la liste principale

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-principale

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste principale Adulte

requires authentication

Permet de recuperer la liste des contacts adultes de la liste principale

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale-adulte" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale-adulte"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale-adulte';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-principale-adulte

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste principale Adolescent

requires authentication

Permet de recuperer la liste des contacts adolescents de la liste principale

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale-ado" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale-ado"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-principale-ado';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-principale-ado

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Mes saisies

requires authentication

Permet de recuperer la liste des contacts en attente saisis par l'utilisateur authentifié

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-mes-saisies" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-mes-saisies"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-mes-saisies';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-mes-saisies

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste perséverance

requires authentication

Permet de recuperer la liste des contacts de la liste perseverance

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-perseverance

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste perséverance Adulte

requires authentication

Permet de recuperer la liste des contacts de la liste perseverance

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance-adulte" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance-adulte"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance-adulte';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-perseverance-adulte

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste perséverance Adolescent

requires authentication

Permet de recuperer la liste des contacts de la liste perseverance

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance-ado" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance-ado"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-perseverance-ado';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-perseverance-ado

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste attente attribution

requires authentication

Permet de recuperer la liste des contacts en attente d'attribution pour un coach

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-attente

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste attente attribution adulte

requires authentication

Permet de recuperer la liste des contacts adultes en attente d'attribution pour un coach

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente-adulte" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente-adulte"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente-adulte';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-attente-adulte

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Contacts - Liste attente attribution adolescents

requires authentication

Permet de recuperer la liste des contacts adolescents en attente d'attribution pour un coach

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente-ado" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente-ado"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-attente-ado';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-attente-ado

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Listes des civilités

requires authentication

Permet de récupérer les civilités (Mr Mme Mlle)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-civilites" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-civilites"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-civilites';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

GET api/v1/contact-civilites

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Listes des états civils

requires authentication

Permet de récupérer les civilités (Mr Mme Mlle)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-etat-civils" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-etat-civils"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-etat-civils';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

GET api/v1/contact-etat-civils

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Listes des secteurs de GF

requires authentication

Permet de récupérer les secteurs de GF

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-secteurs-gf" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-secteurs-gf"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-secteurs-gf';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

GET api/v1/contact-secteurs-gf

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Lister les Villes

requires authentication

Permet de récupérer les villes avec code postal et secteur associés

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-villes" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-villes"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-villes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

GET api/v1/contact-villes

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Trouver des contacts

requires authentication

Permet de retrouver des contacts par nom, prénom, email, ou numéro de téléphone

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-find" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pattern\": \"eveniet\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-find"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "pattern": "eveniet"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-find';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'pattern' => 'eveniet',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "Dupont",
        "firstname": "Marie",
        "etat_civil": "Marié(e)",
        "birthdate": "2022-01-11",
        "metier": "Institutrice",
        "telephone": "01-23-45-67-89",
        "email": "est",
        "genre": "Femme",
        "civilite": "Mme",
        "est_mineur": false,
        "liste_id": 2,
        "source_id": 2,
        "updated_at": "2022-01-12 14:07:21",
        "created_at": "2022-01-12 14:07:21",
        "id": 2,
        "subscription_date": "2023-07-24 16:05:24",
        "ville": null,
        "code_postal": null,
        "secteur_gf": null,
        "adresse_postale": null,
        "liste": {
            "id": 2,
            "libelle": "Persévérance",
            "code": "PSV",
            "description": "Liste des contacts dont le suivi est suspendu"
        },
        "source": {
            "id": 2,
            "libelle": "Evangélisation",
            "code": "EVG",
            "description": "Contact provenant d'une campagne d'évangélisation"
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

POST api/v1/contact-find

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

pattern   string   

motif de recherche. Example: eveniet

Trouver le secteur GF d'une ville

requires authentication

Permet de retrouver le secteur GF d'une ville à partir de son code postal

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-find-secteur/eos" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-find-secteur/eos"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-find-secteur/eos';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

POST api/v1/contact-find-secteur/{code}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

code   string   

Example: eos

Archiver un contact

requires authentication

Permet de placer un contact dans la liste archive

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-archive/291" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-archive/291"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-archive/291';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "message": "Contact archivé avec succès",
    "data": {
        "contact_id": 123,
        "contact_name": "Jean Dupont",
        "liste_archive_id": 5,
        "liste_archive_name": "Archive",
        "archived_at": "2024-01-15 14:30:00",
        "suivis_fermes": 2
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Contact introuvable",
    "path": null,
    "description": "Le contact spécifié n'existe pas"
}

Example response (422):


{
    "code": 422,
    "message": "Contact déjà archivé",
    "path": null,
    "description": "Le contact est déjà dans la liste archive"
}

Request      

POST api/v1/contact-archive/{contact_id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact_id   integer   

The ID of the contact. Example: 291

04 - Affectations de suivi

Lister les affectations de suivi

requires authentication

Permet de recuperer la liste des affectations de suivi (coach / contact)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-contacts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Créer une affectation de suivi

requires authentication

Permet de créer une affectation de suivi

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_id\": 1,
    \"coach_id\": 1,
    \"date_debut\": \"2022-01-15 00:00:00\",
    \"date_fin\": \"2022-01-19 00:00:00\",
    \"commentaires\": \"RAS\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contact_id": 1,
    "coach_id": 1,
    "date_debut": "2022-01-15 00:00:00",
    "date_fin": "2022-01-19 00:00:00",
    "commentaires": "RAS"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'contact_id' => 1,
            'coach_id' => 1,
            'date_debut' => '2022-01-15 00:00:00',
            'date_fin' => '2022-01-19 00:00:00',
            'commentaires' => 'RAS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "contact_id": 2,
        "coach_id": 2,
        "date_debut": "2022-01-18 16:30:11",
        "updated_at": "2022-01-18 16:30:11",
        "created_at": "2022-01-18 16:30:11",
        "id": 3,
        "contact": {
            "id": 2,
            "civilite": "Mme",
            "lastname": "Dupont",
            "firstname": "Marie",
            "etat_civil": "Marié(e)",
            "genre": "Femme",
            "birthdate": "2022-01-11",
            "est_mineur": 0,
            "metier": "Agriculteur",
            "telephone": "01-23-45-67-89",
            "email": "est",
            "created_at": "2022-01-12 14:07:21",
            "updated_at": "2022-01-12 14:07:21",
            "deleted_at": null,
            "liste_id": 2,
            "source_id": 2
        },
        "coach": {
            "id": 2,
            "name": "D'ALMEIDA",
            "email": "laurenda1fr@yahoo.fr",
            "firstname": "Laurenda",
            "birthdate": null,
            "civilite": "Mme",
            "civil_status": "Marié(e)",
            "mobile_phone": null,
            "secteur_gf": null,
            "reseau_md": null,
            "autre_departement": null,
            "genre": null,
            "created_at": "2021-10-06 20:15:38",
            "updated_at": "2021-10-06 20:15:38",
            "is_active": 1
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/suivi-contacts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

contact_id   integer   

Id du contact à suivre. The id of an existing record in the contacts table. Example: 1

coach_id   integer   

Id du coach. The id of an existing record in the users table. Example: 1

date_debut   string  optional  

Date de début du suivi. Must be a valid date in the format Y-m-d. Example: 2022-01-15 00:00:00

date_fin   string  optional  

Date de fin du suivi. Must be a valid date in the format Y-m-d. Example: 2022-01-19 00:00:00

commentaires   string  optional  

Commentaires. Example: RAS

Afficher une affection de suivi

requires authentication

Permet de récupérer les détails d'une affectation de suivi d'un contact

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "contact_id": 2,
        "coach_id": 2,
        "date_debut": "2022-01-18 16:30:11",
        "updated_at": "2022-01-18 16:30:11",
        "created_at": "2022-01-18 16:30:11",
        "id": 3,
        "contact": {
            "id": 2,
            "civilite": "Mme",
            "lastname": "Dupont",
            "firstname": "Marie",
            "etat_civil": "Marié(e)",
            "genre": "Femme",
            "birthdate": "2022-01-11",
            "est_mineur": 0,
            "metier": "Agriculteur",
            "telephone": "01-23-45-67-89",
            "email": "est",
            "created_at": "2022-01-12 14:07:21",
            "updated_at": "2022-01-12 14:07:21",
            "deleted_at": null,
            "liste_id": 2,
            "source_id": 2
        },
        "coach": {
            "id": 2,
            "name": "D'ALMEIDA",
            "email": "laurenda1fr@yahoo.fr",
            "firstname": "Laurenda",
            "birthdate": null,
            "civilite": "Mme",
            "civil_status": "Marié(e)",
            "mobile_phone": null,
            "secteur_gf": null,
            "reseau_md": null,
            "autre_departement": null,
            "genre": null,
            "created_at": "2021-10-06 20:15:38",
            "updated_at": "2021-10-06 20:15:38",
            "is_active": 1
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/suivi-contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi contact. Example: 1

suivi_contact   integer   

ID de l'objet suivi_contact. Exemple : 1 Example: 1

Modifier une affectation de suivi

requires authentication

Permet de modifier une affectation de suivi

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_debut\": \"2022-01-15\",
    \"date_fin\": \"2022-01-19\",
    \"commentaires\": \"RAS\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_debut": "2022-01-15",
    "date_fin": "2022-01-19",
    "commentaires": "RAS"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'date_debut' => '2022-01-15',
            'date_fin' => '2022-01-19',
            'commentaires' => 'RAS',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "contact_id": 2,
        "coach_id": 2,
        "date_debut": "2022-01-18 16:30:11",
        "updated_at": "2022-01-18 16:30:11",
        "created_at": "2022-01-18 16:30:11",
        "id": 3,
        "contact": {
            "id": 2,
            "civilite": "Mme",
            "lastname": "Dupont",
            "firstname": "Marie",
            "etat_civil": "Marié(e)",
            "genre": "Femme",
            "birthdate": "2022-01-11",
            "est_mineur": 0,
            "metier": "Agriculteur",
            "telephone": "01-23-45-67-89",
            "email": "est",
            "created_at": "2022-01-12 14:07:21",
            "updated_at": "2022-01-12 14:07:21",
            "deleted_at": null,
            "liste_id": 2,
            "source_id": 2
        },
        "coach": {
            "id": 2,
            "name": "D'ALMEIDA",
            "email": "laurenda1fr@yahoo.fr",
            "firstname": "Laurenda",
            "birthdate": null,
            "civilite": "Mme",
            "civil_status": "Marié(e)",
            "mobile_phone": null,
            "secteur_gf": null,
            "reseau_md": null,
            "autre_departement": null,
            "genre": null,
            "created_at": "2021-10-06 20:15:38",
            "updated_at": "2021-10-06 20:15:38",
            "is_active": 1
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/suivi-contacts/{id}

PATCH api/v1/suivi-contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi contact. Example: 1

suivi_contact   integer   

ID de l'objet suivi_contact. Exemple : 1 Example: 11

Body Parameters

date_debut   string  optional  

Date de début du suivi. Must be a valid date in the format Y-m-d. Example: 2022-01-15

date_fin   string  optional  

Date de fin du suivi. Must be a valid date in the format Y-m-d. Example: 2022-01-19

commentaires   string  optional  

Commentaires. Example: RAS

Supprimer une affectation de suivi

requires authentication

Permet de supprimer une affectation de suivi (soft delete)

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-contacts/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

DELETE api/v1/suivi-contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi contact. Example: 1

suivi_contact   integer   

ID de l'objet suivi_contact. Exemple : 1 Example: 2

Mes affectations de suivi

requires authentication

Permet de récupérer les contacts suivis par l'utilisateur connecté

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/mes-affectations" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/mes-affectations"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/mes-affectations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "contact_id": 2,
        "coach_id": 2,
        "date_debut": "2022-01-18 16:30:11",
        "updated_at": "2022-01-18 16:30:11",
        "created_at": "2022-01-18 16:30:11",
        "id": 3,
        "contact": {
            "id": 2,
            "civilite": "Mme",
            "lastname": "Dupont",
            "firstname": "Marie",
            "etat_civil": "Marié(e)",
            "genre": "Femme",
            "birthdate": "2022-01-11",
            "est_mineur": 0,
            "metier": "Agriculteur",
            "telephone": "01-23-45-67-89",
            "email": "est",
            "created_at": "2022-01-12 14:07:21",
            "updated_at": "2022-01-12 14:07:21",
            "deleted_at": null,
            "liste_id": 2,
            "source_id": 2
        },
        "coach": {
            "id": 2,
            "name": "D'ALMEIDA",
            "email": "laurenda1fr@yahoo.fr",
            "firstname": "Laurenda",
            "birthdate": null,
            "civilite": "Mme",
            "civil_status": "Marié(e)",
            "mobile_phone": null,
            "secteur_gf": null,
            "reseau_md": null,
            "autre_departement": null,
            "genre": null,
            "created_at": "2021-10-06 20:15:38",
            "updated_at": "2021-10-06 20:15:38",
            "is_active": 1
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/mes-affectations

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

05 - Sessions de bilans

Liste des particiapations aux sessions de bilans

requires authentication

Permet de recuperer la liste des participations aux sessions de bilans

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/session-bilans

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Enregistrer une participation à un bilan

requires authentication

Permet d'enregistrer la participation d'un contact à une session de bilan pour un contact

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_id\": 1,
    \"bilan_id\": 1,
    \"date\": \"2022-01-15 00:00:00\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contact_id": 1,
    "bilan_id": 1,
    "date": "2022-01-15 00:00:00"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'contact_id' => 1,
            'bilan_id' => 1,
            'date' => '2022-01-15 00:00:00',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "name": "Toto",
        "email": "toto@localhost.com",
        "firstname": "John",
        "mobile_phone": "01-23-45-67-89",
        "genre": "Mademoiselle",
        "civilite": "Mr",
        "civil_status": "Célibataire",
        "updated_at": "2022-02-15 11:20:54",
        "created_at": "2022-02-15 11:20:54",
        "id": 11,
        "roles": [
            {
                "id": 1,
                "title": "Admin système"
            }
        ],
        "team": null
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/session-bilans

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

contact_id   integer   

Id du contact à suivre. The id of an existing record in the contacts table. Example: 1

bilan_id   integer   

Id du bilan. The id of an existing record in the bilans table. Example: 1

date   string   

Date de la session. Must be a valid date in the format Y-m-d. Example: 2022-01-15 00:00:00

Afficher une participation pour un contact

requires authentication

Permet de récupérer les détails d'une participation d'un contact à un session de bilan

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "date": "2022-01-17",
        "bilan_id": 2,
        "contact_id": 1,
        "bilan": {
            "id": 2,
            "nom": "Bilan Semaine 2",
            "code": "BS2",
            "description": "Bilan Semaine 2",
            "programme_id": 1
        },
        "contact": {
            "id": 1,
            "civilite": "Mr",
            "lastname": "Dupont",
            "firstname": "Jean",
            "etat_civil": "Marié(e)",
            "genre": "Homme",
            "birthdate": "2022-01-11",
            "est_mineur": 0,
            "metier": "Agriculteur",
            "telephone": "01-23-45-67-89",
            "email": "ipsum",
            "liste_id": 1,
            "source_id": 1
        }
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/session-bilans/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session bilan. Example: 1

session_bilan   integer   

ID de l'objet session_bilan. Exemple : 1 Example: 20

Modifier une participation pour un contact

requires authentication

Permet de modifier les détails d'une participation d'un contact à un session de bilan

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"2022-01-15 00:00:00\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date": "2022-01-15 00:00:00"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'date' => '2022-01-15 00:00:00',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "date": "2022-01-10",
        "id": 1
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/session-bilans/{id}

PATCH api/v1/session-bilans/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session bilan. Example: 1

session_bilan   integer   

ID de l'objet session_bilan. Exemple : 1 Example: 16

Body Parameters

date   string   

Date de la session. Must be a valid date in the format Y-m-d. Example: 2022-01-15 00:00:00

Supprimer une participation pour un contact

requires authentication

Permet de supprimer la participation d'un contact à une session de bilan (soft delete)

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/session-bilans/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

DELETE api/v1/session-bilans/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the session bilan. Example: 1

session_bilan   integer   

ID de l'objet session_bilan Exemple : 1 Example: 5

06 - Suivi téléphonique

Liste des suivis téléphoniques

requires authentication

Permet d'afficher la liste des suivis téléphoniques

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephoniques

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Enregistrer suivi téléphonique

requires authentication

Permet d'enregistrer le rapport d'un suivi téléphonique

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_appel\": \"2022-01-15 15:30:00\",
    \"commentaires\": \"N.A\",
    \"contact_id\": 1,
    \"coach_id\": 1,
    \"statut_id\": 1
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_appel": "2022-01-15 15:30:00",
    "commentaires": "N.A",
    "contact_id": 1,
    "coach_id": 1,
    "statut_id": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'date_appel' => '2022-01-15 15:30:00',
            'commentaires' => 'N.A',
            'contact_id' => 1,
            'coach_id' => 1,
            'statut_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "contact_id": 2,
        "coach_id": 5,
        "date_appel": "2022-01-24 15:40:00",
        "commentaires": "test de création de suivi téléphonique",
        "statut_id": 4,
        "updated_at": "2022-02-16 14:41:05",
        "created_at": "2022-02-16 14:41:05",
        "id": 1
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/suivi-telephoniques

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

date_appel   string   

Date et heure d'appel du suivi. Must be a valid date in the format Y-m-d. Example: 2022-01-15 15:30:00

commentaires   string  optional  

Commentaires éventuels saisis par le coach. Example: N.A

contact_id   integer   

Id du contact à suivre. The id of an existing record in the contacts table. Example: 1

coach_id   integer   

Id du coach qui effectue le bilan. The id of an existing record in the users table. Example: 1

statut_id   integer   

Id du statut du suivi. The id of an existing record in the statut_appels table. Example: 1

Afficher un suivi téléphonique

requires authentication

Permet de récupérer les détails d'un rapport de suivi téléphonique

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/12" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/12"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/12';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "date_appel": "2022-01-24 15:40:00",
        "commentaires": "test de création de suivi téléphonique",
        "contact_id": 2,
        "coach_id": 5,
        "statut_id": 4,
        "contact": {
            "id": 2,
            "civilite": "Mme",
            "lastname": "Dupont",
            "firstname": "Marie-Claire",
            "etat_civil": "Marié(e)",
            "genre": "Femme",
            "birthdate": "2022-01-11",
            "est_mineur": 1,
            "metier": "Agriculteur",
            "telephone": "01-23-45-67-89",
            "email": "est",
            "liste_id": 1,
            "source_id": 1
        },
        "coach": {
            "id": 5,
            "name": "Ngoileye",
            "email": "emailtestlaurence@yahoo.fr",
            "firstname": "Laurence",
            "birthdate": "1985-06-12",
            "civilite": "Mme",
            "civil_status": "Marié(e)",
            "mobile_phone": "0612121212",
            "secteur_gf": "Secteur 7",
            "reseau_md": "MD Intensité",
            "autre_departement": "Libéralité",
            "genre": "Femme",
            "created_at": "2021-11-13 23:11:06",
            "updated_at": "2021-11-13 23:15:21",
            "keycloak_user_id": null,
            "is_active": 1
        },
        "statut": {
            "id": 4,
            "libelle": "Changement de coach",
            "code": "CCH",
            "description": "Changement de coach",
            "type": "PCP"
        },
        "team": null
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/suivi-telephoniques/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi telephonique. Example: 12

suivi_telephonique   integer   

ID de l'objet suivi_telephonique. Exemple : 1 Example: 18

Modifier un suivi téléphonique

requires authentication

Permet de modifier les détails d'une participation d'un contact à un session de bilan

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/10" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_appel\": \"2022-01-15 15:30:00\",
    \"commentaires\": \"N.A\",
    \"statut_id\": 1
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/10"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_appel": "2022-01-15 15:30:00",
    "commentaires": "N.A",
    "statut_id": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/10';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'date_appel' => '2022-01-15 15:30:00',
            'commentaires' => 'N.A',
            'statut_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "date_appel": "2022-01-23 16:35:00",
        "commentaires": "test de modification de suivi téléphonique",
        "statut_id": 3,
        "id": 1
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/suivi-telephoniques/{id}

PATCH api/v1/suivi-telephoniques/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi telephonique. Example: 10

suivi_telephonique   integer   

ID de l'objet suivi_telephonique. Exemple : 1 Example: 1

Body Parameters

date_appel   string  optional  

Date et heure d'appel du suivi. Must be a valid date in the format Y-m-d. Example: 2022-01-15 15:30:00

commentaires   string  optional  

Commentaires éventuels saisis par le coach. Example: N.A

statut_id   integer   

Id du statut du suivi. The id of an existing record in the statut_appels table. Example: 1

Supprimer un suivi téléphonique

requires authentication

Permet de supprimer le rapport de suivi téléphonique

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/12" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/12"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephoniques/12';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

DELETE api/v1/suivi-telephoniques/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi telephonique. Example: 12

suivi_telephonique   integer   

ID de l'objet suivi_telephonique Exemple : 1 Example: 20

Mon suivi téléphonique

requires authentication

Permet d'afficher la liste des suivis téléphoniques de l'utilisateur connecté

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/mon-suivi-telephonique" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/mon-suivi-telephonique"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/mon-suivi-telephonique';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/mon-suivi-telephonique

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Suivi téléphonique persévérance

requires authentication

Permet d'afficher la liste des suivis téléphoniques de la liste de persévérance

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephonique-perseverance

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Suivi téléphonique persévérance adulte

requires authentication

Permet d'afficher la liste des suivis téléphoniques de la liste de persévérance

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance-adulte" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance-adulte"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance-adulte';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephonique-perseverance-adulte

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Suivi téléphonique persévérance adolescent

requires authentication

Permet d'afficher la liste des suivis téléphoniques de la liste de persévérance

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance-ado" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance-ado"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-perseverance-ado';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephonique-perseverance-ado

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Suivi téléphonique principale

requires authentication

Permet d'afficher la liste des suivis téléphoniques de la liste principale

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-principale" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-principale"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-principale';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephonique-principale

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Listes des statuts d'action

requires authentication

Permet de récupérer la liste des statuts d'action

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-liste-actions" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-liste-actions"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-liste-actions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "Id inconnu"
}

Request      

GET api/v1/suivi-telephonique-liste-actions

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Suivi pour action

requires authentication

Permet d'afficher la liste des suivis téléphoniques necéssitant une action

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephonique-action

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Suivi pour action adulte

requires authentication

Permet d'afficher la liste des suivis téléphoniques necéssitant une action (adulte)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action-adulte" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action-adulte"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action-adulte';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephonique-action-adulte

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Suivi pour action ado

requires authentication

Permet d'afficher la liste des suivis téléphoniques necéssitant une action (ado)

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action-ado" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action-ado"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-telephonique-action-ado';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/suivi-telephonique-action-ado

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

07 - Paramètres

Lister les paramètes

requires authentication

Permet de recuperer la liste des paramètres

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/configs" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/configs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/configs

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Créer un paramètre

requires authentication

Permet de créer un nouveau paramètre

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quota_suivi_contact\",
    \"value\": \"10\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "quota_suivi_contact",
    "value": "10"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/configs';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'quota_suivi_contact',
            'value' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "quota_suivi_contact",
        "value": "10"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/configs

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Nom du paramètre. Example: quota_suivi_contact

value   string   

Valeur du paramètre. Example: 10

Afficher un paramètre par son Id

requires authentication

Permet de récupérer les détails d'un paramètre par son id

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "quota_suivi_contact",
        "value": "10"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/configs/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the config. Example: 1

Modifier un paramètre

requires authentication

Permet de modifier un paramètre

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quota_suivi_contact\",
    \"value\": \"10\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "quota_suivi_contact",
    "value": "10"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'quota_suivi_contact',
            'value' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "quota_suivi_contact",
        "value": "10"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/configs/{id}

PATCH api/v1/configs/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the config. Example: 1

Body Parameters

name   string   

Nom du paramètre. Example: quota_suivi_contact

value   string   

Valeur du paramètre. Example: 10

Supprimer un paramètre

requires authentication

Permet de supprimer un paramètre

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/configs/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

DELETE api/v1/configs/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the config. Example: 1

Afficher un paramètre

requires authentication

Permet de récupérer les détails d'un paramètre par som nom

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/config-by-name/nemo" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/config-by-name/nemo"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/config-by-name/nemo';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "lastname": "quota_suivi_contact",
        "value": "10"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/config-by-name/{name}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

name   string   

Example: nemo

08 - Certificats

POST /api/v1/diplomes/print

requires authentication

Print and dowload diplomes

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/print" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"users\": [
        16
    ]
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/print"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "users": [
        16
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/print';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'users' => [
                16,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{"document file"}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Invalid parameters"
}

Request      

POST api/v1/diplomes/print

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

users   integer[]  optional  

POST /api/v1/diplomes/update-date

requires authentication

Update date of certification

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/update-date" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"users\": [
        10
    ]
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/update-date"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "users": [
        10
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/update-date';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'users' => [
                10,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{"results : ok"}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Invalid parameters"
}

Request      

POST api/v1/diplomes/update-date

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

users   integer[]  optional  

POST /api/v1/diplomes/latests

requires authentication

Print and dowload latest diplomes

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/latests" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/latests"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/diplomes/latests';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{"document file"}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Invalid parameters"
}

Request      

GET api/v1/diplomes/latests

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

09 - Types de Contact

Lister les types de contacts

requires authentication

Permet de recuperer la liste des types de contacts

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-list-types

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Créer un type de contact

requires authentication

Permet de créer une nouveau type contact

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"libelle\": \"consectetur\",
    \"code\": \"similique\",
    \"description\": \"Omnis maxime eos voluptas ea accusantium.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "libelle": "consectetur",
    "code": "similique",
    "description": "Omnis maxime eos voluptas ea accusantium."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'libelle' => 'consectetur',
            'code' => 'similique',
            'description' => 'Omnis maxime eos voluptas ea accusantium.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "libelle": "Principale",
        "code": "PCP",
        "description": "Liste principale des contacts"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/contact-list-types

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

libelle   string   

Example: consectetur

code   string   

Example: similique

description   string  optional  

Example: Omnis maxime eos voluptas ea accusantium.

Afficher un type de contact

requires authentication

Permet de récupérer les détails d'un type de contact

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "libelle": "Principale",
        "code": "PCP",
        "description": "Liste principale des contacts"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/contact-list-types/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the contact list type. Example: 1

Modifier un type de contact

requires authentication

Permet de modifier un type de contact

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"libelle\": \"debitis\",
    \"code\": \"temporibus\",
    \"description\": \"Maiores qui facere cum quisquam ab voluptas.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "libelle": "debitis",
    "code": "temporibus",
    "description": "Maiores qui facere cum quisquam ab voluptas."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'libelle' => 'debitis',
            'code' => 'temporibus',
            'description' => 'Maiores qui facere cum quisquam ab voluptas.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "libelle": "Principale",
        "code": "PCP",
        "description": "Liste principale des contacts"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/contact-list-types/{id}

PATCH api/v1/contact-list-types/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the contact list type. Example: 1

Body Parameters

libelle   string   

Example: debitis

code   string   

Example: temporibus

description   string  optional  

Example: Maiores qui facere cum quisquam ab voluptas.

Supprimer un type de contact

requires authentication

Permet de supprimer un type de contact (soft delete)

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

DELETE api/v1/contact-list-types/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the contact list type. Example: 1

Lister les types de contacts actifs

requires authentication

Permet de recuperer la liste des types de contacts ayant le statut actif

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types-active" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types-active"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types-active';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/contact-list-types-active

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Importer les types de contacts depuis le fichier JSON

requires authentication

Permet d'importer les types de contacts depuis le fichier import_liste.json L'import se base sur le champ 'code' comme clé d'unicité

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types-import" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types-import"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/contact-list-types-import';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "message": "Import terminé avec succès",
    "data": {
        "created": 3,
        "updated": 2,
        "total": 5
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Fichier d'import introuvable",
    "path": null,
    "description": "Le fichier import_liste.json n'existe pas dans le dossier storage/import"
}

Example response (422):


{
    "code": 422,
    "message": "Format JSON invalide",
    "path": null,
    "description": "Le fichier JSON contient des erreurs de syntaxe"
}

Example response (500):


{
    "code": 500,
    "message": "Erreur lors de l'import",
    "path": null,
    "description": "Le fichier d'import n'a pas pu être lu"
}

Request      

POST api/v1/contact-list-types-import

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

10 - Sources de Contact

Lister les sources de contacts

requires authentication

Permet de recuperer la liste des sources de contacts

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{ "data" : [ {...}, {...} ] }

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Request      

GET api/v1/source-contacts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Créer une source de contact

requires authentication

Permet de créer une nouvelle source de contact

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"libelle\": \"facere\",
    \"code\": \"dolorum\",
    \"description\": \"Quos est quia autem harum voluptate.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "libelle": "facere",
    "code": "dolorum",
    "description": "Quos est quia autem harum voluptate."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'libelle' => 'facere',
            'code' => 'dolorum',
            'description' => 'Quos est quia autem harum voluptate.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "libelle": "Nouveaux Convertis",
        "code": "NCO",
        "description": "Contact provenant de la liste des nouveaux convertis"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

POST api/v1/source-contacts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

libelle   string  optional  

Example: facere

code   string  optional  

Example: dolorum

description   string  optional  

Example: Quos est quia autem harum voluptate.

Afficher une source de contact

requires authentication

Permet de récupérer les détails d'une source de contact

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "libelle": "Nouveaux Convertis",
        "code": "NCO",
        "description": "Contact provenant de la liste des nouveaux convertis"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

GET api/v1/source-contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the source contact. Example: 1

Modifier une source de contact

requires authentication

Permet de modifier une source de contact

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"libelle\": \"laudantium\",
    \"code\": \"in\",
    \"description\": \"Cupiditate ut consequatur deserunt consequuntur autem corrupti recusandae quas.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "libelle": "laudantium",
    "code": "in",
    "description": "Cupiditate ut consequatur deserunt consequuntur autem corrupti recusandae quas."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'libelle' => 'laudantium',
            'code' => 'in',
            'description' => 'Cupiditate ut consequatur deserunt consequuntur autem corrupti recusandae quas.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 1,
        "libelle": "Nouveaux Convertis",
        "code": "NCO",
        "description": "Contact provenant de la liste des nouveaux convertis"
    }
}

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Example response (422):


{ "message" : "The given data was invalid.", "error" : {...}}

Request      

PUT api/v1/source-contacts/{id}

PATCH api/v1/source-contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the source contact. Example: 1

Body Parameters

libelle   string  optional  

Example: laudantium

code   string  optional  

Example: in

description   string  optional  

Example: Cupiditate ut consequatur deserunt consequuntur autem corrupti recusandae quas.

Supprimer une source de contact

requires authentication

Permet de supprimer une source de contact (soft delete)

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/source-contacts/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

Empty response

Example response (401):


{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Bad token"
}

Example response (404):


{
    "code": 404,
    "message": "Resource not found",
    "path": null,
    "description": "No query result found for this Id"
}

Request      

DELETE api/v1/source-contacts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the source contact. Example: 1

Endpoints

GET api/v1/roles

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/roles" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/roles';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/roles

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/roles

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"delectus\",
    \"permissions\": [
        18
    ]
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "delectus",
    "permissions": [
        18
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/roles';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'delectus',
            'permissions' => [
                18,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/roles

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Example: delectus

permissions   integer[]  optional  

GET api/v1/roles/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/roles/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 1

PUT api/v1/roles/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"unde\",
    \"permissions\": [
        3
    ]
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "unde",
    "permissions": [
        3
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'unde',
            'permissions' => [
                3,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PUT api/v1/roles/{id}

PATCH api/v1/roles/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 1

Body Parameters

title   string   

Example: unde

permissions   integer[]  optional  

DELETE api/v1/roles/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/roles/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/roles/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 1

GET api/v1/statut-appels

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/statut-appels

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/statut-appels

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"libelle\": \"dolorem\",
    \"code\": \"facere\",
    \"description\": \"Repudiandae nisi omnis amet.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "libelle": "dolorem",
    "code": "facere",
    "description": "Repudiandae nisi omnis amet."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'libelle' => 'dolorem',
            'code' => 'facere',
            'description' => 'Repudiandae nisi omnis amet.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/statut-appels

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

libelle   string  optional  

Example: dolorem

code   string  optional  

Example: facere

description   string  optional  

Example: Repudiandae nisi omnis amet.

GET api/v1/teams

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/teams" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/teams';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/teams

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/teams

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"natus\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "natus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/teams';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'natus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/teams

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: natus

GET api/v1/teams/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/teams/19" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams/19"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/teams/19';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/teams/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the team. Example: 19

PUT api/v1/teams/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams/13" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quia\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams/13"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "quia"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/teams/13';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'quia',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PUT api/v1/teams/{id}

PATCH api/v1/teams/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the team. Example: 13

Body Parameters

name   string   

Example: quia

DELETE api/v1/teams/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams/3" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/teams/3"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/teams/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/teams/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the team. Example: 3

GET api/v1/user-alerts

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/user-alerts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/user-alerts

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"alert_text\": \"voluptate\",
    \"alert_link\": \"accusantium\",
    \"users\": [
        15
    ]
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "alert_text": "voluptate",
    "alert_link": "accusantium",
    "users": [
        15
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'alert_text' => 'voluptate',
            'alert_link' => 'accusantium',
            'users' => [
                15,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/user-alerts

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

alert_text   string   

Example: voluptate

alert_link   string  optional  

Example: accusantium

users   integer[]  optional  

POST api/v1/content-pages/media

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/media" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/media"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/media';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/content-pages/media

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/content-pages

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/content-pages

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/content-pages

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"suscipit\",
    \"categories\": [
        12
    ],
    \"tags\": [
        13
    ]
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "suscipit",
    "categories": [
        12
    ],
    "tags": [
        13
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'suscipit',
            'categories' => [
                12,
            ],
            'tags' => [
                13,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/content-pages

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Example: suscipit

categories   integer[]  optional  
tags   integer[]  optional  

GET api/v1/programmes

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/programmes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/programmes

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/programmes

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"nom\": \"aut\",
    \"description\": \"Autem iste dolor aut ut aut laudantium.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "nom": "aut",
    "description": "Autem iste dolor aut ut aut laudantium."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/programmes';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'nom' => 'aut',
            'description' => 'Autem iste dolor aut ut aut laudantium.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/programmes

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

nom   string   

Example: aut

description   string  optional  

Example: Autem iste dolor aut ut aut laudantium.

GET api/v1/programmes/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/programmes/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/programmes/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the programme. Example: 1

DELETE api/v1/programmes/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/programmes/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/programmes/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/programmes/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the programme. Example: 1

GET api/v1/bilans

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/bilans';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/bilans

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/bilans

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"nom\": \"rerum\",
    \"code\": \"nihil\",
    \"description\": \"Sit quae dolor numquam voluptas beatae.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "nom": "rerum",
    "code": "nihil",
    "description": "Sit quae dolor numquam voluptas beatae."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/bilans';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'nom' => 'rerum',
            'code' => 'nihil',
            'description' => 'Sit quae dolor numquam voluptas beatae.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/bilans

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

nom   string   

Example: rerum

code   string  optional  

Example: nihil

description   string  optional  

Example: Sit quae dolor numquam voluptas beatae.

GET api/v1/bilans/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/bilans/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/bilans/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the bilan. Example: 1

DELETE api/v1/bilans/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/bilans/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/bilans/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/bilans/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the bilan. Example: 1

GET api/v1/formations

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/formations" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/formations"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/formations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/formations

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/formations

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/formations" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"nom\": \"iure\",
    \"description\": \"Ipsa distinctio fugiat veritatis ut.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/formations"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "nom": "iure",
    "description": "Ipsa distinctio fugiat veritatis ut."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/formations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'nom' => 'iure',
            'description' => 'Ipsa distinctio fugiat veritatis ut.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/formations

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

nom   string   

Example: iure

description   string  optional  

Example: Ipsa distinctio fugiat veritatis ut.

GET api/v1/formations/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/formations/18" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/formations/18"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/formations/18';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/formations/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the formation. Example: 18

DELETE api/v1/formations/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/formations/3" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/formations/3"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/formations/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/formations/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the formation. Example: 3

GET api/v1/suivi-formations

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/suivi-formations

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/suivi-formations

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_formation\": \"2026-05-27\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_formation": "2026-05-27"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'date_formation' => '2026-05-27',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/v1/suivi-formations

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

date_formation   string  optional  

Must be a valid date in the format Y-m-d. Example: 2026-05-27

POST api/register

requires authentication

Example request:
curl --request POST \
    "https://api.programme-31.ppd.info-charisma.com/api/register" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"repellat\",
    \"email\": \"irwin13@example.com\",
    \"password\": \"k|YvImT}\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/register"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "repellat",
    "email": "irwin13@example.com",
    "password": "k|YvImT}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/register';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'repellat',
            'email' => 'irwin13@example.com',
            'password' => 'k|YvImT}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

POST api/register

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: repellat

email   string   

value doit être une adresse e-mail valide. Example: irwin13@example.com

password   string   

value doit être au moins 6 caractères. Example: k|YvImT}

GET api/v1/statut-appels/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/statut-appels/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the statut appel. Example: 1

PUT api/v1/statut-appels/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"libelle\": \"in\",
    \"code\": \"temporibus\",
    \"description\": \"Quia placeat sed alias id adipisci voluptatem voluptate.\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "libelle": "in",
    "code": "temporibus",
    "description": "Quia placeat sed alias id adipisci voluptatem voluptate."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'libelle' => 'in',
            'code' => 'temporibus',
            'description' => 'Quia placeat sed alias id adipisci voluptatem voluptate.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PUT api/v1/statut-appels/{id}

PATCH api/v1/statut-appels/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the statut appel. Example: 1

Body Parameters

libelle   string  optional  

Example: in

code   string  optional  

Example: temporibus

description   string  optional  

Example: Quia placeat sed alias id adipisci voluptatem voluptate.

DELETE api/v1/statut-appels/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/statut-appels/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/statut-appels/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the statut appel. Example: 1

GET api/v1/user-alerts/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts/1" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts/1"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/user-alerts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user alert. Example: 1

DELETE api/v1/user-alerts/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts/3" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts/3"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/user-alerts/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/user-alerts/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user alert. Example: 3

GET api/v1/content-pages/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/16" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/16"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/16';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/content-pages/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the content page. Example: 16

PUT api/v1/content-pages/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/9" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"quis\",
    \"categories\": [
        7
    ],
    \"tags\": [
        2
    ]
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/9"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "quis",
    "categories": [
        7
    ],
    "tags": [
        2
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/9';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'quis',
            'categories' => [
                7,
            ],
            'tags' => [
                2,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PUT api/v1/content-pages/{id}

PATCH api/v1/content-pages/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the content page. Example: 9

Body Parameters

title   string   

Example: quis

categories   integer[]  optional  
tags   integer[]  optional  

DELETE api/v1/content-pages/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/15" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/15"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/content-pages/15';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/content-pages/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the content page. Example: 15

GET api/v1/suivi-formations/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/16" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/16"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/16';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "code": 401,
    "message": "Unauthorized",
    "path": null,
    "description": "Token expired",
    "userid": null,
    "accessToken": null
}

Request      

GET api/v1/suivi-formations/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi formation. Example: 16

PUT api/v1/suivi-formations/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/15" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_formation\": \"2026-05-27\"
}"

const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/15"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_formation": "2026-05-27"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/15';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'date_formation' => '2026-05-27',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

PUT api/v1/suivi-formations/{id}

PATCH api/v1/suivi-formations/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi formation. Example: 15

Body Parameters

date_formation   string  optional  

Must be a valid date in the format Y-m-d. Example: 2026-05-27

DELETE api/v1/suivi-formations/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/6" \
    --header "Authorization: Bearer {VOTRE_TOKEN_JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/6"
);

const headers = {
    "Authorization": "Bearer {VOTRE_TOKEN_JWT}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.programme-31.ppd.info-charisma.com/api/v1/suivi-formations/6';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {VOTRE_TOKEN_JWT}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request      

DELETE api/v1/suivi-formations/{id}

Headers

Authorization      

Example: Bearer {VOTRE_TOKEN_JWT}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the suivi formation. Example: 6