NAV -image
bash javascript php

Introduction

Description où je sais pas quoi mettre alors NTM

Faudrait qu'on rédige une ontro, ça fait bien XD.

Base URL

https://api.oss.coop/

Authenticating requests

Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {ACCESS_TOKEN}".

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

Le token est généré via le endpoint Authentification => Connexion.

Authentification

Connexion

Essaye une authentification et retourne le jeton JWT (stateless).

Example request:

curl -X POST \
    "https://api.oss.coop/authentification/connexion" \
    -H "Content-Type: application/json" \
    -d '{"identifiant":"ljaeger","motdepasse":"test"}'

const url = new URL(
    "https://api.oss.coop/authentification/connexion"
);

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

let body = {
    "identifiant": "ljaeger",
    "motdepasse": "test"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/authentification/connexion',
    [
        'headers' => [],
        'json' => [
            'identifiant' => 'ljaeger',
            'motdepasse' => 'test',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "jeton": "unechainesuperlonguetoutechelou",
        "jeton_type": "bearer",
        "expire_dans": 86400,
        "utilisateur": {
            "id": 1,
            "entite": {
                "id": 1,
                "type": {
                    "id": 1,
                    "uid": "id_unique_universel",
                    "designation": "valeur"
                },
                "parent": null
            },
            "nom": "Louis",
            "prenom": "JAEGER",
            "nom_complet": "Louis JAEGER",
            "email": "ljaeger@diatem.net",
            "identifiant": "ljaeger",
            "telportable": "012345789"
        }
    }
}

Request   

POST authentification/connexion

Body Parameters

identifiant  string  
L'identifiant de l'utilisateur à authentifier.

motdepasse  string  
Le mot de passe de l'utilisateur à authentifier et oui sans espace ou underscore c'est moche. Vive l'anglais !

Rafraichir

requires authentication

Permet à un utilisateur authentifié de récupérer un nouveau token sans réutiliser le couple identifiant / mot de passe.

Example request:

curl -X GET \
    -G "https://api.oss.coop/authentification/rafraichir" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/authentification/rafraichir"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/authentification/rafraichir',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "jeton": "unechainesuperlonguetoutechelou",
        "jeton_type": "bearer",
        "expire_dans": 86400
    }
}

Request   

GET authentification/rafraichir

Deconnexion

requires authentication

Permet d'invalider un token JWT.

Example request:

curl -X GET \
    -G "https://api.oss.coop/authentification/deconnexion" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/authentification/deconnexion"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/authentification/deconnexion',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

GET authentification/deconnexion

Profil - Voir

requires authentication

Permet à un utilisateur authentifié de récupérer son profil.

Example request:

curl -X GET \
    -G "https://api.oss.coop/authentification/profil" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/authentification/profil"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/authentification/profil',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "entite": {
            "id": 1,
            "type": {
                "id": 1,
                "uid": "id_unique_universel",
                "designation": "valeur"
            },
            "pays": {
                "id": 1,
                "valeur": "france"
            },
            "parent": null,
            "nom": "Pays de Candy",
            "adresse": "2 Rue Docteur Slump",
            "cp": "69666",
            "ville": "D* City",
            "actif": true,
            "description": "Blablabla",
            "logotype_principal": null,
            "logotype_secondaire1": null,
            "logotype_secondaire2": null
        },
        "profils": [
            {
                "id": 1,
                "uid": "id_unique_universel",
                "designation": "valeur"
            }
        ],
        "nom": "Louis",
        "prenom": "JAEGER",
        "nom_complet": "Louis JAEGER",
        "email": "ljaeger@diatem.net",
        "identifiant": "ljaeger",
        "telportable": "012345789",
        "couleur": 2
    }
}

Request   

GET authentification/profil

Profil - Modifier

requires authentication

Permet à un utilisateur authentifié de modifier son profil.

Example request:

curl -X PUT \
    "https://api.oss.coop/authentification/profil" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Luc-Jean","prenom":"Ztirf","email":"ljztirf@diatem.net","actif":true,"telportable":"0123456789"}'

const url = new URL(
    "https://api.oss.coop/authentification/profil"
);

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

let body = {
    "nom": "Luc-Jean",
    "prenom": "Ztirf",
    "email": "ljztirf@diatem.net",
    "actif": true,
    "telportable": "0123456789"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/authentification/profil',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Luc-Jean',
            'prenom' => 'Ztirf',
            'email' => 'ljztirf@diatem.net',
            'actif' => true,
            'telportable' => '0123456789',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "entite": {
            "id": 1,
            "type": {
                "id": 1,
                "uid": "id_unique_universel",
                "designation": "valeur"
            },
            "parent": null
        },
        "profils": [
            {
                "id": 1,
                "uid": "id_unique_universel",
                "designation": "valeur"
            }
        ],
        "nom": "Luc-Jean",
        "prenom": "Ztirf",
        "nom_complet": "Luc-Jean Ztirf",
        "email": "ljztirf@diatem.net",
        "identifiant": "ljztirf",
        "telportable": "0123456789",
        "couleur": 3
    }
}

Request   

PUT authentification/profil

Body Parameters

nom  string optional  
Le nom de l'utilisateur. Défaut à null.

prenom  string optional  
Le prénom de l'utilisateur. Défaut à null.

email  string  
L'email de l'utilisateur.

actif  boolean optional  
Si l'utilisateur est actif. Défaut à true

telportable  string optional  
Le téléphone portable de l'utilisateur. Défaut à null.

Profil - Mot de passe

requires authentication

Permet à un utilisateur authentifié de modifier son mot de passe.

Example request:

curl -X PUT \
    "https://api.oss.coop/authentification/profil/mdp" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"motdepasse":"oldpwd","nouveau_motdepasse":"newpwd","nouveau_motdepasse_confirmation":"newpwd"}'

const url = new URL(
    "https://api.oss.coop/authentification/profil/mdp"
);

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

let body = {
    "motdepasse": "oldpwd",
    "nouveau_motdepasse": "newpwd",
    "nouveau_motdepasse_confirmation": "newpwd"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/authentification/profil/mdp',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'motdepasse' => 'oldpwd',
            'nouveau_motdepasse' => 'newpwd',
            'nouveau_motdepasse_confirmation' => 'newpwd',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": "Le mot de passe à été renouvelé."
}

Request   

PUT authentification/profil/mdp

Body Parameters

motdepasse  string  
Le mot de passe actuel.

nouveau_motdepasse  string  
Le nouveau mot de passe.

nouveau_motdepasse_confirmation  string  
Confirmation du nouveau mot de passe (identique au champs précédent).

Identifiants - Rappel

Envoie un mail à l'utilisateur lui rappelant les identifiants qu'il peut utiliser.

Example request:

curl -X POST \
    "https://api.oss.coop/authentification/rappel_identifiants" \
    -H "Content-Type: application/json" \
    -d '{"email":"ljaeger@diatem.net"}'

const url = new URL(
    "https://api.oss.coop/authentification/rappel_identifiants"
);

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

let body = {
    "email": "ljaeger@diatem.net"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/authentification/rappel_identifiants',
    [
        'headers' => [],
        'json' => [
            'email' => 'ljaeger@diatem.net',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": "Un email contenant vos identifiants à été envoyé."
}

Request   

POST authentification/rappel_identifiants

Body Parameters

email  string  
Un mail d'uilisateur existant.

Mot de passe - Demande de renouvellement

Envoie un mail à l'utilisateur contenant un lien de renouvellement de mot de passe.

Example request:

curl -X POST \
    "https://api.oss.coop/authentification/mdp" \
    -H "Content-Type: application/json" \
    -d '{"identifiant":"ljaeger"}'

const url = new URL(
    "https://api.oss.coop/authentification/mdp"
);

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

let body = {
    "identifiant": "ljaeger"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/authentification/mdp',
    [
        'headers' => [],
        'json' => [
            'identifiant' => 'ljaeger',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": "Un email de renouvellement de mot de passe à été envoyé."
}

Request   

POST authentification/mdp

Body Parameters

identifiant  string  
Un identifiant d'uilisateur existant.

Mot de passe - Renouvellement

Renouvellement de mot de passe à partir email et jeton valides.

Example request:

curl -X POST \
    "https://api.oss.coop/authentification/mdp/AZERTYUIOP123456789#" \
    -H "Content-Type: application/json" \
    -d '{"motdepasse":"newpwd","motdepasse_confirmation":"newpwd"}'

const url = new URL(
    "https://api.oss.coop/authentification/mdp/AZERTYUIOP123456789#"
);

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

let body = {
    "motdepasse": "newpwd",
    "motdepasse_confirmation": "newpwd"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/authentification/mdp/AZERTYUIOP123456789#',
    [
        'headers' => [],
        'json' => [
            'motdepasse' => 'newpwd',
            'motdepasse_confirmation' => 'newpwd',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": "Le mot de passe à été renouvelé."
}

Request   

POST authentification/mdp/{jeton}

URL Parameters

jeton  string  
Le jton de renouvellement de mot de passe.

Body Parameters

motdepasse  string  
Le nouveau mot de passe.

motdepasse_confirmation  string  
Confirmation du nouveau mot de passe (identique au champs précédent).

Commandes

Lister

requires authentication

Liste des commandes

Example request:

curl -X GET \
    -G "https://api.oss.coop/commande?sort=nom.ASC%2Cid.DESC&page=6&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/commande',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "creation": "2150-12-31 12:00:00+02",
            "reception": null,
            "adresse": null,
            "codepostal": null,
            "ville": null,
            "informationscomplementaires": null,
            "nom": null,
            "contact": null,
            "tel": null,
            "pays": null,
            "statut": { ... }
        }
    ]
}

Request   

GET commande

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'une commande

Example request:

curl -X GET \
    -G "https://api.oss.coop/commande/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/commande/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "creation": "2150-12-31 12:00:00+02",
        "reception": null,
        "adresse": null,
        "codepostal": null,
        "ville": null,
        "informationscomplementaires": null,
        "nom": null,
        "contact": null,
        "tel": null,
        "pays": null,
        "statut": { ... }
    }
}

Request   

GET commande/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la commande.

Ajouter

requires authentication

Ajoute une commande

Example request:

curl -X POST \
    "https://api.oss.coop/commande" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"creation":"2150-12-31 12:00:00+02","adresse":"2 Rue de Dublin","codepostal":"67300","ville":"Schiltigheim","informationscomplementaires":"Informations complementaires","nom":"Mathieu","contact":"0123456789","pays_id":1}'

const url = new URL(
    "https://api.oss.coop/commande"
);

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

let body = {
    "creation": "2150-12-31 12:00:00+02",
    "adresse": "2 Rue de Dublin",
    "codepostal": "67300",
    "ville": "Schiltigheim",
    "informationscomplementaires": "Informations complementaires",
    "nom": "Mathieu",
    "contact": "0123456789",
    "pays_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/commande',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'creation' => '2150-12-31 12:00:00+02',
            'adresse' => '2 Rue de Dublin',
            'codepostal' => '67300',
            'ville' => 'Schiltigheim',
            'informationscomplementaires' => 'Informations complementaires',
            'nom' => 'Mathieu',
            'contact' => '0123456789',
            'pays_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "creation": "2150-12-31 12:00:00+02",
        "reception": null,
        "adresse": "2 Rue de Dublin",
        "codepostal": "67300",
        "ville": "Schiltigheim",
        "informationscomplementaires": "Informations complementaires,"
        "nom": "Mathieu",
        "contact": "mhaller@diatem.net",
        "tel": "0123456789",
        "pays": { ... },
        "statut": { ... }
    }
}

Request   

POST commande

Body Parameters

creation  string optional  
La date de creation de la commande.

adresse  string optional  
La date de creation de la commande.

codepostal  string optional  
La date de creation de la commande.

ville  string optional  
La date de creation de la commande.

informationscomplementaires  string optional  
La date de creation de la commande.

nom  string optional  
La date de creation de la commande.

contact  string optional  
La date de creation de la commande.

pays_id  integer optional  
L'identifiant de la valeur du référentiel pays.

Modifier

requires authentication

Modifie une commande

Example request:

curl -X PUT \
    "https://api.oss.coop/commande/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"creation":"null","adresse":"null","codepostal":"null","ville":"null","informationscomplementaires":"null","nom":"null","contact":"null","pays_id":0}'

const url = new URL(
    "https://api.oss.coop/commande/2"
);

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

let body = {
    "creation": "null",
    "adresse": "null",
    "codepostal": "null",
    "ville": "null",
    "informationscomplementaires": "null",
    "nom": "null",
    "contact": "null",
    "pays_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/commande/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'creation' => 'null',
            'adresse' => 'null',
            'codepostal' => 'null',
            'ville' => 'null',
            'informationscomplementaires' => 'null',
            'nom' => 'null',
            'contact' => 'null',
            'pays_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "creation": "2150-12-31 12:00:00+02",
        "reception": null,
        "adresse": null,
        "codepostal": null,
        "ville": null,
        "informationscomplementaires": null,
        "nom": null,
        "contact": null,
        "tel": null,
        "pays": null,
        "statut": { ... }
    }
}

Request   

PUT commande/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la commande.

Body Parameters

creation  string optional  
La date de creation de la commande.

adresse  string optional  
La date de creation de la commande.

codepostal  string optional  
La date de creation de la commande.

ville  string optional  
La date de creation de la commande.

informationscomplementaires  string optional  
La date de creation de la commande.

nom  string optional  
La date de creation de la commande.

contact  string optional  
La date de creation de la commande.

pays_id  integer optional  
L'identifiant de la valeur du référentiel pays.

Supprimer

requires authentication

Supprime une commande

Example request:

curl -X DELETE \
    "https://api.oss.coop/commande/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/commande/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE commande/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la commande.

Réceptionner

requires authentication

Réceptionne une commande

Example request:

curl -X PATCH \
    "https://api.oss.coop/commande/2/receptionner" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/2/receptionner"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/commande/2/receptionner',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH commande/{uid:[0-9]+}/receptionner

URL Parameters

uid  integer  
L'identifiant de la commande.

Réceptionner partiellement

requires authentication

Réceptionne une commande

Example request:

curl -X PATCH \
    "https://api.oss.coop/commande/2/receptionner_partiellement" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/2/receptionner_partiellement"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/commande/2/receptionner_partiellement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH commande/{uid:[0-9]+}/receptionner_partiellement

URL Parameters

uid  integer  
L'identifiant de la commande.

Annuler

requires authentication

Annule une commande

Example request:

curl -X PATCH \
    "https://api.oss.coop/commande/2/annuler" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/2/annuler"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/commande/2/annuler',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH commande/{uid:[0-9]+}/annuler

URL Parameters

uid  integer  
L'identifiant de la commande.

Produit - Voir

requires authentication

Détails d'un produit d'une commande

Example request:

curl -X GET \
    -G "https://api.oss.coop/commande/1/produit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/1/produit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/commande/1/produit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "quantite": "10",
        "produit": { ... },
        "fournisseur": { ... },
        "unite": { ... }
    }
}

Request   

GET commande/{cuid:[0-9]+}/produit/{uid:[0-9]+}

URL Parameters

cuid  integer  
L'identifiant de la commande.

uid  integer  
L'identifiant du produit.

Produit - Ajouter

requires authentication

Ajoute des produits à une commande

Example request:

curl -X POST \
    "https://api.oss.coop/commande/1/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"quantite":"10","produit_id":1,"fournisseur_id":1,"unite_id":1}'

const url = new URL(
    "https://api.oss.coop/commande/1/produit"
);

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

let body = {
    "quantite": "10",
    "produit_id": 1,
    "fournisseur_id": 1,
    "unite_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/commande/1/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'quantite' => '10',
            'produit_id' => 1,
            'fournisseur_id' => 1,
            'unite_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "quantite": "10",
            "produit": { ... },
            "fournisseur": { ... },
            "unite": { ... }
        }
    ]
}

Request   

POST commande/{cuid:[0-9]+}/produit

URL Parameters

cuid  integer  
L'identifiant de la commande.

Body Parameters

quantite  numeric  
La quantité du produit à commander.

produit_id  integer  
L'identifiant du produit à commander.

fournisseur_id  integer  
L'identifiant du fournisseur du produit à commander.

unite_id  integer  
L'identifiant de l'unité de la quantité du produit à commander.

Produit - Modifier

requires authentication

Modifie les produits d'une commande

Example request:

curl -X PUT \
    "https://api.oss.coop/commande/1/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"quantite":"10.5","produit_id":1,"fournisseur_id":1,"unite_id":1}'

const url = new URL(
    "https://api.oss.coop/commande/1/produit"
);

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

let body = {
    "quantite": "10.5",
    "produit_id": 1,
    "fournisseur_id": 1,
    "unite_id": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/commande/1/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'quantite' => '10.5',
            'produit_id' => 1,
            'fournisseur_id' => 1,
            'unite_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "quantite": "10.5",
            "produit": { ... },
            "fournisseur": { ... },
            "unite": { ... }
        }
    ]
}

Request   

PUT commande/{cuid:[0-9]+}/produit

URL Parameters

cuid  integer  
L'identifiant de la commande.

Body Parameters

quantite  numeric  
La quantité du produit à commander.

produit_id  integer  
L'identifiant du produit à commander.

fournisseur_id  integer  
L'identifiant du fournisseur du produit à commander.

unite_id  integer  
L'identifiant de l'unité de la quantité du produit à commander.

Produit - Supprimer

requires authentication

Supprime les produits d'une commande

Example request:

curl -X DELETE \
    "https://api.oss.coop/commande/1/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/1/produit"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/commande/1/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE commande/{cuid:[0-9]+}/produit

URL Parameters

cuid  integer  
L'identifiant de la commande.

Produit - Fiche - Voir

requires authentication

Détails d'une fiche d'un produit d'une commande

Example request:

curl -X GET \
    -G "https://api.oss.coop/commande/1/produit/1/fiche/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/commande/1/produit/1/fiche/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/commande/1/produit/1/fiche/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "ferti": { ... },
        "phyto": { ... },
        "semis": { ... }
    }
}

Request   

GET commande/{cuid:[0-9]+}/produit/{puid:[0-9]+}/fiche/{uid:[0-9]+}

URL Parameters

cuid  integer  
L'identifiant de la commande.

puid  integer  
L'identifiant du produit.

uid  integer  
L'identifiant d'une fiche.

Produit - Fiche - Ajouter

requires authentication

Ajoute des fiches à un produit d'une commande

Example request:

curl -X POST \
    "https://api.oss.coop/commande/1/produit/1/fiche" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"ferti_id":1,"phyto_id":1,"semis_id":1}'

const url = new URL(
    "https://api.oss.coop/commande/1/produit/1/fiche"
);

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

let body = {
    "ferti_id": 1,
    "phyto_id": 1,
    "semis_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/commande/1/produit/1/fiche',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'ferti_id' => 1,
            'phyto_id' => 1,
            'semis_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "ferti": { ... },
        "phyto": { ... },
        "semis": { ... }
    }
}

Request   

POST commande/{cuid:[0-9]+}/produit/{puid:[0-9]+}/fiche

URL Parameters

cuid  integer  
L'identifiant de la commande.

puid  integer  
L'identifiant du produit.

Body Parameters

ferti_id  integer optional  
L'identifiant d'une fiche ferti.

phyto_id  integer optional  
L'identifiant d'une fiche phyto.

semis_id  integer optional  
L'identifiant d'une fiche semis.

Produit - Fiche - Modifier

requires authentication

Modifie les fiches d'un produit d'une commande

Example request:

curl -X PUT \
    "https://api.oss.coop/commande/1/produit/1/fiche/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"ferti_id":0,"phyto_id":0,"semis_id":0}'

const url = new URL(
    "https://api.oss.coop/commande/1/produit/1/fiche/2"
);

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

let body = {
    "ferti_id": 0,
    "phyto_id": 0,
    "semis_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/commande/1/produit/1/fiche/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'ferti_id' => 0,
            'phyto_id' => 0,
            'semis_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "ferti": null,
        "phyto": null,
        "semis": null
    }
}

Request   

PUT commande/{cuid:[0-9]+}/produit/{puid:[0-9]+}/fiche/{uid:[0-9]+}

URL Parameters

cuid  integer  
L'identifiant de la commande.

puid  integer  
L'identifiant du produit.

uid  integer  
L'identifiant des fiches.

Body Parameters

ferti_id  integer optional  
L'identifiant d'une fiche ferti.

phyto_id  integer optional  
L'identifiant d'une fiche phyto.

semis_id  integer optional  
L'identifiant d'une fiche semis.

Composants

Lister

requires authentication

Liste des composants

Example request:

curl -X GET \
    -G "https://api.oss.coop/composant?sort=nom.ASC%2Cid.DESC&page=17&limit=18" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/composant"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "17",
    "limit": "18",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/composant',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '17',
            'limit'=> '18',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "composant1",
            "nom": "composant",
            "observation": null,
            "produit_type": { ... },
            "thematique": { ... },
            "thematique_composant": { ... }
        }
    ]
}

Request   

GET composant

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un composant

Example request:

curl -X GET \
    -G "https://api.oss.coop/composant/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/composant/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/composant/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "composant1",
        "nom": "composant",
        "observation": null,
        "produit_type": { ... },
        "thematique": { ... },
        "thematique_composant": { ... }
    }
}

Request   

GET composant/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du composant.

Ajouter

requires authentication

Ajoute un composant

Example request:

curl -X POST \
    "https://api.oss.coop/composant" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"composant2","nom":"composant2","observation":"Un autre composant","produit_type_uid":"id_unique_universel","thematique_uid":"id_unique_universel","thematique_composant_id":1}'

const url = new URL(
    "https://api.oss.coop/composant"
);

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

let body = {
    "uid": "composant2",
    "nom": "composant2",
    "observation": "Un autre composant",
    "produit_type_uid": "id_unique_universel",
    "thematique_uid": "id_unique_universel",
    "thematique_composant_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/composant',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'composant2',
            'nom' => 'composant2',
            'observation' => 'Un autre composant',
            'produit_type_uid' => 'id_unique_universel',
            'thematique_uid' => 'id_unique_universel',
            'thematique_composant_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "composant2",
        "nom": "composant2",
        "observation": "Un autre composant",
        "produit_type": { ... },
        "thematique": { ... },
        "thematique_composant": { ... }
    }
}

Request   

POST composant

Body Parameters

uid  string  
L'identifiant unique composant.

nom  string  
Le nom du composant.

observation  string optional  
Le nom du composant.

produit_type_uid  string optional  
L'identifiant unique du type de produit concerné par le composant.

thematique_uid  string optional  
L'identifiant unique de la thématique du composant.

thematique_composant_id  integer optional  
L'identifiant de la valeur du référentiel de rosee.

Modifier

requires authentication

Modifie un composant

Example request:

curl -X PUT \
    "https://api.oss.coop/composant/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"composant3","nom":"composant3","observation":"null","produit_type_uid":"null","thematique_uid":"null","thematique_composant_id":0}'

const url = new URL(
    "https://api.oss.coop/composant/2"
);

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

let body = {
    "uid": "composant3",
    "nom": "composant3",
    "observation": "null",
    "produit_type_uid": "null",
    "thematique_uid": "null",
    "thematique_composant_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/composant/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'composant3',
            'nom' => 'composant3',
            'observation' => 'null',
            'produit_type_uid' => 'null',
            'thematique_uid' => 'null',
            'thematique_composant_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "composant3",
        "nom": "composant3",
        "observation": null,
        "produit_type": null,
        "thematique": null,
        "thematique_composant": null
    }
}

Request   

PUT composant/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du composant.

Body Parameters

uid  string  
L'identifiant unique composant.

nom  string  
Le nom du composant.

observation  string optional  
Le nom du composant.

produit_type_uid  string optional  
L'identifiant unique du type de produit concerné par le composant.

thematique_uid  string optional  
L'identifiant unique de la thématique du composant.

thematique_composant_id  integer optional  
L'identifiant de la valeur du référentiel de rosee.

Supprimer

requires authentication

Supprime un composant

Example request:

curl -X DELETE \
    "https://api.oss.coop/composant/10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/composant/10"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/composant/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE composant/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du composant.

Culture

Lister

requires authentication

Liste des cultures

Example request:

curl -X GET \
    -G "https://api.oss.coop/culture?sort=nom.ASC%2Cid.DESC&page=6&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/culture"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/culture',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "nom": "nom",
            "famille": {
                "id": 1,
                "uid": "id_unique_universel",
                "nom": "nom"
            }
        }
    ]
}

Request   

GET culture

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'une culture

Example request:

curl -X GET \
    -G "https://api.oss.coop/culture/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/culture/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/culture/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "nom": "nom",
        "famille": {
            "id": 1,
            "uid": "id_unique_universel",
            "nom": "nom"
        }
    }
}

Request   

GET culture/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la culture.

Ajouter

requires authentication

Ajoute une culture

Example request:

curl -X POST \
    "https://api.oss.coop/culture" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","nom":"nom2","famille_uid":"id_unique_universel"}'

const url = new URL(
    "https://api.oss.coop/culture"
);

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

let body = {
    "uid": "id_unique_universel2",
    "nom": "nom2",
    "famille_uid": "id_unique_universel"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/culture',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'nom' => 'nom2',
            'famille_uid' => 'id_unique_universel',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "nom": "nom2",
        "famille": {
            "id": 1,
            "uid": "id_unique_universel",
            "nom": "nom"
        }
    }
}

Request   

POST culture

Body Parameters

uid  string  
L'identifiant unique de la culture.

nom  string  
Le nom de la culture.

famille_uid  string  
L'identifiant unique de la famille de la culture.

Modifier

requires authentication

Modifie une culture

Example request:

curl -X PUT \
    "https://api.oss.coop/culture/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","nom":"nom3","famille_uid":"id_unique_universel2"}'

const url = new URL(
    "https://api.oss.coop/culture/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "nom": "nom3",
    "famille_uid": "id_unique_universel2"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/culture/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'nom' => 'nom3',
            'famille_uid' => 'id_unique_universel2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "nom": "nom3",
        "famille": {
            "id": 2,
            "uid": "id_unique_universel2",
            "nom": "nom2"
        }
    }
}

Request   

PUT culture/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la culture.

Body Parameters

uid  string  
L'identifiant unique de la culture.

nom  string  
Le nom de la culture.

famille_uid  string  
L'identifiant unique de la famille de la culture.

Supprimer

requires authentication

Supprime une culture

Example request:

curl -X DELETE \
    "https://api.oss.coop/culture/6" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/culture/6"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/culture/6',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE culture/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la culture.

Dictionnaires

Categorie Droit - Lister

requires authentication

Liste des catégories de droits

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/categorie/droit?sort=nom.ASC%2Cid.DESC&page=2&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/categorie/droit"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "2",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/categorie/droit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '2',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/categorie/droit

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Categorie Droit - Voir

requires authentication

Détails d'une catégorie de droits

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/categorie/droit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/categorie/droit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/categorie/droit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/categorie/droit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la catégorie de droits.

Categorie Fichier - Lister

requires authentication

Liste des catégories de fichiers

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/categorie/fichier?sort=nom.ASC%2Cid.DESC&page=19&limit=14" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/categorie/fichier"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "19",
    "limit": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/categorie/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '19',
            'limit'=> '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "nom",
            "enfants": null
        }
    ]
}

Request   

GET dictionnaire/categorie/fichier

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Categorie Fichier - Voir

requires authentication

Détails d'une catégorie de fichier

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/categorie/fichier/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/categorie/fichier/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/categorie/fichier/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "nom",
        "enfants": null
    }
}

Request   

GET dictionnaire/categorie/fichier/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la catégorie de fichier.

Categorie Fichier - Ajouter

requires authentication

Ajoute une catégorie de fichier

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/categorie/fichier" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"nom2","parent_id":1}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/categorie/fichier"
);

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

let body = {
    "nom": "nom2",
    "parent_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/categorie/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'nom2',
            'parent_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "nom2",
        "enfants": [ ... ]
    }
}

Request   

POST dictionnaire/categorie/fichier

Body Parameters

nom  string  
Le nom de la catégorie de fichier.

parent_id  integer optional  
L'identifiant du parent de la catégorie de fichier.

Categorie Fichier - Modifier

requires authentication

Modifie une catégorie de fichier

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/categorie/fichier/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"nom3","parent_id":1}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/categorie/fichier/2"
);

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

let body = {
    "nom": "nom3",
    "parent_id": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/categorie/fichier/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'nom3',
            'parent_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "nom3",
        "enfants": [ ... ]
    }
}

Request   

PUT dictionnaire/categorie/fichier/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la catégorie de fichier.

Body Parameters

nom  string  
Le nom de la catégorie de fichier.

parent_id  integer optional  
L'identifiant du parent de la catégorie de fichier.

Categorie Fichier - Supprimer

requires authentication

Supprime une catégorie de fichier

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/categorie/fichier/17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/categorie/fichier/17"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/categorie/fichier/17',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/categorie/fichier/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la catégorie de fichier.

Type Entite - Lister

requires authentication

Liste des types d'entités

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/entite?sort=nom.ASC%2Cid.DESC&page=6&limit=5" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/entite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/entite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/entite

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Entite - Voir

requires authentication

Détails d'un type d'entités

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/entite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/entite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/entite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/entite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type d'entité.

Type Log - Lister

requires authentication

Liste des types de logs

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/log?sort=nom.ASC%2Cid.DESC&page=3&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/log"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "3",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/log',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '3',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/log

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Log - Voir

requires authentication

Détails d'un type de logs

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/log/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/log/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/log/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/log/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de log.

Type Media - Lister

requires authentication

Liste des types de medias

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/media?sort=nom.ASC%2Cid.DESC&page=5&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/media"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/media',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/media

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Media - Voir

requires authentication

Détails d'un type de medias

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/media/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/media/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/media/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/media/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de media.

Type Produit - Lister

requires authentication

Liste des types de produits

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/produit?sort=nom.ASC%2Cid.DESC&page=11&limit=1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/produit"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "11",
    "limit": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '11',
            'limit'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/produit

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Produit - Voir

requires authentication

Détails d'un type de produits

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/produit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/produit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/produit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/produit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de produit.

Type Validation - Lister

requires authentication

Liste des types de validations

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/validation?sort=nom.ASC%2Cid.DESC&page=13&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/validation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/validation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/validation

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Validation - Voir

requires authentication

Détails d'un type de validations

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/validation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/validation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/validation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/validation/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de validation.

Type Protocole - Lister

requires authentication

Liste des types de protocoles

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/protocole?sort=nom.ASC%2Cid.DESC&page=11&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/protocole"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "11",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/protocole',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '11',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/protocole

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Protocole - Voir

requires authentication

Détails d'un type de protocoles

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/protocole/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/protocole/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/protocole/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/protocole/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de protocole.

Type Modalite - Lister

requires authentication

Liste des types de modalites

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/modalite?sort=nom.ASC%2Cid.DESC&page=4&limit=3" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/modalite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "4",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '4',
            'limit'=> '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/modalite

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Modalite - Voir

requires authentication

Détails d'un type de modalites

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/modalite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/modalite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/modalite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/modalite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de modalite.

Type Facteur - Lister

requires authentication

Liste des types de facteurs

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/facteur?sort=nom.ASC%2Cid.DESC&page=1&limit=2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/facteur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/facteur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/facteur

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Facteur - Voir

requires authentication

Détails d'un type de facteurs

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/facteur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/facteur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/facteur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/facteur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de facteur.

Type Facteur Variable - Lister

requires authentication

Liste des types de variables de facteur

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/facteur/variable?sort=nom.ASC%2Cid.DESC&page=7&limit=7" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/facteur/variable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/facteur/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '7',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/facteur/variable

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Facteur Variable - Voir

requires authentication

Détails d'un type de variables de facteur

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/facteur/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/facteur/variable/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/facteur/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/facteur/variable/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de variable de facteur.

Type Dispositif - Lister

requires authentication

Liste des types de dispositifs

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/dispositif?sort=nom.ASC%2Cid.DESC&page=3&limit=5" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/dispositif"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "3",
    "limit": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/dispositif',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '3',
            'limit'=> '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/dispositif

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Dispositif - Voir

requires authentication

Détails d'un type de dispositif

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/dispositif/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/dispositif/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/dispositif/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/dispositif/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de dispositif.

Type Evenement - Lister

requires authentication

Liste des types de évenements

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/evenement?sort=nom.ASC%2Cid.DESC&page=5&limit=14" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/evenement"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/evenement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/evenement

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Evenement - Voir

requires authentication

Détails d'un type d'évenement

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/evenement/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/evenement/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/evenement/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/evenement/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type d'évenement.

Type Microparcelle - Lister

requires authentication

Liste des types de microparcelles

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/microparcelle?sort=nom.ASC%2Cid.DESC&page=19&limit=7" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/microparcelle"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "19",
    "limit": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/microparcelle',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '19',
            'limit'=> '7',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/microparcelle

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Microparcelle - Voir

requires authentication

Détails d'un type de microparcelle

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/microparcelle/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/microparcelle/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/microparcelle/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/microparcelle/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de microparcelle.

Type Etiquette - Lister

requires authentication

Liste des types d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/etiquette?sort=nom.ASC%2Cid.DESC&page=3&limit=18" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/etiquette"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "3",
    "limit": "18",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/etiquette',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '3',
            'limit'=> '18',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/etiquette

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Etiquette - Voir

requires authentication

Détails d'un type d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/etiquette/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/etiquette/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/etiquette/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/etiquette/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type d'étiquette.

Type Etiquette Valeur - Lister

requires authentication

Liste des types de valeur d'étiquette

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/etiquette/valeur?sort=nom.ASC%2Cid.DESC&page=17&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "17",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/etiquette/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '17',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur",
            "attribut": null,
            "special": false,
            "format": { ... }
        }
    ]
}

Request   

GET dictionnaire/type/etiquette/valeur

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Statut Etiquette Valeur - Voir

requires authentication

Détails d'un type de valeur d'étiquette

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/etiquette/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/etiquette/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur",
        "attribut": null,
        "special": false,
        "format": { ... }
    }
}

Request   

GET dictionnaire/type/etiquette/valeur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de valeur d'étiquette.

Statut Etiquette Valeur - Ajouter

requires authentication

Ajoute un type de valeur d'étiquette

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","designation":"valeur2","attribut":"attribut","special":true,"format_uid":1,"types_etiquette":[{"uid":"typeetiq1"},{"uid":"typeetiq1"}]}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur"
);

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

let body = {
    "uid": "id_unique_universel2",
    "designation": "valeur2",
    "attribut": "attribut",
    "special": true,
    "format_uid": 1,
    "types_etiquette": [
        {
            "uid": "typeetiq1"
        },
        {
            "uid": "typeetiq1"
        }
    ]
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/type/etiquette/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'designation' => 'valeur2',
            'attribut' => 'attribut',
            'special' => true,
            'format_uid' => 1,
            'types_etiquette' => [
                [
                    'uid' => 'typeetiq1',
                ],
                [
                    'uid' => 'typeetiq1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "designation": "valeur2",
        "attribut": "attribut",
        "special": true,
        "format": { ... }
    }
}

Request   

POST dictionnaire/type/etiquette/valeur

Body Parameters

uid  string  
L'identifiant unique du type de valeur d'étiquette.

designation  string  
La designation du type de valeur d'étiquette.

attribut  string optional  
L'attribut du type de valeur d'étiquette.

special  boolean  
Le caractère spécial du type de valeur d'étiquette.

format_uid  integer optional  
L'identifiant unique du format de valeur d'étiquette lié.

types_etiquette  object[]  
Les types d'étiquette de valeur d'étiquette lié.

types_etiquette[].uid  string optional  
Un identifiant unique de type d'étiquette.

Statut Etiquette Valeur - Modifier

requires authentication

Modifie un type de valeur d'étiquette

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","designation":"valeur3","attribut":"null","special":false,"format_uid":0,"types_etiquette":[{"uid":"typeetiq1"},[]]}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "designation": "valeur3",
    "attribut": "null",
    "special": false,
    "format_uid": 0,
    "types_etiquette": [
        {
            "uid": "typeetiq1"
        },
        []
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/type/etiquette/valeur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'designation' => 'valeur3',
            'attribut' => 'null',
            'special' => false,
            'format_uid' => 0,
            'types_etiquette' => [
                [
                    'uid' => 'typeetiq1',
                ],
                [],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "designation": "valeur3",
        "attribut": null,
        "special": false,
        "format": null
    }
}

Request   

PUT dictionnaire/type/etiquette/valeur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de valeur d'étiquette.

Body Parameters

uid  string  
L'identifiant unique du type de valeur d'étiquette.

designation  string  
La designation du type de valeur d'étiquette.

attribut  string optional  
L'attribut du type de valeur d'étiquette.

special  boolean  
Le caractère spécial du type de valeur d'étiquette.

format_uid  integer optional  
L'identifiant unique du format de valeur d'étiquette lié.

types_etiquette  object[]  
Les types d'étiquette de valeur d'étiquette lié.

types_etiquette[].uid  string optional  
Un identifiant unique de type d'étiquette.

Statut Etiquette Valeur - Supprimer

requires authentication

Supprime un type de valeur d'étiquette

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/etiquette/valeur/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/type/etiquette/valeur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/type/etiquette/valeur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de valeur d'étiquette.

Type Variable - Lister

requires authentication

Liste des types de variables

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/variable?sort=nom.ASC%2Cid.DESC&page=10&limit=16" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/variable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "10",
    "limit": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '10',
            'limit'=> '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/type/variable

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Type Variable - Voir

requires authentication

Détails d'un type de variables

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/type/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/type/variable/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/type/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/type/variable/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du type de variable.

Droit - Lister

requires authentication

Liste des droits

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/droit?sort=nom.ASC%2Cid.DESC&page=14&limit=5" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/droit"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/droit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "categorie": {
                "id": 1,
                "uid": "id_unique_universel",
                "designation": "valeur"
            },
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/droit

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Droit - Voir

requires authentication

Détails d'un droit

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/droit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/droit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/droit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "categorie": {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        },
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/droit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du droit.

Parametrage - Lister

requires authentication

Liste des paramétrages

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/parametrage?sort=nom.ASC%2Cid.DESC&page=10&limit=18" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/parametrage"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "10",
    "limit": "18",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/parametrage',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '10',
            'limit'=> '18',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "precisions": "Petit text explicatif",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/parametrage

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Parametrage - Voir

requires authentication

Détails d'un paramétrage

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/parametrage/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/parametrage/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/parametrage/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "precisions": "Petit text explicatif",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/parametrage/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du paramétrage.

Famille Culture - Lister

requires authentication

Liste des familles de culture

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/famille/culture?sort=nom.ASC%2Cid.DESC&page=7&limit=2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/culture"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/famille/culture',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "nom": "nom"
        }
    ]
}

Request   

GET dictionnaire/famille/culture

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Famille Culture - Voir

requires authentication

Détails d'une famille de culture

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/famille/culture/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/culture/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/famille/culture/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "nom": "nom"
    }
}

Request   

GET dictionnaire/famille/culture/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la famille de culture.

Famille Culture - Ajouter

requires authentication

Ajoute une famille de culture

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/famille/culture" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","nom":"nom2"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/culture"
);

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

let body = {
    "uid": "id_unique_universel2",
    "nom": "nom2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/famille/culture',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'nom' => 'nom2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "nom": "nom2"
    }
}

Request   

POST dictionnaire/famille/culture

Body Parameters

uid  string  
L'identifiant unique de la famille de culture.

nom  string  
Le nom de la famille de culture.

Famille Culture - Modifier

requires authentication

Modifie une famille de culture

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/famille/culture/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","nom":"nom3"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/culture/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "nom": "nom3"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/famille/culture/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'nom' => 'nom3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "nom": "nom3"
    }
}

Request   

PUT dictionnaire/famille/culture/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la famille de culture.

Body Parameters

uid  string  
L'identifiant unique de la famille de culture.

nom  string  
Le nom de la famille de culture.

Famille Culture - Supprimer

requires authentication

Supprime une famille de culture

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/famille/culture/4" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/culture/4"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/famille/culture/4',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/famille/culture/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la famille de culture.

Famille Produit - Lister

requires authentication

Liste des familles de produit

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/famille/produit?sort=nom.ASC%2Cid.DESC&page=16&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/produit"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/famille/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "nom": "nom"
        }
    ]
}

Request   

GET dictionnaire/famille/produit

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Famille Produit - Voir

requires authentication

Détails d'une famille de produit

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/famille/produit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/produit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/famille/produit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "nom": "nom"
    }
}

Request   

GET dictionnaire/famille/produit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'unité.

Famille Produit - Ajouter

requires authentication

Ajoute une famille de produit

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/famille/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","nom":"nom2"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/produit"
);

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

let body = {
    "uid": "id_unique_universel2",
    "nom": "nom2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/famille/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'nom' => 'nom2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "nom": "nom2"
    }
}

Request   

POST dictionnaire/famille/produit

Body Parameters

uid  string  
L'identifiant unique de la famille de produit.

nom  string  
Le nom de la famille de produit.

Famille Produit - Modifier

requires authentication

Modifie une famille de produit

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/famille/produit/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","nom":"nom3"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/produit/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "nom": "nom3"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/famille/produit/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'nom' => 'nom3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "nom": "nom3"
    }
}

Request   

PUT dictionnaire/famille/produit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la famille de produit.

Body Parameters

uid  string  
L'identifiant unique de la famille de produit.

nom  string  
Le nom de la famille de produit.

Famille Produit - Supprimer

requires authentication

Supprime une famille de produit

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/famille/produit/15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/famille/produit/15"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/famille/produit/15',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/famille/produit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la famille de produit.

Référentiel - Lister

requires authentication

Liste des référentiels

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/referentiel?sort=nom.ASC%2Cid.DESC&page=2&limit=5" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/referentiel"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "2",
    "limit": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/referentiel',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '2',
            'limit'=> '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/referentiel

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Référentiel - Voir

requires authentication

Détails d'un référentiel

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/referentiel/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/referentiel/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/referentiel/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/referentiel/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du référentiel.

Thématique - Lister

requires authentication

Liste des thématiques

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/thematique?sort=nom.ASC%2Cid.DESC&page=19&limit=11" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/thematique"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "19",
    "limit": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/thematique',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '19',
            'limit'=> '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/thematique

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Thématique - Voir

requires authentication

Détails d'une thématique

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/thematique/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/thematique/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/thematique/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/thematique/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la thématique.

Statut Protocole - Lister

requires authentication

Liste des statuts de protocoles

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/protocole?sort=nom.ASC%2Cid.DESC&page=12&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/protocole"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "12",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/protocole',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '12',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/statut/protocole

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Statut Protocole - Voir

requires authentication

Détails d'un statut de protocoles

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/protocole/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/protocole/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/protocole/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/statut/protocole/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut de protocole.

Statut Produit non homologué - Lister

requires authentication

Liste des statuts de produits non homologués

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/produit_non_homologue?sort=nom.ASC%2Cid.DESC&page=14&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/produit_non_homologue',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "derogation_destruction_recolte": false,
            "permis_experimenter_ade": "valeur",
            "ref_expedition_produits_fabricant": "valeur",
            "protocole": { ... },
            "produit": { ... }
        }
    ]
}

Request   

GET dictionnaire/statut/produit_non_homologue

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Statut Produit non homologué - Voir

requires authentication

Détails d'un statut de produit non homologué

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/produit_non_homologue/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/produit_non_homologue/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "derogation_destruction_recolte": false,
        "permis_experimenter_ade": "valeur",
        "ref_expedition_produits_fabricant": "valeur",
        "protocole": { ... },
        "produit": { ... }
    }
}

Request   

GET dictionnaire/statut/produit_non_homologue/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut de produit non homologué.

Statut Produit non homologué - Ajouter

requires authentication

Ajoute un statut de produit non homologué

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"derogation_destruction_recolte":true,"permis_experimenter_ade":"valeur2","ref_expedition_produits_fabricant":"valeur2","protocole_id":1,"produit_id":1}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue"
);

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

let body = {
    "derogation_destruction_recolte": true,
    "permis_experimenter_ade": "valeur2",
    "ref_expedition_produits_fabricant": "valeur2",
    "protocole_id": 1,
    "produit_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/statut/produit_non_homologue',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'derogation_destruction_recolte' => true,
            'permis_experimenter_ade' => 'valeur2',
            'ref_expedition_produits_fabricant' => 'valeur2',
            'protocole_id' => 1,
            'produit_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "derogation_destruction_recolte": true,
        "permis_experimenter_ade": "valeur2",
        "ref_expedition_produits_fabricant": "valeur2",
        "protocole": { ... },
        "produit": { ... }
    }
}

Request   

POST dictionnaire/statut/produit_non_homologue

Body Parameters

derogation_destruction_recolte  boolean optional  
L'existance d'une dérogation pour la déstruction de la récolte.

permis_experimenter_ade  string optional  
Le permis d'expérimentation ADE.

ref_expedition_produits_fabricant  string optional  
La référence d'expédition.

protocole_id  integer  
L'identifiant du protocole lié.

produit_id  integer  
L'identifiant du produit lié.

Statut Produit non homologué - Modifier

requires authentication

Modifie un statut de produit non homologué

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"derogation_destruction_recolte":false,"permis_experimenter_ade":"blanditiis","ref_expedition_produits_fabricant":"eos","protocole_id":1,"produit_id":1}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue/2"
);

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

let body = {
    "derogation_destruction_recolte": false,
    "permis_experimenter_ade": "blanditiis",
    "ref_expedition_produits_fabricant": "eos",
    "protocole_id": 1,
    "produit_id": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/statut/produit_non_homologue/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'derogation_destruction_recolte' => false,
            'permis_experimenter_ade' => 'blanditiis',
            'ref_expedition_produits_fabricant' => 'eos',
            'protocole_id' => 1,
            'produit_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "derogation_destruction_recolte": null,
        "permis_experimenter_ade": null,
        "ref_expedition_produits_fabricant": null,
        "protocole": { ... },
        "produit": { ... }
    }
}

Request   

PUT dictionnaire/statut/produit_non_homologue/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut de produit non homologué.

Body Parameters

derogation_destruction_recolte  boolean optional  
L'existance d'une dérogation pour la déstruction de la récolte.

permis_experimenter_ade  string optional  
Le permis d'expérimentation ADE.

ref_expedition_produits_fabricant  string optional  
La référence d'expédition.

protocole_id  integer  
L'identifiant du protocole lié.

produit_id  integer  
L'identifiant du produit lié.

Statut Produit non homologué - Supprimer

requires authentication

Supprime un statut de produit non homologué

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue/20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/produit_non_homologue/20"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/statut/produit_non_homologue/20',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/statut/produit_non_homologue/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut de produit non homologué.

Statut Réservation - Lister

requires authentication

Liste des statuts de réservations

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/reservation?sort=nom.ASC%2Cid.DESC&page=1&limit=14" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/reservation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/reservation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/statut/reservation

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Statut Réservation - Voir

requires authentication

Détails d'un statut de réservationq

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/reservation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/reservation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/reservation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/statut/reservation/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut de réservation.

Statut Protocole Détaillé - Lister

requires authentication

Liste des statuts détaillés de protocoles

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/protocole_detaille?sort=nom.ASC%2Cid.DESC&page=7&limit=3" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/protocole_detaille"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/protocole_detaille',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/statut/protocole_detaille

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Statut Protocole Détaillé - Voir

requires authentication

Détails d'un statut détaillé de protocoles

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/protocole_detaille/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/protocole_detaille/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/protocole_detaille/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/statut/protocole_detaille/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut détaillé de protocole.

Statut Commande - Lister

requires authentication

Liste des statuts de commandes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/commande?sort=nom.ASC%2Cid.DESC&page=1&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/commande"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/commande',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/statut/commande

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Statut Commande - Voir

requires authentication

Détails d'un statut de commandes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/commande/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/commande/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/commande/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/statut/commande/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut de commande.

Statut Regroupement - Lister

requires authentication

Liste des statuts de regroupements

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/regroupement?sort=nom.ASC%2Cid.DESC&page=13&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/regroupement"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/regroupement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/statut/regroupement

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Statut Regroupement - Voir

requires authentication

Détails d'un statut de regroupement

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/statut/regroupement/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/statut/regroupement/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/statut/regroupement/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/statut/regroupement/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du statut de regroupement.

Format Variable - Lister

requires authentication

Liste des formats de variables

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/format/variable?sort=nom.ASC%2Cid.DESC&page=18&limit=8" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/format/variable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "18",
    "limit": "8",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/format/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '18',
            'limit'=> '8',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/format/variable

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Format Variable - Voir

requires authentication

Détails d'un format de variables

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/format/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/format/variable/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/format/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/format/variable/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du format de variable.

Format Etiquette Valeur - Lister

requires authentication

Liste des formats de valeurs d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/format/etiquette/valeur?sort=nom.ASC%2Cid.DESC&page=13&limit=4" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/format/etiquette/valeur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/format/etiquette/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/format/etiquette/valeur

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Format Etiquette Valeur - Voir

requires authentication

Détails d'un format de valeur d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/format/etiquette/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/format/etiquette/valeur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/format/etiquette/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/format/etiquette/valeur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du format de valeur d'étiquettes.

Dispositif Experimental - Lister

requires authentication

Liste des dispositifs experimentals

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/dispositif/experimental?sort=nom.ASC%2Cid.DESC&page=1&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/dispositif/experimental"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/dispositif/experimental',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/dispositif/experimental

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Dispositif Experimental - Voir

requires authentication

Détails d'un dispositif experimental

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/dispositif/experimental/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/dispositif/experimental/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/dispositif/experimental/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/dispositif/experimental/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du dispositif experimental.

Dispositif Experimental - Ajouter

requires authentication

Ajoute un dispositif experimental

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/dispositif/experimental" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","designation":"valeur2"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/dispositif/experimental"
);

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

let body = {
    "uid": "id_unique_universel2",
    "designation": "valeur2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/dispositif/experimental',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'designation' => 'valeur2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "designation": "valeur2"
    }
}

Request   

POST dictionnaire/dispositif/experimental

Body Parameters

uid  string  
L'identifiant unique du dispositif experimental.

designation  string  
La désignation du dispositif experimental.

Dispositif Experimental - Modifier

requires authentication

Modifie un dispositif experimental

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/dispositif/experimental/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","designation":"valeur3"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/dispositif/experimental/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "designation": "valeur3"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/dispositif/experimental/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'designation' => 'valeur3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "designation": "valeur3"
    }
}

Request   

PUT dictionnaire/dispositif/experimental/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du dispositif experimental.

Body Parameters

uid  string  
L'identifiant unique du dispositif experimental.

designation  string  
La désignation du dispositif experimental.

Dispositif Experimental - Supprimer

requires authentication

Supprime un dispositif experimental

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/dispositif/experimental/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/dispositif/experimental/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/dispositif/experimental/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/dispositif/experimental/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du dispositif experimental.

Stade - Lister

requires authentication

Liste des stades

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/stade?sort=nom.ASC%2Cid.DESC&page=4&limit=7" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/stade"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "4",
    "limit": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/stade',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '4',
            'limit'=> '7',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "stade1",
            "designation": "designation1",
            "designation_court": "d1",
            "code_bbch": "AZERTY123",
            "culture": { ... }
        }
    ]
}

Request   

GET dictionnaire/stade

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Stade - Voir

requires authentication

Détails d'un stade

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/stade/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/stade/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/stade/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "stade1",
        "designation": "designation1",
        "designation_court": "d1",
        "code_bbch": "AZERTY123",
        "culture": { ... }
    }
}

Request   

GET dictionnaire/stade/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du stade.

Stade - Ajouter

requires authentication

Ajoute un stade

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/stade" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"stade2","designation":"designation2","designation_court":"d2","code_bbch":"AZERTY123","culture_uid":"1"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/stade"
);

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

let body = {
    "uid": "stade2",
    "designation": "designation2",
    "designation_court": "d2",
    "code_bbch": "AZERTY123",
    "culture_uid": "1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/stade',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'stade2',
            'designation' => 'designation2',
            'designation_court' => 'd2',
            'code_bbch' => 'AZERTY123',
            'culture_uid' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "stade2",
        "designation": "designation2",
        "designation_court": "d2",
        "code_bbch": "AZERTY123",
        "culture": { ... }
    }
}

Request   

POST dictionnaire/stade

Body Parameters

uid  string  
L'identifiant unique du stade.

designation  string  
La désignation du stade.

designation_court  string optional  
La désignation courte du stade.

code_bbch  string optional  
Le code BBCH du stade.

culture_uid  string optional  
L'identifiant unique de culture du stade.

Stade - Modifier

requires authentication

Modifie un stade

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/stade/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"stade3","designation":"designation2","designation_court":"null","code_bbch":"null","culture_uid":"null"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/stade/2"
);

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

let body = {
    "uid": "stade3",
    "designation": "designation2",
    "designation_court": "null",
    "code_bbch": "null",
    "culture_uid": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/stade/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'stade3',
            'designation' => 'designation2',
            'designation_court' => 'null',
            'code_bbch' => 'null',
            'culture_uid' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "stade3",
        "designation": "designation2",
        "designation_court": null,
        "code_bbch": null,
        "culture": null
    }
}

Request   

PUT dictionnaire/stade/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du stade.

Body Parameters

uid  string  
L'identifiant unique du stade.

designation  string  
La désignation du stade.

designation_court  string optional  
La désignation courte du stade.

code_bbch  string optional  
Le code BBCH du stade.

culture_uid  string optional  
L'identifiant unique de culture du stade.

Stade - Supprimer

requires authentication

Supprime un stade

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/stade/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/stade/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/stade/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/stade/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du stade.

Etiquette - Gabarit - Lister

requires authentication

Liste des gabarits des étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/etiquette/gabarit?sort=nom.ASC%2Cid.DESC&page=14&limit=4" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "gabarit1",
            "designation": "valeur",
            "marge_haut": "0",
            "marge_bas": "0",
            "marge_droite": "0",
            "marge_gouche": "0",
            "page_largeur": "0",
            "page_hauteur": "0",
            "nb_etiquettes_x": "0",
            "nb_etiquettes_y": "0",
            "marge_etiquette_x": "0",
            "marge_etiquette_y": "0"
        }
    ]
}

Request   

GET dictionnaire/etiquette/gabarit

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Etiquette - Gabarit - Voir

requires authentication

Détails d'un gabarit d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/etiquette/gabarit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "gabarit1",
        "designation": "valeur",
        "marge_haut": "0",
        "marge_bas": "0",
        "marge_droite": "0",
        "marge_gouche": "0",
        "page_largeur": "0",
        "page_hauteur": "0",
        "nb_etiquettes_x": "0",
        "nb_etiquettes_y": "0",
        "marge_etiquette_x": "0",
        "marge_etiquette_y": "0"
    }
}

Request   

GET dictionnaire/etiquette/gabarit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du gabarit d'étiquettes.

Etiquette - Gabarit - Ajouter

requires authentication

Ajoute un gabarit d'étiquettes

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/etiquette/gabarit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"gabarit2","designation":"valeur2","nb_etiquettes_x":5,"nb_etiquettes_y":10,"marge_haut":"2.1","marge_bas":"2.1","marge_droite":"2.1","marge_gauche":"2.1","page_largeur":"27","page_hauteur":"40","marge_etiquette_x":"2","marge_etiquette_y":"3"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit"
);

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

let body = {
    "uid": "gabarit2",
    "designation": "valeur2",
    "nb_etiquettes_x": 5,
    "nb_etiquettes_y": 10,
    "marge_haut": "2.1",
    "marge_bas": "2.1",
    "marge_droite": "2.1",
    "marge_gauche": "2.1",
    "page_largeur": "27",
    "page_hauteur": "40",
    "marge_etiquette_x": "2",
    "marge_etiquette_y": "3"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'gabarit2',
            'designation' => 'valeur2',
            'nb_etiquettes_x' => 5,
            'nb_etiquettes_y' => 10,
            'marge_haut' => '2.1',
            'marge_bas' => '2.1',
            'marge_droite' => '2.1',
            'marge_gauche' => '2.1',
            'page_largeur' => '27',
            'page_hauteur' => '40',
            'marge_etiquette_x' => '2',
            'marge_etiquette_y' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "gabarit2",
        "designation": "valeur2",
        "marge_haut": "2.1",
        "marge_bas": "2.1",
        "marge_droite": "1.5",
        "marge_gouche": "1.5",
        "page_largeur": "27",
        "page_hauteur": "40",
        "nb_etiquettes_x": "5",
        "nb_etiquettes_y": "10",
        "marge_etiquette_x": "2",
        "marge_etiquette_y": "3"
    }
}

Request   

POST dictionnaire/etiquette/gabarit

Body Parameters

uid  string  
L'identifiant unique de gabarit d'étiquette.

designation  string  
La désignation du gabarit d'étiquette.

nb_etiquettes_x  integer  
Le nombre d'étiquettes en y de la page du gabarit d'étiquette.

nb_etiquettes_y  integer  
La nombre d'étiquettes en y de la page du gabarit d'étiquette.

marge_haut  numeric  
La marge haute du gabarit d'étiquette.

marge_bas  numeric  
La marge basse du gabarit d'étiquette.

marge_droite  numeric  
La marge droite du gabarit d'étiquette.

marge_gauche  numeric  
La marge gauche du gabarit d'étiquette.

page_largeur  numeric  
La largeur de la page du gabarit d'étiquette.

page_hauteur  numeric  
La hauteur de la page du gabarit d'étiquette.

marge_etiquette_x  numeric  
La marge x de la page du gabarit d'étiquette.

marge_etiquette_y  numeric  
La marge y de la page du gabarit d'étiquette.

Etiquette - Gabarit - Modifier

requires authentication

Modifie un gabarit d'étiquettes

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"gabarit2","designation":"valeur2","nb_etiquettes_x":0,"nb_etiquettes_y":0,"marge_haut":"0","marge_bas":"0","marge_droite":"0","marge_gauche":"0","page_largeur":"0","page_hauteur":"0","marge_etiquette_x":"0","marge_etiquette_y":"0"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/2"
);

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

let body = {
    "uid": "gabarit2",
    "designation": "valeur2",
    "nb_etiquettes_x": 0,
    "nb_etiquettes_y": 0,
    "marge_haut": "0",
    "marge_bas": "0",
    "marge_droite": "0",
    "marge_gauche": "0",
    "page_largeur": "0",
    "page_hauteur": "0",
    "marge_etiquette_x": "0",
    "marge_etiquette_y": "0"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'gabarit2',
            'designation' => 'valeur2',
            'nb_etiquettes_x' => 0,
            'nb_etiquettes_y' => 0,
            'marge_haut' => '0',
            'marge_bas' => '0',
            'marge_droite' => '0',
            'marge_gauche' => '0',
            'page_largeur' => '0',
            'page_hauteur' => '0',
            'marge_etiquette_x' => '0',
            'marge_etiquette_y' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "gabarit2",
        "designation": "valeur2",
        "marge_haut": "0",
        "marge_bas": "0",
        "marge_droite": "0",
        "marge_gouche": "0",
        "page_largeur": "0",
        "page_hauteur": "0",
        "nb_etiquettes_x": "0",
        "nb_etiquettes_y": "0",
        "marge_etiquette_x": "0",
        "marge_etiquette_y": "0"
    }
}

Request   

PUT dictionnaire/etiquette/gabarit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du gabarit d'étiquettes.

Body Parameters

uid  string  
L'identifiant unique de gabarit d'étiquette.

designation  string  
La désignation du gabarit d'étiquette.

nb_etiquettes_x  integer  
Le nombre d'étiquettes en y de la page du gabarit d'étiquette.

nb_etiquettes_y  integer  
La nombre d'étiquettes en y de la page du gabarit d'étiquette.

marge_haut  numeric  
La marge haute du gabarit d'étiquette.

marge_bas  numeric  
La marge basse du gabarit d'étiquette.

marge_droite  numeric  
La marge droite du gabarit d'étiquette.

marge_gauche  numeric  
La marge gauche du gabarit d'étiquette.

page_largeur  numeric  
La largeur de la page du gabarit d'étiquette.

page_hauteur  numeric  
La hauteur de la page du gabarit d'étiquette.

marge_etiquette_x  numeric  
La marge x de la page du gabarit d'étiquette.

marge_etiquette_y  numeric  
La marge y de la page du gabarit d'étiquette.

Etiquette - Gabarit - Supprimer

requires authentication

Supprime un gabarit d'étiquettes

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/17"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/17',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/etiquette/gabarit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du gabarit d'étiquettes.

Etiquette - Gabarit - Zone - Lister

requires authentication

Liste des zones d'un gabarit d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone?sort=nom.ASC%2Cid.DESC&page=6&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "x": "0",
            "y": "0",
            "largeur": "5",
            "hauteur": "4.2"
        }
    ]
}

Request   

GET dictionnaire/etiquette/gabarit/{guid:[0-9]+}/zone

URL Parameters

guid  integer  
L'identifiant du gabarit d'étiquettes.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Etiquette - Gabarit - Zone - Voir

requires authentication

Détails d'une zone d'un gabarit d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "x": "0",
        "y": "0",
        "largeur": "5",
        "hauteur": "4.2"
    }
}

Request   

GET dictionnaire/etiquette/gabarit/{guid:[0-9]+}/zone/{uid:[0-9]+}

URL Parameters

guid  integer  
L'identifiant du gabarit d'étiquettes.

uid  integer  
L'identifiant de la zone du gabarit d'étiquette.

Etiquette - Gabarit - Zone - Ajouter

requires authentication

Ajoute une zone d'un gabarit d'étiquettes

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"x":"5","y":"0","largeur":"10","hauteur":"8.4"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone"
);

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

let body = {
    "x": "5",
    "y": "0",
    "largeur": "10",
    "hauteur": "8.4"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'x' => '5',
            'y' => '0',
            'largeur' => '10',
            'hauteur' => '8.4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "x": "5",
        "y": "0",
        "largeur": "10",
        "hauteur": "8.4"
    }
}

Request   

POST dictionnaire/etiquette/gabarit/{guid:[0-9]+}/zone

URL Parameters

guid  integer  
L'identifiant du gabarit d'étiquettes.

Body Parameters

x  numeric  
La marge haute du gabarit d'étiquette.

y  numeric  
La marge basse du gabarit d'étiquette.

largeur  numeric  
La largeur de la page du gabarit d'étiquette.

hauteur  numeric  
La hauteur de la page du gabarit d'étiquette.

Etiquette - Gabarit - Zone - Modifier

requires authentication

Modifie une zone d'un gabarit d'étiquettes

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"x":"0","y":"4.2","largeur":"5","hauteur":"4.2"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/2"
);

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

let body = {
    "x": "0",
    "y": "4.2",
    "largeur": "5",
    "hauteur": "4.2"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'x' => '0',
            'y' => '4.2',
            'largeur' => '5',
            'hauteur' => '4.2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "x": "0",
        "y": "4.2",
        "largeur": "5",
        "hauteur": "4.2"
    }
}

Request   

PUT dictionnaire/etiquette/gabarit/{guid:[0-9]+}/zone/{uid:[0-9]+}

URL Parameters

guid  integer  
L'identifiant du gabarit d'étiquettes.

uid  integer  
L'identifiant de la zone du gabarit d'étiquette.

Body Parameters

x  numeric  
La marge haute du gabarit d'étiquette.

y  numeric  
La marge basse du gabarit d'étiquette.

largeur  numeric  
La largeur de la page du gabarit d'étiquette.

hauteur  numeric  
La hauteur de la page du gabarit d'étiquette.

Etiquette - Gabarit - Zone - Supprimer

requires authentication

Supprime une zone d'un gabarit d'étiquettes

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/etiquette/gabarit/1/zone/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/etiquette/gabarit/{guid:[0-9]+}/zone/{uid:[0-9]+}

URL Parameters

guid  integer  
L'identifiant du gabarit d'étiquettes.

uid  integer  
L'identifiant de la zone du gabarit d'étiquette.

Bordure - Lister

requires authentication

Liste des bordures

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/bordure?sort=nom.ASC%2Cid.DESC&page=12&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/bordure"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "12",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/bordure',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '12',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/bordure

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Bordure - Voir

requires authentication

Détails d'un bordure

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/bordure/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/bordure/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/bordure/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/bordure/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la bordure.

Marge - Lister

requires authentication

Liste des marges

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/marge?sort=nom.ASC%2Cid.DESC&page=13&limit=19" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/marge"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/marge',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/marge

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Marge - Voir

requires authentication

Détails d'un marge

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/marge/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/marge/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/marge/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/marge/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la marge.

Implantation de temoins - Lister

requires authentication

Liste des implantations de temoins

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/implantation_temoins?sort=nom.ASC%2Cid.DESC&page=12&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/implantation_temoins"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "12",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/implantation_temoins',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '12',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/implantation_temoins

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Implantation de temoins - Voir

requires authentication

Détails d'une implantation de temoins

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/implantation_temoins/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/implantation_temoins/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/implantation_temoins/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/implantation_temoins/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'implantation de temoins.

Randomisation - Lister

requires authentication

Liste des randomisations

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/randomisation?sort=nom.ASC%2Cid.DESC&page=12&limit=6" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/randomisation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "12",
    "limit": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/randomisation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '12',
            'limit'=> '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/randomisation

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Randomisation - Voir

requires authentication

Détails d'une randomisation

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/randomisation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/randomisation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/randomisation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/randomisation/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la randomisation.

Orientation générale - Lister

requires authentication

Liste des orientations générales

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/orientation_generale?sort=nom.ASC%2Cid.DESC&page=18&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/orientation_generale"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "18",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/orientation_generale',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '18',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/orientation_generale

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Orientation générale - Voir

requires authentication

Détails d'une orientation générale

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/orientation_generale/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/orientation_generale/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/orientation_generale/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/orientation_generale/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'orientation générale.

Point de départ - Lister

requires authentication

Liste des points de départ

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/point_depart?sort=nom.ASC%2Cid.DESC&page=12&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/point_depart"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "12",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/point_depart',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '12',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/point_depart

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Point de départ - Voir

requires authentication

Détails d'un point de départ

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/point_depart/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/point_depart/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/point_depart/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/point_depart/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du point de départ.

Coin de départ - Lister

requires authentication

Liste des coins coins de départ

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/coin_depart?sort=nom.ASC%2Cid.DESC&page=15&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/coin_depart"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "15",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/coin_depart',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '15',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "donald"
        }
    ]
}

Request   

GET dictionnaire/coin_depart

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Coin de départ - Voir

requires authentication

Détails d'un coin coin de départ

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/coin_depart/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/coin_depart/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/coin_depart/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "donald"
    }
}

Request   

GET dictionnaire/coin_depart/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du coin coin de départ.

Variable Calculée - Lister

requires authentication

Liste des variables calculées

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/variable_calculee?sort=nom.ASC%2Cid.DESC&page=9&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "designation1",
            "liecible": "prout"
        }
    ]
}

Request   

GET dictionnaire/variable_calculee

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Variable Calculée - Voir

requires authentication

Détails d'une variable calculée

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/variable_calculee/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/variable_calculee/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "designation1",
        "liecible": "prout"
    }
}

Request   

GET dictionnaire/variable_calculee/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la variable calculée.

Variable Calculée - Ajouter

requires authentication

Ajoute une variable calculée

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","designation":"designation2","liecible":"liecible2"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee"
);

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

let body = {
    "uid": "id_unique_universel2",
    "designation": "designation2",
    "liecible": "liecible2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'designation' => 'designation2',
            'liecible' => 'liecible2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "designation": "designation2",
        "liecible": "liecible2"
    }
}

Request   

POST dictionnaire/variable_calculee

Body Parameters

uid  string  
L'identifiant unique de la variable calculée.

designation  string  
La désignation de la variable calculée.

liecible  string optional  
La cible liée de la variable calculée.

Variable Calculée - Modifier

requires authentication

Modifie une variable calculée

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/variable_calculee/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","designation":"designation3","liecible":"null"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "designation": "designation3",
    "liecible": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/variable_calculee/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'designation' => 'designation3',
            'liecible' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "designation": "designation3",
        "liecible": null
    }
}

Request   

PUT dictionnaire/variable_calculee/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la variable calculée.

Body Parameters

uid  string  
L'identifiant unique de la variable calculée.

designation  string  
La désignation de la variable calculée.

liecible  string optional  
La cible liée de la variable calculée.

Variable Calculée - Supprimer

requires authentication

Supprime une variable calculée

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/variable_calculee/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/variable_calculee/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/variable_calculee/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la variable calculée.

Variable Calculée - Paramètre - Lister

requires authentication

Liste des paramètres d'une variable calculée

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre?sort=nom.ASC%2Cid.DESC&page=7&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/variable_calculee/1/parametre',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "variable": "variable",
            "designation": "designation1",
            "nomenclature": "prout"
        }
    ]
}

Request   

GET dictionnaire/variable_calculee/{vcuid:[0-9]+}/parametre

URL Parameters

vcuid  integer  
L'identifiant de la variable calculée.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Variable Calculée - Paramètre - Voir

requires authentication

Détails d'un paramètre d'une variable calculée

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "variable": "variable",
        "designation": "designation1",
        "nomenclature": "prout"
    }
}

Request   

GET dictionnaire/variable_calculee/{vcuid:[0-9]+}/parametre/{uid:[0-9]+}

URL Parameters

vcuid  integer  
L'identifiant de la variable calculée.

uid  integer  
L'identifiant du paramètre.

Variable Calculée - Paramètre - Ajouter

requires authentication

Ajoute un paramètre d'une variable calculée

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variable":"variable2","designation":"designation2","nomenclature":"nomenclature2"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre"
);

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

let body = {
    "variable": "variable2",
    "designation": "designation2",
    "nomenclature": "nomenclature2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/variable_calculee/1/parametre',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variable' => 'variable2',
            'designation' => 'designation2',
            'nomenclature' => 'nomenclature2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "variable": "variable2",
        "designation": "designation2",
        "nomenclature": "nomenclature2"
    }
}

Request   

POST dictionnaire/variable_calculee/{vcuid:[0-9]+}/parametre

URL Parameters

vcuid  integer  
L'identifiant de la variable calculée.

Body Parameters

variable  string  
La variable du paramètre.

designation  string  
La désignation du paramètre.

nomenclature  string optional  
La nomenclature du paramètre.

Variable Calculée - Paramètre - Modifier

requires authentication

Modifie un paramètre d'une variable calculée

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variable":"variable3","designation":"designation3","nomenclature":"null"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/2"
);

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

let body = {
    "variable": "variable3",
    "designation": "designation3",
    "nomenclature": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variable' => 'variable3',
            'designation' => 'designation3',
            'nomenclature' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "variable": "variable3",
        "designation": "designation3",
        "nomenclature": null
    }
}

Request   

PUT dictionnaire/variable_calculee/{vcuid:[0-9]+}/parametre/{uid:[0-9]+}

URL Parameters

vcuid  integer  
L'identifiant de la variable calculée.

uid  integer  
L'identifiant du paramètre.

Body Parameters

variable  string  
La variable du paramètre.

designation  string  
La désignation du paramètre.

nomenclature  string optional  
La nomenclature du paramètre.

Variable Calculée - Paramètre - Supprimer

requires authentication

Supprime un paramètre d'une variable calculée

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/variable_calculee/1/parametre/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/variable_calculee/{vcuid:[0-9]+}/parametre/{uid:[0-9]+}

URL Parameters

vcuid  integer  
L'identifiant de la variable calculée.

uid  integer  
L'identifiant du paramètre.

Saisie Ordre - Lister

requires authentication

Liste des ordres de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/ordre?sort=nom.ASC%2Cid.DESC&page=5&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/ordre"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/ordre',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/saisie/ordre

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Saisie Ordre - Voir

requires authentication

Détails d'un ordre de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/ordre/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/ordre/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/ordre/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/saisie/ordre/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'ordre de saisie.

Saisie Ordre global - Lister

requires authentication

Liste des ordres globaux de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/ordre_global?sort=nom.ASC%2Cid.DESC&page=13&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/ordre_global"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/ordre_global',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/saisie/ordre_global

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Saisie Ordre global - Voir

requires authentication

Détails d'un ordre global de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/ordre_global/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/ordre_global/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/ordre_global/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/saisie/ordre_global/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'ordre global de saisie.

Saisie Objet - Lister

requires authentication

Liste des objets de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/objet?sort=nom.ASC%2Cid.DESC&page=15&limit=7" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/objet"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "15",
    "limit": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/objet',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '15',
            'limit'=> '7',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/saisie/objet

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Saisie Objet - Voir

requires authentication

Détails d'un objet de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/objet/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/objet/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/objet/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/saisie/objet/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'objet de saisie.

Saisie Niveau - Lister

requires authentication

Liste des niveaux de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/niveau?sort=nom.ASC%2Cid.DESC&page=7&limit=16" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/niveau"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/niveau',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/saisie/niveau

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Saisie Niveau - Voir

requires authentication

Détails d'un niveau de saisie

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/saisie/niveau/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/saisie/niveau/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/saisie/niveau/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/saisie/niveau/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du niveau de saisie.

Thème - Lister

requires authentication

Liste des thèmes

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/theme?sort=nom.ASC%2Cid.DESC&page=5&limit=9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/theme"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/theme',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET dictionnaire/theme

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Thème - Voir

requires authentication

Détails d'un thème

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/theme/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/theme/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/theme/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET dictionnaire/theme/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du thème.

Référentiel - Valeur - Lister

requires authentication

Liste des valeurs d'un référentiel

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/referentiel/1/valeur?sort=nom.ASC%2Cid.DESC&page=13&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/referentiel/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "v1",
            "valeur": "Azertyuiop"
        }
    ]
}

Request   

GET dictionnaire/referentiel/{ruid:[0-9]+}/valeur

URL Parameters

ruid  integer  
L'identifiant du référentiel.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Référentiel - Valeur - Voir

requires authentication

Détails d'une valeur d'un référentiel

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/referentiel/1/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/referentiel/1/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "v1",
        "valeur": "Azertyuiop"
    }
}

Request   

GET dictionnaire/referentiel/{ruid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

ruid  integer  
L'identifiant du référentiel.

uid  integer  
L'identifiant de la valeur.

Référentiel - Valeur - Ajouter

requires authentication

Ajoute une valeur à un référentiel

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"v2","valeur":"Poiuytreza"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur"
);

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

let body = {
    "uid": "v2",
    "valeur": "Poiuytreza"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/referentiel/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'v2',
            'valeur' => 'Poiuytreza',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (201):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "v2",
        "valeur": "Poiuytreza"
    }
}

Request   

POST dictionnaire/referentiel/{ruid:[0-9]+}/valeur

URL Parameters

ruid  integer  
L'identifiant du référentiel.

Body Parameters

uid  string  
L'identifiant unique du référentiel.

valeur  string  
La valeur du référentiel.

Référentiel - Valeur - Modifier

requires authentication

Modifie une valeur d'un référentiel

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"v3","valeur":"Nouvelle valeur"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur/2"
);

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

let body = {
    "uid": "v3",
    "valeur": "Nouvelle valeur"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/referentiel/1/valeur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'v3',
            'valeur' => 'Nouvelle valeur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "v3",
        "valeur": "Nouvelle valeur"
    }
}

Request   

PUT dictionnaire/referentiel/{ruid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

ruid  integer  
L'identifiant du référentiel.

uid  integer  
L'identifiant de la valeur.

Body Parameters

uid  string  
L'identifiant unique du référentiel.

valeur  string  
La valeur du référentiel.

Référentiel - Valeur - Supprimer

requires authentication

Supprime une valeur d'un référentiel

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur/17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/referentiel/1/valeur/17"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/referentiel/1/valeur/17',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/referentiel/{ruid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

ruid  integer  
L'identifiant du référentiel.

uid  integer  
L'identifiant de la valeur.

Thématique - Sous-Thématique - Lister

requires authentication

Liste des sous-thématique d'une thématique

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique?sort=nom.ASC%2Cid.DESC&page=13&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/thematique/1/sous-thematique',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel1",
            "nom": "Azertyuiop"
        }
    ]
}

Request   

GET dictionnaire/thematique/{tuid:[0-9]+}/sous-thematique

URL Parameters

tuid  integer  
L'identifiant de la thématique.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Thématique - Sous-Thématique - Voir

requires authentication

Détails d'une sous-thématique d'une thématique

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel1",
        "nom": "Azertyuiop"
    }
}

Request   

GET dictionnaire/thematique/{tuid:[0-9]+}/sous-thematique/{uid:[0-9]+}

URL Parameters

tuid  integer  
L'identifiant de la thématique.

uid  integer  
L'identifiant de la sous-thématique.

Thématique - Sous-Thématique - Ajouter

requires authentication

Ajoute une sous-thématique à une thématique

Example request:

curl -X POST \
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","nom":"valeur2"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique"
);

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

let body = {
    "uid": "id_unique_universel2",
    "nom": "valeur2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/dictionnaire/thematique/1/sous-thematique',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'nom' => 'valeur2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (201):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "designation": "valeur2"
    }
}

Request   

POST dictionnaire/thematique/{tuid:[0-9]+}/sous-thematique

URL Parameters

tuid  integer  
L'identifiant de la thématique.

Body Parameters

uid  string  
L'identifiant unique de la sous-thématique.

nom  string  
Le nom de la sous-thématique.

Thématique - Sous-Thématique - Modifier

requires authentication

Modifie une sous-thématique d'une thématique

Example request:

curl -X PUT \
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","designation":"valeur3"}'

const url = new URL(
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "designation": "valeur3"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'designation' => 'valeur3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "designation": "valeur3"
    }
}

Request   

PUT dictionnaire/thematique/{tuid:[0-9]+}/sous-thematique/{uid:[0-9]+}

URL Parameters

tuid  integer  
L'identifiant de la thématique.

uid  integer  
L'identifiant de la sous-thématique.

Body Parameters

uid  string  
L'identifiant unique de la sous-thématique.

designation  string  
La designation de la sous-thématique.

Thématique - Sous-Thématique - Supprimer

requires authentication

Supprime une sous-thématique d'une thématique

Example request:

curl -X DELETE \
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/20"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/dictionnaire/thematique/1/sous-thematique/20',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE dictionnaire/thematique/{tuid:[0-9]+}/sous-thematique/{uid:[0-9]+}

URL Parameters

tuid  integer  
L'identifiant de la thématique.

uid  integer  
L'identifiant de la sous-thématique.

Sous-Thématique - Lister

requires authentication

Liste des sous-thématique

Example request:

curl -X GET \
    -G "https://api.oss.coop/dictionnaire/sous-thematique?sort=nom.ASC%2Cid.DESC&page=10&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/dictionnaire/sous-thematique"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "10",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/dictionnaire/sous-thematique',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '10',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel1",
            "nom": "Azertyuiop"
        }
    ]
}

Request   

GET dictionnaire/sous-thematique

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Endpoints

{all:.*}

requires authentication

Example request:

curl -X OPTIONS \
    "https://api.oss.coop/{all:.*}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/{all:.*}"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "OPTIONS",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->options(
    'https://api.oss.coop/{all:.*}',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

OPTIONS {all:.*}

notations/{notation_id:[0-9]+}/donnees

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/notations/{notation_id:[0-9]+}/donnees" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/notations/{notation_id:[0-9]+}/donnees"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/notations/{notation_id:[0-9]+}/donnees',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET notations/{notation_id:[0-9]+}/donnees

notations/{notation_id:[0-9]+}/variables-etudiees/{ve_id:[0-9]+}/donnees

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/notations/{notation_id:[0-9]+}/variables-etudiees/{ve_id:[0-9]+}/donnees" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/notations/{notation_id:[0-9]+}/variables-etudiees/{ve_id:[0-9]+}/donnees"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/notations/{notation_id:[0-9]+}/variables-etudiees/{ve_id:[0-9]+}/donnees',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET notations/{notation_id:[0-9]+}/variables-etudiees/{ve_id:[0-9]+}/donnees

notations/{notation_id:[0-9]+}/variables-calculees/{vc_id:[0-9]+}/resultat

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/notations/{notation_id:[0-9]+}/variables-calculees/{vc_id:[0-9]+}/resultat" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/notations/{notation_id:[0-9]+}/variables-calculees/{vc_id:[0-9]+}/resultat"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/notations/{notation_id:[0-9]+}/variables-calculees/{vc_id:[0-9]+}/resultat',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET notations/{notation_id:[0-9]+}/variables-calculees/{vc_id:[0-9]+}/resultat

test/ping

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/test/ping" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/test/ping"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/test/ping',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET test/ping

test/notations

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/test/notations" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/test/notations"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/test/notations',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET test/notations

debug/notation/{notation_id:[0-9]+}

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/debug/notation/{notation_id:[0-9]+}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/debug/notation/{notation_id:[0-9]+}"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/debug/notation/{notation_id:[0-9]+}',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET debug/notation/{notation_id:[0-9]+}

Entités

Lister

requires authentication

Liste des entités

Example request:

curl -X GET \
    -G "https://api.oss.coop/entite?sort=nom.ASC%2Cid.DESC&page=10&limit=16" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/entite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "10",
    "limit": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/entite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '10',
            'limit'=> '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "type": { ... },
            "pays": { ... },
            "parent": null,
            "nom": "Pays de Candy",
            "adresse": "2 Rue Docteur Slump",
            "cp": "69666",
            "ville": "D City",
            "actif": true,
            "description": "Blablabla",
            "logo_prim": { ... },
            "logo_sec": { ... },
            "logo_ter": { ... }
        }
    ]
}

Request   

GET entite

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'une entité

Example request:

curl -X GET \
    -G "https://api.oss.coop/entite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/entite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/entite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "type": { ... },
        "pays": { ... },
        "parent": null,
        "nom": "Pays de Candy",
        "description": "Blablabla",
        "adresse": "2 Rue Docteur Slump",
        "cp": "69666",
        "ville": "D City",
        "actif": true,
        "logo_prim": { ... },
        "logo_sec": { ... },
        "logo_ter": { ... }
    }
}

Request   

GET entite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'entité.

Ajouter

requires authentication

Ajoute une entité

Example request:

curl -X POST \
    "https://api.oss.coop/entite" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"type_uid":"id_unique_universel","parent_id":1,"pays_id":1,"nom":"Diatem","description":"null","adresse":"null","cp":"null","ville":"null","actif":true,"logo_prim_id":19,"logo_sec_id":15,"logo_ter_id":6}'

const url = new URL(
    "https://api.oss.coop/entite"
);

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

let body = {
    "type_uid": "id_unique_universel",
    "parent_id": 1,
    "pays_id": 1,
    "nom": "Diatem",
    "description": "null",
    "adresse": "null",
    "cp": "null",
    "ville": "null",
    "actif": true,
    "logo_prim_id": 19,
    "logo_sec_id": 15,
    "logo_ter_id": 6
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/entite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'type_uid' => 'id_unique_universel',
            'parent_id' => 1,
            'pays_id' => 1,
            'nom' => 'Diatem',
            'description' => 'null',
            'adresse' => 'null',
            'cp' => 'null',
            'ville' => 'null',
            'actif' => true,
            'logo_prim_id' => 19,
            'logo_sec_id' => 15,
            'logo_ter_id' => 6,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "type": { ... },
        "pays": { ... },
        "parent": { ... },
        "nom": "Diatem",
        "description": null,
        "adresse": null,
        "cp": null,
        "ville": null,
        "actif": true,
        "logo_prim": null,
        "logo_sec": null,
        "logo_ter": null
    }
}

Request   

POST entite

Body Parameters

type_uid  string  
L'identifiant unique du type d'entité.

parent_id  integer optional  
L'identifiant de l'entité parente de l'entité.

pays_id  integer optional  
L'identifiant d'une valeur du référentiel pays.

nom  string  
Le nom de l'entité.

description  string optional  
Le descriptif de l'entité.

adresse  string optional  
L'adresse (numéro, voie) de l'entité.

cp  string optional  
Le code postal de l'entité.

ville  string optional  
La ville de l'entité.

actif  boolean optional  
Si l'entité est active.

logo_prim_id  integer optional  
L'identifiant unique du média associé à l'entité. Défaut à null

logo_sec_id  integer optional  
L'identifiant unique du média associé à l'entité. Défaut à null

logo_ter_id  integer optional  
L'identifiant unique du média associé à l'entité. Défaut à null

Modifier

requires authentication

Modifie une entité

Example request:

curl -X PUT \
    "https://api.oss.coop/entite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"type_uid":"id_unique_universel","parent_id":0,"pays_id":1,"nom":"Diatem","description":"Un entreprise de talents ! Surtout en comm.","adresse":"2 rue de Dublin","cp":"67300","ville":"Schiltigheim","actif":true,"logo_prim_id":1,"logo_sec_id":2,"logo_ter_id":3}'

const url = new URL(
    "https://api.oss.coop/entite/2"
);

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

let body = {
    "type_uid": "id_unique_universel",
    "parent_id": 0,
    "pays_id": 1,
    "nom": "Diatem",
    "description": "Un entreprise de talents ! Surtout en comm.",
    "adresse": "2 rue de Dublin",
    "cp": "67300",
    "ville": "Schiltigheim",
    "actif": true,
    "logo_prim_id": 1,
    "logo_sec_id": 2,
    "logo_ter_id": 3
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/entite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'type_uid' => 'id_unique_universel',
            'parent_id' => 0,
            'pays_id' => 1,
            'nom' => 'Diatem',
            'description' => 'Un entreprise de talents ! Surtout en comm.',
            'adresse' => '2 rue de Dublin',
            'cp' => '67300',
            'ville' => 'Schiltigheim',
            'actif' => true,
            'logo_prim_id' => 1,
            'logo_sec_id' => 2,
            'logo_ter_id' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "type": { ... },
        "pays": { ... },
        "parent": null,
        "nom": "Diatem",
        "description": "Un entreprise de talents ! Surtout en comm.",
        "adresse": "2 rue de Dublin",
        "cp": "67300",
        "ville": "Schiltigheim",
        "actif": true,
        "logo_prim": { ... },
        "logo_sec": { ... },
        "logo_ter": { ... }
    }
}

Request   

PUT entite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'entité.

Body Parameters

type_uid  string  
L'identifiant unique du type d'entité.

parent_id  integer optional  
L'identifiant de l'entité parente de l'entité.

pays_id  integer optional  
L'identifiant d'une valeur du référentiel pays.

nom  string  
Le nom de l'entité.

description  string optional  
Le descriptif de l'entité.

adresse  string optional  
L'adresse (numéro, voie) de l'entité.

cp  string optional  
Le code postal de l'entité.

ville  string optional  
La ville de l'entité.

actif  boolean optional  
Si l'entité est active.

logo_prim_id  integer optional  
L'identifiant unique du média associé à l'entité. Défaut à null.

logo_sec_id  integer optional  
L'identifiant unique du média associé à l'entité. Défaut à null.

logo_ter_id  integer optional  
L'identifiant unique du média associé à l'entité. Défaut à null.

Supprimer

requires authentication

Supprime une entité

Example request:

curl -X DELETE \
    "https://api.oss.coop/entite/9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/entite/9"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/entite/9',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE entite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'entité.

Paramètre - Lister

requires authentication

Liste des paramètres d'une entité

Example request:

curl -X GET \
    -G "https://api.oss.coop/entite/1/parametre" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/entite/1/parametre"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/entite/1/parametre',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "precisions": "Petit text explicatif",
            "designation": "valeur",
            "valeur": "whatever"
        }
    ]
}

Request   

GET entite/{uid:[0-9]+}/parametre

URL Parameters

uid  integer  
L'identifiant de l'entité.

Paramètre - Modifier

requires authentication

Modifie les paramères d'une entité

Example request:

curl -X PUT \
    "https://api.oss.coop/entite/1/parametre" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"parametres":[{"uid":"id_unique_universel2","valeur":"whatever2"},{"uid":"id_unique_universel2"}]}'

const url = new URL(
    "https://api.oss.coop/entite/1/parametre"
);

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

let body = {
    "parametres": [
        {
            "uid": "id_unique_universel2",
            "valeur": "whatever2"
        },
        {
            "uid": "id_unique_universel2"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/entite/1/parametre',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'parametres' => [
                [
                    'uid' => 'id_unique_universel2',
                    'valeur' => 'whatever2',
                ],
                [
                    'uid' => 'id_unique_universel2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel2",
            "precisions": "Petit text explicatif 2",
            "designation": "valeur2",
            "valeur": "whatever2"
        }
    ]
}

Request   

PUT entite/{uid:[0-9]+}/parametre

URL Parameters

uid  integer  
L'identifiant de l'entité.

Body Parameters

parametres  object[]  
Les paramètres de l'entité.

parametres[].uid  string  
Un identifiant de paramétrage unique existant.

parametres[].valeur  string optional  
La valeur à associer au paramétrage de l'entité.

Erreurs

Lister

requires authentication

Liste des erreurs

Example request:

curl -X GET \
    -G "https://api.oss.coop/erreur?sort=nom.ASC%2Cid.DESC&page=7&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/erreur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/erreur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "create": "2025-04-03 15:10:41",
            "model": App\Data\Models\Essai,
            "model_id": 1,
            "details": "Essai : une erreur",
            "type": { ... }
        }
    ]
}

Request   

GET erreur

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'une erreur

Example request:

curl -X GET \
    -G "https://api.oss.coop/erreur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/erreur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/erreur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "create": "2025-04-03 15:10:41",
        "model": App\Data\Models\Essai,
        "model_id": 1,
        "details": "Essai : une erreur",
        "type": { ... }
    }
}

Request   

GET erreur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'erreur.

Essais

Lister

requires authentication

Liste des essais

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai?sort=nom.ASC%2Cid.DESC&page=16&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "essai",
            "numero": "azerty123",
            "surface_implantation_largeur": "123.456",
            "surface_implantation_longueur": "123.456",
            "surface_application_largeur": "123.456",
            "surface_application_longueur": "123.456",
            "surface_recoltee_largeur": "123.456",
            "surface_recoltee_longueur": "123.456",
            "plate_forme": false,
            "protocole": { ... },
            "parcelle": { ... },
            "modalite": { ... },
            "technicien": { ... }
        }
    ]
}

Request   

GET essai

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Lister

requires authentication

Liste des essais

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/enfants?sort=nom.ASC%2Cid.DESC&page=13&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/enfants"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/enfants',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "essai",
            "numero": "azerty123",
            "surface_implantation_largeur": "123.456",
            "surface_implantation_longueur": "123.456",
            "surface_application_largeur": "123.456",
            "surface_application_longueur": "123.456",
            "surface_recoltee_largeur": "123.456",
            "surface_recoltee_longueur": "123.456",
            "plate_forme": false,
            "protocole": { ... },
            "parcelle": { ... },
            "modalite": { ... },
            "technicien": { ... }
        }
    ]
}

Request   

GET essai/enfants

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "essai",
        "numero": "azerty123",
        "surface_implantation_largeur": "123.456",
        "surface_implantation_longueur": "123.456",
        "surface_application_largeur": "123.456",
        "surface_application_longueur": "123.456",
        "surface_recoltee_largeur": "123.456",
        "surface_recoltee_longueur": "123.456",
        "plate_forme": false,
        "protocole": { ... },
        "parcelle": { ... },
        "modalite": { ... },
        "technicien": { ... }
    }
}

Request   

GET essai/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'essai.

Ajouter

requires authentication

Ajoute un essai

Example request:

curl -X POST \
    "https://api.oss.coop/essai" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Essai2","numero":"123azerty","surface_implantation_largeur":"123","surface_implantation_longueur":"123","surface_application_largeur":"123","surface_application_longueur":"123","surface_recoltee_largeur":"123","surface_recoltee_longueur":"123","plate_forme":false,"protocole_id":1,"parcelle_id":1,"modalite_id":1,"technicien_id":1}'

const url = new URL(
    "https://api.oss.coop/essai"
);

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

let body = {
    "nom": "Essai2",
    "numero": "123azerty",
    "surface_implantation_largeur": "123",
    "surface_implantation_longueur": "123",
    "surface_application_largeur": "123",
    "surface_application_longueur": "123",
    "surface_recoltee_largeur": "123",
    "surface_recoltee_longueur": "123",
    "plate_forme": false,
    "protocole_id": 1,
    "parcelle_id": 1,
    "modalite_id": 1,
    "technicien_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Essai2',
            'numero' => '123azerty',
            'surface_implantation_largeur' => '123',
            'surface_implantation_longueur' => '123',
            'surface_application_largeur' => '123',
            'surface_application_longueur' => '123',
            'surface_recoltee_largeur' => '123',
            'surface_recoltee_longueur' => '123',
            'plate_forme' => false,
            'protocole_id' => 1,
            'parcelle_id' => 1,
            'modalite_id' => 1,
            'technicien_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "Essai2",
        "numero": "123azerty",
        "surface_implantation_largeur": "123",
        "surface_implantation_longueur": "123",
        "surface_application_largeur": "123",
        "surface_application_longueur": "123",
        "surface_recoltee_largeur": "123",
        "surface_recoltee_longueur": "123",
        "plate_forme": false,
        "protocole": { ... },
        "parcelle": { ... },
        "modalite": { ... },
        "technicien": { ... }
    }
}

Request   

POST essai

Body Parameters

nom  string  
Le nom de l'essai.

numero  string optional  
Le numéro de l'essai.

surface_implantation_largeur  numeric optional  
La largeur de surface d'implantation de l'essai.

surface_implantation_longueur  numeric optional  
La longueur de surface d'implantation de l'essai.

surface_application_largeur  numeric optional  
La largeur de surface d'application de l'essai.

surface_application_longueur  numeric optional  
La longueur de surface d'application de l'essai.

surface_recoltee_largeur  numeric optional  
La largeur de surface recoltée de l'essai.

surface_recoltee_longueur  numeric optional  
La longueur de surface recoltée de l'essai.

plate_forme  boolean optional  
Le caractère sur plate-forme de l'essai.

protocole_id  integer  
Le protocole de l'essai.

parcelle_id  integer optional  
La parcelle de l'essai.

modalite_id  integer optional  
La modalite de l'essai.

technicien_id  integer  
Le technicien de l'essai.

Modifier

requires authentication

Modifie un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Essai3","numero":"null","surface_implantation_largeur":"null","surface_implantation_longueur":"null","surface_application_largeur":"null","surface_application_longueur":"null","surface_recoltee_largeur":"null","surface_recoltee_longueur":"null","plate_forme":true,"protocole_id":1,"parcelle_id":1,"modalite_id":"null","technicien_id":2}'

const url = new URL(
    "https://api.oss.coop/essai/2"
);

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

let body = {
    "nom": "Essai3",
    "numero": "null",
    "surface_implantation_largeur": "null",
    "surface_implantation_longueur": "null",
    "surface_application_largeur": "null",
    "surface_application_longueur": "null",
    "surface_recoltee_largeur": "null",
    "surface_recoltee_longueur": "null",
    "plate_forme": true,
    "protocole_id": 1,
    "parcelle_id": 1,
    "modalite_id": "null",
    "technicien_id": 2
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Essai3',
            'numero' => 'null',
            'surface_implantation_largeur' => 'null',
            'surface_implantation_longueur' => 'null',
            'surface_application_largeur' => 'null',
            'surface_application_longueur' => 'null',
            'surface_recoltee_largeur' => 'null',
            'surface_recoltee_longueur' => 'null',
            'plate_forme' => true,
            'protocole_id' => 1,
            'parcelle_id' => 1,
            'modalite_id' => 'null',
            'technicien_id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "Essai3",
        "numero": null,
        "surface_implantation_largeur": null,
        "surface_implantation_longueur": null,
        "surface_application_largeur": null,
        "surface_application_longueur": null,
        "surface_recoltee_largeur": null,
        "surface_recoltee_longueur": null,
        "plate_forme": null,
        "protocole": { ... },
        "parcelle": { ... },
        "modalite": null,
        "technicien": { ... }
    }
}

Request   

PUT essai/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'essai.

Body Parameters

nom  string  
Le nom de l'essai.

numero  string optional  
Le numéro de l'essai.

surface_implantation_largeur  numeric optional  
La largeur de surface d'implantation de l'essai.

surface_implantation_longueur  numeric optional  
La longueur de surface d'implantation de l'essai.

surface_application_largeur  numeric optional  
La largeur de surface d'application de l'essai.

surface_application_longueur  numeric optional  
La longueur de surface d'application de l'essai.

surface_recoltee_largeur  numeric optional  
La largeur de surface recoltée de l'essai.

surface_recoltee_longueur  numeric optional  
La longueur de surface recoltée de l'essai.

plate_forme  boolean optional  
Le caractère sur plate-forme de l'essai.

protocole_id  integer  
Le protocole de l'essai.

parcelle_id  integer optional  
La parcelle de l'essai.

modalite_id  required optional  
La modalite de l'essai.

technicien_id  integer  
Le technicien de l'essai.

Validation

requires authentication

Revalide un essai

Example request:

curl -X PATCH \
    "https://api.oss.coop/essai/2/validation" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/2/validation"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/essai/2/validation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 4,
        "trigramme_validation": null,
        "date_validation": null,
        "chemin_personnalise": null,
        "surface_comptage": null,
        "nb_grains_comptage_elementaire": null,
        "aveugle": null,
        "coin_depart": null,
        "saisie_objet": { ... },
        "saisie_ordre": null,
        "saisie_ordre_global": null
    }
}

Request   

PATCH essai/{uid:[0-9]+}/validation

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la notation.

Lister

requires authentication

Liste des protocole des essais

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/enfants/protocole?sort=nom.ASC%2Cid.DESC&page=9&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/enfants/protocole"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/enfants/protocole',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "essai",
            "numero": "azerty123",
            "surface_implantation_largeur": "123.456",
            "surface_implantation_longueur": "123.456",
            "surface_application_largeur": "123.456",
            "surface_application_longueur": "123.456",
            "surface_recoltee_largeur": "123.456",
            "surface_recoltee_longueur": "123.456",
            "plate_forme": false,
            "protocole": { ... },
            "parcelle": { ... },
            "modalite": { ... },
            "technicien": { ... }
        }
    ]
}

Request   

GET essai/enfants/protocole

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Supprimer

requires authentication

Supprime un essai

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'essai.

Fichier - Lister

requires authentication

Liste des fichiers d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/fichier" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/fichier"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "description": "valeur",
            "categorie": { ... },
            "media": { ... }
        }
    ]
}

Request   

GET essai/{uid:[0-9]+}/fichier

URL Parameters

uid  integer  
L'identifiant de l'essai.

Fichier - Modifier

requires authentication

Modifie les fichiers d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/fichier" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"fichiers":[{"id":"2"},{"id":"2"}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/fichier"
);

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

let body = {
    "fichiers": [
        {
            "id": "2"
        },
        {
            "id": "2"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'fichiers' => [
                [
                    'id' => '2',
                ],
                [
                    'id' => '2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "description": "valeur2",
            "categorie": { ... },
            "media": { ... }
        }
    ]
}

Request   

PUT essai/{uid:[0-9]+}/fichier

URL Parameters

uid  integer  
L'identifiant de l'essai.

Body Parameters

fichiers  object[]  
Les fichiers de l'essai.

fichiers[].id  string  
Un identifiant de fichier existant.

Fiche - Bilan - Lister

requires authentication

Liste des fiches de bilan d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/fiche/bilan?sort=nom.ASC%2Cid.DESC&page=20&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/fiche/bilan"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "20",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/fiche/bilan',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '20',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "dispositif": true,
            "dispositif_precisions": "Au poil de c",
            "dispositif_evaluation": "Bons dispositif",
            "appchamp": true,
            "appchamp_precisions": "Au poil de c",
            "appchamp_evaluation": "Bonnes appchamp",
            "notations": true,
            "notations_precisions": "Au poil de c",
            "notations_evaluation": "Bonnes notations",
            "cv_rendement": 12.5,
            "rendement_moyen": 12.5,
            "validation_agronomique": false,
            "validation_statistique": false,
            "stats": true,
            "stats_precisions": "Au poil de c",
            "stats_evaluation": "Bonnes stats",
            "etatvegetatif": "Le dev de cette API probablement...",
            "stressclimat_temp": true,
            "stress_temp_commentaires": "Commentaire stress température",
            "stressclimat_pluvio": true,
            "stress_pluvio_commentaires": "Commentaire stress pluviométrie",
            "avis_resultats": "Bonne API dans l'ensemble, mais pas mal de petits bugs de merde",
            "stress_temp_pre": { ... },
            "stress_temp": { ... },
            "stress_temp_post": { ... },
            "stress_pluvio_pre": { ... },
            "stress_pluvio": { ... },
            "stress_pluvio_post": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/fiche/bilan

URL Parameters

euid  integer  
L'identifiant de l'essai.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Fiche - Bilan - Voir

requires authentication

Détails d'une fiche de bilan d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/fiche/bilan/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/fiche/bilan/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/fiche/bilan/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "dispositif": true,
        "dispositif_precisions": "Au poil de c",
        "dispositif_evaluation": "Bons dispositif",
        "appchamp": true,
        "appchamp_precisions": "Au poil de c",
        "appchamp_evaluation": "Bonnes appchamp",
        "notations": true,
        "notations_precisions": "Au poil de c",
        "notations_evaluation": "Bonnes notations",
        "cv_rendement": 12.5,
        "rendement_moyen": 12.5,
        "validation_agronomique": false,
        "validation_statistique": false,
        "stats": true,
        "stats_precisions": "Au poil de c",
        "stats_evaluation": "Bonnes stats",
        "etatvegetatif": "Le dev de cette API probablement...",
        "stressclimat_temp": true,
        "stress_temp_commentaires": "Commentaire stress température",
        "stressclimat_pluvio": true,
        "stress_pluvio_commentaires": "Commentaire stress pluviométrie",
        "avis_resultats": "Bonne API dans l'ensemble, mais pas mal de petits bugs de merde",
        "stress_temp_pre": { ... },
        "stress_temp": { ... },
        "stress_temp_post": { ... },
        "stress_pluvio_pre": { ... },
        "stress_pluvio": { ... },
        "stress_pluvio_post": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/fiche/bilan/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de la fiche.

Fiche - Bilan - Modifier

requires authentication

Modifie une fiche de bilan d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/fiche/bilan/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"dispositif":true,"dispositif_precisions":"null","dispositif_evaluation":"null","appchamp":true,"appchamp_precisions":"null","appchamp_evaluation":"null","notations":true,"notations_precisions":"null","notations_evaluation":"null","cv_rendement":"null","rendement_moyen":"null","validation_agronomique":true,"validation_statistique":true,"stats":true,"stats_precisions":"null","stats_evaluation":"null","etatvegetatif":"null","stressclimat_temp":true,"stress_temp_commentaires":"null","stressclimat_pluvio":true,"stress_pluvio_commentaires":"null","avis_resultats":"null","stress_temp_pre_id":0,"stress_temp_id":0,"stress_temp_post_id":0,"stress_pluvio__pre_id":0,"stress_pluvio__id":0,"stress_pluvio__post_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/fiche/bilan/2"
);

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

let body = {
    "dispositif": true,
    "dispositif_precisions": "null",
    "dispositif_evaluation": "null",
    "appchamp": true,
    "appchamp_precisions": "null",
    "appchamp_evaluation": "null",
    "notations": true,
    "notations_precisions": "null",
    "notations_evaluation": "null",
    "cv_rendement": "null",
    "rendement_moyen": "null",
    "validation_agronomique": true,
    "validation_statistique": true,
    "stats": true,
    "stats_precisions": "null",
    "stats_evaluation": "null",
    "etatvegetatif": "null",
    "stressclimat_temp": true,
    "stress_temp_commentaires": "null",
    "stressclimat_pluvio": true,
    "stress_pluvio_commentaires": "null",
    "avis_resultats": "null",
    "stress_temp_pre_id": 0,
    "stress_temp_id": 0,
    "stress_temp_post_id": 0,
    "stress_pluvio__pre_id": 0,
    "stress_pluvio__id": 0,
    "stress_pluvio__post_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/fiche/bilan/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'dispositif' => true,
            'dispositif_precisions' => 'null',
            'dispositif_evaluation' => 'null',
            'appchamp' => true,
            'appchamp_precisions' => 'null',
            'appchamp_evaluation' => 'null',
            'notations' => true,
            'notations_precisions' => 'null',
            'notations_evaluation' => 'null',
            'cv_rendement' => 'null',
            'rendement_moyen' => 'null',
            'validation_agronomique' => true,
            'validation_statistique' => true,
            'stats' => true,
            'stats_precisions' => 'null',
            'stats_evaluation' => 'null',
            'etatvegetatif' => 'null',
            'stressclimat_temp' => true,
            'stress_temp_commentaires' => 'null',
            'stressclimat_pluvio' => true,
            'stress_pluvio_commentaires' => 'null',
            'avis_resultats' => 'null',
            'stress_temp_pre_id' => 0,
            'stress_temp_id' => 0,
            'stress_temp_post_id' => 0,
            'stress_pluvio__pre_id' => 0,
            'stress_pluvio__id' => 0,
            'stress_pluvio__post_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "dispositif": null,
        "dispositif_precisions": null,
        "dispositif_evaluation": null,
        "appchamp": null,
        "appchamp_precisions": null,
        "appchamp_evaluation": null,
        "notations": null,
        "notations_precisions": null,
        "notations_evaluation": null,
        "cv_rendement": null,
        "rendement_moyen": null,
        "validation_agronomique": null,
        "validation_statistique": null,
        "stats": null,
        "stats_precisions": null,
        "stats_evaluation": null,
        "etatvegetatif": null,
        "stressclimat_temp": null,
        "stress_temp_commentaires": null,
        "stressclimat_pluvio": null,
        "stress_pluvio_commentaires": null,
        "avis_resultats": null,
        "stress_temp_pre": null,
        "stress_temp": null,
        "stress_temp_post": null,
        "stress_pluvio_pre": null,
        "stress_pluvio": null,
        "stress_pluvio_post": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/fiche/bilan/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de la fiche.

Body Parameters

dispositif  boolean optional  
Le caractère de dispositif de l'essai.

dispositif_precisions  string optional  
Le précisions de dispositif de la fiche de bilan de l'essai.

dispositif_evaluation  string optional  
L'évaluation de dispositif de la fiche de bilan de l'essai.

appchamp  boolean optional  
Le caractère d'application au champ de l'essai.

appchamp_precisions  string optional  
Les précisions de l'application au champ de la fiche de bilan de l'essai.

appchamp_evaluation  string optional  
L'évaluation de l'application au champ de la fiche de bilan de l'essai.

notations  boolean optional  
La présence de notations de l'essai.

notations_precisions  string optional  
Les précisions de notations de la fiche de bilan de l'essai.

notations_evaluation  string optional  
L'évaluation des notations de la fiche de bilan de l'essai.

cv_rendement  numeric optional  
La valeur de cv rendement de l'essai.

rendement_moyen  numeric optional  
La valeur de cv rendement de l'essai.

validation_agronomique  boolean optional  
La présence de validation agronomique de l'essai.

validation_statistique  boolean optional  
La présence de validation statistique de l'essai.

stats  boolean optional  
La présence de statistiques de l'essai.

stats_precisions  string optional  
Les précisions de statistiques de la fiche de bilan de l'essai.

stats_evaluation  string optional  
L'évaluation des statistiques de la fiche de bilan de l'essai.

etatvegetatif  string optional  
Les commentaires sur l'état végétatif de la fiche de bilan de l'essai.

stressclimat_temp  boolean optional  
La présence de stress climatique de la fiche de bilan de l'essai.

stress_temp_commentaires  string optional  
Les commentaires sur le stress de températures de la fiche de bilan de l'essai.

stressclimat_pluvio  boolean optional  
La présence de stress pluviométrique de la fiche de bilan de l'essai.

stress_pluvio_commentaires  string optional  
Les commentaires sur le stress de pluviométrie de la fiche de bilan de l'essai.

avis_resultats  string optional  
L'avis sur les resultats présents dans la fiche de bilan de l'essai.

stress_temp_pre_id  integer optional  
L'identifiant de la valeur du référentiel de stress.

stress_temp_id  integer optional  
L'identifiant de la valeur du référentiel de stress.

stress_temp_post_id  integer optional  
L'identifiant de la valeur du référentiel de stress.

stress_pluvio__pre_id  integer optional  
L'identifiant de la valeur du référentiel de stress.

stress_pluvio__id  integer optional  
L'identifiant de la valeur du référentiel de stress.

stress_pluvio__post_id  integer optional  
L'identifiant de la valeur du référentiel de stress.

Fiche - Validation - Lister

requires authentication

Liste des fiches de validation d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/fiche/validation?sort=nom.ASC%2Cid.DESC&page=9&limit=11" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/fiche/validation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/fiche/validation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "commentaires": "validation d'un essai",
            "cloture": false,
            "abandone_essai": false,
            "stat_validation": false,
            "stat_commentaire": "no comment",
            "validation_agro": false,
            "validation_trigramme": "AZERTY1234",
            "validation_date": "2150-12-31 12:00:00+02",
            "accord_objectif": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/fiche/validation

URL Parameters

euid  integer  
L'identifiant de l'essai.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Fiche - Validation - Voir

requires authentication

Détails d'une fiche de validation d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/fiche/validation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/fiche/validation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/fiche/validation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "commentaires": "validation d'un essai",
        "cloture": false,
        "abandone_essai": false,
        "stat_validation": false,
        "stat_commentaire": "no comment",
        "validation_agro": false,
        "validation_trigramme": "AZERTY1234",
        "validation_date": "2150-12-31 12:00:00+02",
        "accord_objectif": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/fiche/validation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de la fiche.

Fiche - Validation - Modifier

requires authentication

Modifie une fiche de validation d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/fiche/validation/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"commentaires":"null","cloture":true,"abandone_essai":true,"stat_validation":true,"stat_commentaire":"null","validation_agro":true,"validation_trigramme":"null","validation_date":"null","accord_objectif_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/fiche/validation/2"
);

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

let body = {
    "commentaires": "null",
    "cloture": true,
    "abandone_essai": true,
    "stat_validation": true,
    "stat_commentaire": "null",
    "validation_agro": true,
    "validation_trigramme": "null",
    "validation_date": "null",
    "accord_objectif_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/fiche/validation/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'commentaires' => 'null',
            'cloture' => true,
            'abandone_essai' => true,
            'stat_validation' => true,
            'stat_commentaire' => 'null',
            'validation_agro' => true,
            'validation_trigramme' => 'null',
            'validation_date' => 'null',
            'accord_objectif_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "commentaires": null,
        "cloture": null,
        "abandone_essai": null,
        "stat_validation": null,
        "stat_commentaire": null,
        "validation_agro": null,
        "validation_trigramme": null,
        "validation_date": null,
        "accord_objectif": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/fiche/validation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de la fiche.

Body Parameters

commentaires  string optional  
Les commentaires de la fiche de validation de l'essai.

cloture  boolean optional  
La clôture de la fiche de validation de l'essai.

abandone_essai  boolean optional  
L'abandon à l'essai de la fiche de validation de l'essai.

stat_validation  boolean optional  
La production de statistiques de la fiche de validation de l'essai.

stat_commentaire  string optional  
Les commentaires des statistiques de la fiche de validation de l'essai.

validation_agro  boolean optional  
La validation de la fiche de validation de l'essai.

validation_trigramme  string optional  
Le trigramme de validation de la fiche de validation de l'essai.

validation_date  date optional  
La date de validation de la fiche de validation de l'essai.

accord_objectif_id  integer optional  
L'identifiant de la valeur du référentiel d'accord objectif.

Fiche - Statut SIDEP - Lister

requires authentication

Liste des fiches de statut SIDEP d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/fiche/statut_sidep?sort=nom.ASC%2Cid.DESC&page=16&limit=16" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/fiche/statut_sidep"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/fiche/statut_sidep',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "declaration_date": "2150-12-31 12:00:00+02",
            "cloture_date": "2150-12-31 12:00:00+02",
            "statut_declaration": { ... },
            "statut_cloture": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/fiche/statut_sidep

URL Parameters

euid  integer  
L'identifiant de l'essai.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Fiche - Statut SIDEP - Voir

requires authentication

Détails d'une fiche de statut SIDEP d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/fiche/statut_sidep/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/fiche/statut_sidep/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/fiche/statut_sidep/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "declaration_date": "2150-12-31 12:00:00+02",
        "cloture_date": "2150-12-31 12:00:00+02",
        "statut_declaration": { ... },
        "statut_cloture": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/fiche/statut_sidep/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de la fiche.

Fiche - Statut SIDEP - Modifier

requires authentication

Modifie une fiche de statut SIDEP d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/fiche/statut_sidep/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"declaration_date":"null","cloture_date":"null","statut_declaration_id":0,"statut_cloture_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/fiche/statut_sidep/2"
);

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

let body = {
    "declaration_date": "null",
    "cloture_date": "null",
    "statut_declaration_id": 0,
    "statut_cloture_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/fiche/statut_sidep/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'declaration_date' => 'null',
            'cloture_date' => 'null',
            'statut_declaration_id' => 0,
            'statut_cloture_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "declaration_date": "2150-12-31 12:00:00+02",
        "cloture_date": "2150-12-31 12:00:00+02",
        "statut_declaration": { ... },
        "statut_cloture": { ... }
    }
}

Request   

PUT essai/{euid:[0-9]+}/fiche/statut_sidep/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de la fiche.

Body Parameters

declaration_date  date optional  
La date de déclaration de la fiche de statut SIDEP de l'essai.

cloture_date  date optional  
La date de clôture de la fiche de statut SIDEP de l'essai.

statut_declaration_id  integer optional  
L'identifiant de la valeur du référentiel de statut SIDEP.

statut_cloture_id  integer optional  
L'identifiant de la valeur du référentiel de statut SIDEP.

Catalogue Plan - Lister

requires authentication

Liste des plans d'essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/plan?sort=nom.ASC%2Cid.DESC&page=8&limit=7" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/plan"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "8",
    "limit": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/plan',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '8',
            'limit'=> '7',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "Tempête du désert",
            "temoins_exclus_localisation": "pas de témoins, pas de problèmes",
            "nb_repetitions": 4,
            "nb_modalites": 15,
            "nb_lignes": 5,
            "nb_colonnes": 3,
            "depart_x": 1,
            "depart_y": 1,
            "parametresavances": false,
            "est_variation_temoin": false,
            "type": { ... },
            "essai": null,
            "bordures": [ ... ],
            "orientation_generale": { ... },
            "point_depart": { ... },
            "position_bloc_observation": { ... },
            "randomisation": { ... },
            "marge": { ... },
            "implantation_temoins": { ... },
            "facteur": { ... }
        }
    ]
}

Request   

GET essai/plan

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Catalogue Plan - Voir

requires authentication

Détails d'un plan d'essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/plan/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/plan/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/plan/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "Tempête du désert",
        "temoins_exclus_localisation": "pas de témoins, pas de problèmes",
        "nb_repetitions": 4,
        "nb_modalites": 15,
        "nb_lignes": 5,
        "nb_colonnes": 3,
        "depart_x": 1,
        "depart_y": 1,
        "parametresavances": false,
        "est_variation_temoin": false,
        "type": { ... },
        "essai": null,
        "bordures": [ ... ],
        "orientation_generale": { ... },
        "point_depart": { ... },
        "position_bloc_observation": { ... },
        "randomisation": { ... },
        "marge": { ... },
        "implantation_temoins": { ... },
        "facteur": { ... }
    }
}

Request   

GET essai/plan/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du plan.

Catalogue Plan - Ajouter

requires authentication

Ajoute un plan d'essai

Example request:

curl -X POST \
    "https://api.oss.coop/essai/plan" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Barbarossa","temoins_exclus_localisation":"Monsieur X","nb_repetitions":12,"nb_modalites":42,"nb_lignes":5,"nb_colonnes":3,"depart_x":2,"depart_y":2,"disposition":1,"parametresavances":true,"est_variation_temoin":true,"type_uid":"type1","orientation_generale_uid":"orientationgenerale1","point_depart_uid":"pointdepart1","position_bloc_observation_uid":"positionblocobservation1","randomisation_uid":"randomisation1","marge_uid":"marge1","implantation_temoins_uid":"implantationtemoins1","facteur_id":1,"bordures":[{"uid":"bordure1"},[]]}'

const url = new URL(
    "https://api.oss.coop/essai/plan"
);

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

let body = {
    "nom": "Barbarossa",
    "temoins_exclus_localisation": "Monsieur X",
    "nb_repetitions": 12,
    "nb_modalites": 42,
    "nb_lignes": 5,
    "nb_colonnes": 3,
    "depart_x": 2,
    "depart_y": 2,
    "disposition": 1,
    "parametresavances": true,
    "est_variation_temoin": true,
    "type_uid": "type1",
    "orientation_generale_uid": "orientationgenerale1",
    "point_depart_uid": "pointdepart1",
    "position_bloc_observation_uid": "positionblocobservation1",
    "randomisation_uid": "randomisation1",
    "marge_uid": "marge1",
    "implantation_temoins_uid": "implantationtemoins1",
    "facteur_id": 1,
    "bordures": [
        {
            "uid": "bordure1"
        },
        []
    ]
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/plan',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Barbarossa',
            'temoins_exclus_localisation' => 'Monsieur X',
            'nb_repetitions' => 12,
            'nb_modalites' => 42,
            'nb_lignes' => 5,
            'nb_colonnes' => 3,
            'depart_x' => 2,
            'depart_y' => 2,
            'disposition' => 1,
            'parametresavances' => true,
            'est_variation_temoin' => true,
            'type_uid' => 'type1',
            'orientation_generale_uid' => 'orientationgenerale1',
            'point_depart_uid' => 'pointdepart1',
            'position_bloc_observation_uid' => 'positionblocobservation1',
            'randomisation_uid' => 'randomisation1',
            'marge_uid' => 'marge1',
            'implantation_temoins_uid' => 'implantationtemoins1',
            'facteur_id' => 1,
            'bordures' => [
                [
                    'uid' => 'bordure1',
                ],
                [],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "Barbarossa",
        "temoins_exclus_localisation": "Monsieur X",
        "nb_repetitions": 12,
        "nb_modalites": 42,
        "nb_lignes": 5,
        "nb_colonnes": 3,
        "depart_x": 2,
        "depart_y": 2,
        "parametresavances": true,
        "est_variation_temoin": true,
        "type": { ... },
        "essai": null,
        "bordures": [ ... ],
        "orientation_generale": { ... },
        "point_depart": { ... },
        "position_bloc_observation": { ... },
        "randomisation": { ... },
        "marge": { ... },
        "implantation_temoins": { ... },
        "facteur": { ... }
    }
}

Request   

POST essai/plan

Body Parameters

nom  string  
Le nom du plan.

temoins_exclus_localisation  string optional  
Les témoins à exclure dans le plan.

nb_repetitions  integer optional  
Le nombre de répétitions dans le plan.

nb_modalites  integer optional  
Le nombre de modalités dans le plan.

nb_lignes  integer optional  
Le nombre de lignes dans le plan.

nb_colonnes  integer optional  
Le nombre de colonnes dans le plan.

depart_x  integer optional  
La ligne de départ du plan.

depart_y  integer optional  
Le colone de départ du plan.

disposition  integer optional  
L'identifiant du plan à concerver.

parametresavances  boolean optional  
La présence de paramètres avancés dans le plan.

est_variation_temoin  boolean optional  
Les variations du plan différencient-elles les modalités témoins.

type_uid  string  
L'identifiant unique du type de plan.

orientation_generale_uid  string optional  
L'identifiant unique de l'orientation générale du plan.

point_depart_uid  string optional  
L'identifiant unique du point de départ du plan.

position_bloc_observation_uid  string optional  
L'identifiant unique de la position du bloc d'observation du plan.

randomisation_uid  string optional  
L'identifiant unique de randomisation du plan.

marge_uid  string optional  
L'identifiant unique de marge du plan.

implantation_temoins_uid  string optional  
L'identifiant unique d'implantation temoins du plan.

facteur_id  integer optional  
L'identifiant de facteur principal du plan.

bordures  object[] optional  
Les bordures du plan.

bordures[].uid  string optional  
Un identifiant unique de bordure existante.

essai/plan/{uid:[0-9]+}/check

requires authentication

Example request:

curl -X PATCH \
    "https://api.oss.coop/essai/plan/{uid:[0-9]+}/check" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/plan/{uid:[0-9]+}/check"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/essai/plan/{uid:[0-9]+}/check',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

PATCH essai/plan/{uid:[0-9]+}/check

Catalogue Plan - Modifier

requires authentication

Modifie un plan d'essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/plan/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Barbarossa","temoins_exclus_localisation":"null","nb_repetitions":0,"nb_modalites":0,"nb_lignes":0,"nb_colonnes":0,"depart_x":0,"depart_y":0,"parametresavances":true,"est_variation_temoin":false,"type_uid":"type1","orientation_generale_uid":"null","point_depart_uid":"null","position_bloc_observation_uid":"null","randomisation_uid":"null","marge_uid":"null","implantation_temoins_uid":"null","facteur_id":0,"bordures":[{"uid":"bordure1"},{"uid":"bordure1"}]}'

const url = new URL(
    "https://api.oss.coop/essai/plan/2"
);

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

let body = {
    "nom": "Barbarossa",
    "temoins_exclus_localisation": "null",
    "nb_repetitions": 0,
    "nb_modalites": 0,
    "nb_lignes": 0,
    "nb_colonnes": 0,
    "depart_x": 0,
    "depart_y": 0,
    "parametresavances": true,
    "est_variation_temoin": false,
    "type_uid": "type1",
    "orientation_generale_uid": "null",
    "point_depart_uid": "null",
    "position_bloc_observation_uid": "null",
    "randomisation_uid": "null",
    "marge_uid": "null",
    "implantation_temoins_uid": "null",
    "facteur_id": 0,
    "bordures": [
        {
            "uid": "bordure1"
        },
        {
            "uid": "bordure1"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/plan/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Barbarossa',
            'temoins_exclus_localisation' => 'null',
            'nb_repetitions' => 0,
            'nb_modalites' => 0,
            'nb_lignes' => 0,
            'nb_colonnes' => 0,
            'depart_x' => 0,
            'depart_y' => 0,
            'parametresavances' => true,
            'est_variation_temoin' => false,
            'type_uid' => 'type1',
            'orientation_generale_uid' => 'null',
            'point_depart_uid' => 'null',
            'position_bloc_observation_uid' => 'null',
            'randomisation_uid' => 'null',
            'marge_uid' => 'null',
            'implantation_temoins_uid' => 'null',
            'facteur_id' => 0,
            'bordures' => [
                [
                    'uid' => 'bordure1',
                ],
                [
                    'uid' => 'bordure1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "Barbarossa",
        "temoins_exclus_localisation": null,
        "nb_repetitions": null,
        "nb_modalites": null,
        "nb_lignes": null,
        "nb_colonnes": null,
        "depart_x": null,
        "depart_y": null,
        "parametresavances": null,
        "est_variation_temoin": false,
        "type": { ... },
        "essai": null,
        "bordures": null,
        "orientation_generale": null,
        "point_depart": null,
        "position_bloc_observation": null,
        "randomisation": null,
        "marge": null,
        "implantation_temoins": null,
        "facteur": null
    }
}

Request   

PUT essai/plan/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du plan.

Body Parameters

nom  string  
Le nom du plan.

temoins_exclus_localisation  string optional  
Les témoins à exclure dans le plan.

nb_repetitions  integer optional  
Le nombre de répétitions dans le plan.

nb_modalites  integer optional  
Le nombre de modalités dans le plan.

nb_lignes  integer optional  
Le nombre de lignes dans le plan.

nb_colonnes  integer optional  
Le nombre de colonnes dans le plan.

depart_x  integer optional  
La ligne de départ du plan.

depart_y  integer optional  
Le colone de départ du plan.

parametresavances  boolean optional  
La présence de paramètres avancés dans le plan.

est_variation_temoin  boolean optional  
Les variations du plan différencient-elles les modalités témoins.

type_uid  string  
L'identifiant unique du type de plan.

orientation_generale_uid  string optional  
L'identifiant unique de l'orientation générale du plan.

point_depart_uid  string optional  
L'identifiant unique du point de départ du plan.

position_bloc_observation_uid  string optional  
L'identifiant unique de la position du bloc d'observation du plan.

randomisation_uid  string optional  
L'identifiant unique de randomisation du plan.

marge_uid  string optional  
L'identifiant unique de marge du plan.

implantation_temoins_uid  string optional  
L'identifiant unique d'implantation temoins du plan.

facteur_id  integer optional  
L'identifiant de facteur principal du plan.

bordures  object[] optional  
Les bordures du plan.

bordures[].uid  string optional  
Un identifiant unique de bordure existante.

Catalogue Plan - Supprimer

requires authentication

Supprime un plan d'essai

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/plan/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/plan/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/plan/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/plan/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du plan.

Plan - Lister

requires authentication

Liste des plans d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/plan?sort=nom.ASC%2Cid.DESC&page=9&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/plan"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/plan',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "Tempête du désert",
            "temoins_exclus_localisation": "pas de témoins, pas de problèmes",
            "nb_repetitions": 4,
            "nb_modalites": 15,
            "nb_lignes": 5,
            "nb_colonnes": 3,
            "depart_x": 1,
            "depart_y": 1,
            "parametresavances": false,
            "est_variation_temoin": false,
            "type": { ... },
            "essai": { ... },
            "bordures": [ ... ],
            "orientation_generale": { ... },
            "point_depart": { ... },
            "position_bloc_observation": { ... },
            "randomisation": { ... },
            "marge": { ... },
            "implantation_temoins": { ... },
            "facteur": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/plan

URL Parameters

euid  integer  
L'identifiant de l'essai.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Plan - Voir

requires authentication

Détails d'un plan d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/plan/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/plan/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/plan/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "Tempête du désert",
        "temoins_exclus_localisation": "pas de témoins, pas de problèmes",
        "nb_repetitions": 4,
        "nb_modalites": 15,
        "nb_lignes": 5,
        "nb_colonnes": 3,
        "depart_x": 1,
        "depart_y": 1,
        "parametresavances": false,
        "est_variation_temoin": false,
        "type": { ... },
        "essai": { ... },
        "bordures": [ ... ],
        "orientation_generale": { ... },
        "point_depart": { ... },
        "position_bloc_observation": { ... },
        "randomisation": { ... },
        "marge": { ... },
        "implantation_temoins": { ... },
        "facteur": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/plan/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du plan.

Plan - Ajouter

requires authentication

Ajoute un plan d'un essai

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/plan" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Barbarossa","temoins_exclus_localisation":"Monsieur X","nb_repetitions":12,"nb_modalites":42,"nb_lignes":5,"nb_colonnes":3,"depart_x":2,"depart_y":2,"parametresavances":true,"est_variation_temoin":true,"type_uid":"type1","orientation_generale_uid":"orientationgenerale1","point_depart_uid":"pointdepart1","position_bloc_observation_uid":"positionblocobservation1","randomisation_uid":"randomisation1","marge_uid":"marge1","implantation_temoins_uid":"implantationtemoins1","facteur_id":1,"bordures":[{"uid":"bordure1"},[]]}'

const url = new URL(
    "https://api.oss.coop/essai/1/plan"
);

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

let body = {
    "nom": "Barbarossa",
    "temoins_exclus_localisation": "Monsieur X",
    "nb_repetitions": 12,
    "nb_modalites": 42,
    "nb_lignes": 5,
    "nb_colonnes": 3,
    "depart_x": 2,
    "depart_y": 2,
    "parametresavances": true,
    "est_variation_temoin": true,
    "type_uid": "type1",
    "orientation_generale_uid": "orientationgenerale1",
    "point_depart_uid": "pointdepart1",
    "position_bloc_observation_uid": "positionblocobservation1",
    "randomisation_uid": "randomisation1",
    "marge_uid": "marge1",
    "implantation_temoins_uid": "implantationtemoins1",
    "facteur_id": 1,
    "bordures": [
        {
            "uid": "bordure1"
        },
        []
    ]
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/plan',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Barbarossa',
            'temoins_exclus_localisation' => 'Monsieur X',
            'nb_repetitions' => 12,
            'nb_modalites' => 42,
            'nb_lignes' => 5,
            'nb_colonnes' => 3,
            'depart_x' => 2,
            'depart_y' => 2,
            'parametresavances' => true,
            'est_variation_temoin' => true,
            'type_uid' => 'type1',
            'orientation_generale_uid' => 'orientationgenerale1',
            'point_depart_uid' => 'pointdepart1',
            'position_bloc_observation_uid' => 'positionblocobservation1',
            'randomisation_uid' => 'randomisation1',
            'marge_uid' => 'marge1',
            'implantation_temoins_uid' => 'implantationtemoins1',
            'facteur_id' => 1,
            'bordures' => [
                [
                    'uid' => 'bordure1',
                ],
                [],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "Barbarossa",
        "temoins_exclus_localisation": "Monsieur X",
        "nb_repetitions": 12,
        "nb_modalites": 42,
        "nb_lignes": 5,
        "nb_colonnes": 3,
        "depart_x": 2,
        "depart_y": 2,
        "parametresavances": true,
        "est_variation_temoin": true,
        "type": { ... },
        "essai": { ... },
        "bordures": [ ... ],
        "orientation_generale": { ... },
        "point_depart": { ... },
        "position_bloc_observation": { ... },
        "randomisation": { ... },
        "marge": { ... },
        "implantation_temoins": { ... },
        "facteur": { ... }
    }
}

Request   

POST essai/{euid:[0-9]+}/plan

URL Parameters

euid  integer  
L'identifiant de l'essai.

Body Parameters

nom  string optional  
Le nom du plan.

temoins_exclus_localisation  string optional  
Les témoins à exclure dans le plan.

nb_repetitions  integer optional  
Le nombre de répétitions dans le plan.

nb_modalites  integer optional  
Le nombre de modalités dans le plan.

nb_lignes  integer optional  
Le nombre de lignes dans le plan.

nb_colonnes  integer optional  
Le nombre de colonnes dans le plan.

depart_x  integer optional  
La ligne de départ du plan.

depart_y  integer optional  
Le colone de départ du plan.

parametresavances  boolean optional  
La présence de paramètres avancés dans le plan.

est_variation_temoin  boolean optional  
Les variations du plan différencient-elles les modalités témoins.

type_uid  string  
L'identifiant unique du type de plan.

orientation_generale_uid  string optional  
L'identifiant unique de l'orientation générale du plan.

point_depart_uid  string optional  
L'identifiant unique du point de départ du plan.

position_bloc_observation_uid  string optional  
L'identifiant unique de la position du bloc d'observation du plan.

randomisation_uid  string optional  
L'identifiant unique de randomisation du plan.

marge_uid  string optional  
L'identifiant unique de marge du plan.

implantation_temoins_uid  string optional  
L'identifiant unique d'implantation temoins du plan.

facteur_id  integer optional  
L'identifiant de facteur principal du plan.

bordures  object[] optional  
Les bordures du plan.

bordures[].uid  string optional  
Un identifiant unique de bordure existante.

Plan - Modifier

requires authentication

Modifie un plan d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/plan/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Barbarossa","temoins_exclus_localisation":"null","nb_repetitions":0,"nb_modalites":0,"nb_lignes":0,"nb_colonnes":0,"depart_x":0,"depart_y":0,"parametresavances":true,"est_variation_temoin":false,"type_uid":"type1","orientation_generale_uid":"null","point_depart_uid":"null","position_bloc_observation_uid":"null","randomisation_uid":"null","marge_uid":"null","implantation_temoins_uid":"null","facteur_id":0,"bordures":[{"uid":"bordure1"},{"uid":"bordure1"}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/plan/2"
);

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

let body = {
    "nom": "Barbarossa",
    "temoins_exclus_localisation": "null",
    "nb_repetitions": 0,
    "nb_modalites": 0,
    "nb_lignes": 0,
    "nb_colonnes": 0,
    "depart_x": 0,
    "depart_y": 0,
    "parametresavances": true,
    "est_variation_temoin": false,
    "type_uid": "type1",
    "orientation_generale_uid": "null",
    "point_depart_uid": "null",
    "position_bloc_observation_uid": "null",
    "randomisation_uid": "null",
    "marge_uid": "null",
    "implantation_temoins_uid": "null",
    "facteur_id": 0,
    "bordures": [
        {
            "uid": "bordure1"
        },
        {
            "uid": "bordure1"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/plan/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Barbarossa',
            'temoins_exclus_localisation' => 'null',
            'nb_repetitions' => 0,
            'nb_modalites' => 0,
            'nb_lignes' => 0,
            'nb_colonnes' => 0,
            'depart_x' => 0,
            'depart_y' => 0,
            'parametresavances' => true,
            'est_variation_temoin' => false,
            'type_uid' => 'type1',
            'orientation_generale_uid' => 'null',
            'point_depart_uid' => 'null',
            'position_bloc_observation_uid' => 'null',
            'randomisation_uid' => 'null',
            'marge_uid' => 'null',
            'implantation_temoins_uid' => 'null',
            'facteur_id' => 0,
            'bordures' => [
                [
                    'uid' => 'bordure1',
                ],
                [
                    'uid' => 'bordure1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "Barbarossa",
        "temoins_exclus_localisation": null,
        "nb_repetitions": null,
        "nb_modalites": null,
        "nb_lignes": null,
        "nb_colonnes": null,
        "depart_x": null,
        "depart_y": null,
        "parametresavances": null,
        "est_variation_temoin": false,
        "type": { ... },
        "essai": { ... },
        "bordures": [ ... ],
        "orientation_generale": null,
        "point_depart": null,
        "position_bloc_observation": null,
        "randomisation": null,
        "marge": null,
        "implantation_temoins": null,
        "facteur": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/plan/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du plan.

Body Parameters

nom  string optional  
Le nom du plan.

temoins_exclus_localisation  string optional  
Les témoins à exclure dans le plan.

nb_repetitions  integer optional  
Le nombre de répétitions dans le plan.

nb_modalites  integer optional  
Le nombre de modalités dans le plan.

nb_lignes  integer optional  
Le nombre de lignes dans le plan.

nb_colonnes  integer optional  
Le nombre de colonnes dans le plan.

depart_x  integer optional  
La ligne de départ du plan.

depart_y  integer optional  
Le colone de départ du plan.

parametresavances  boolean optional  
La présence de paramètres avancés dans le plan.

est_variation_temoin  boolean optional  
Les variations du plan différencient-elles les modalités témoins.

type_uid  string  
L'identifiant unique du type de plan.

orientation_generale_uid  string optional  
L'identifiant unique de l'orientation générale du plan.

point_depart_uid  string optional  
L'identifiant unique du point de départ du plan.

position_bloc_observation_uid  string optional  
L'identifiant unique de la position du bloc d'observation du plan.

randomisation_uid  string optional  
L'identifiant unique de randomisation du plan.

marge_uid  string optional  
L'identifiant unique de marge du plan.

implantation_temoins_uid  string optional  
L'identifiant unique d'implantation temoins du plan.

facteur_id  integer optional  
L'identifiant de facteur principal du plan.

bordures  object[] optional  
Les bordures du plan.

bordures[].uid  string optional  
Un identifiant unique de bordure existante.

Plan - Supprimer

requires authentication

Supprime un plan d'un essai

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/plan/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/plan/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/plan/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/plan/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du plan.

Plan - Générer

requires authentication

Générer les microparcelles à partir d'un plan d'un essai

Example request:

curl -X PATCH \
    "https://api.oss.coop/essai/1/plan/2/generer" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/plan/2/generer"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/essai/1/plan/2/generer',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH essai/{euid:[0-9]+}/plan/{uid:[0-9]+}/generer

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du plan.

Evenement - Lister

requires authentication

Liste des événements d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement?sort=nom.ASC%2Cid.DESC&page=14&limit=8" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "8",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '8',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Evénement 1",
            "observations": "Un événement",
            "date_previsionnelle": "2150-12-31 12:00:00+02",
            "date_realisation": "2150-12-31 12:00:00+02",
            "type": { ... },
            "passage": { ... },
            "stade": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement

URL Parameters

euid  integer  
L'identifiant de l'essai.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Voir

requires authentication

Détails d'un événement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Evénement 1",
        "observations": "Un événement",
        "date_previsionnelle": "2150-12-31 12:00:00+02",
        "date_realisation": "2150-12-31 12:00:00+02",
        "type": { ... },
        "passage": { ... },
        "stade": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de l'événement.

Evenement - Ajouter

requires authentication

Ajoute un événement d'un essai

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Ev\u00e9nement 2","observations":"Un autre \u00e9v\u00e9nement","date_previsionnelle":"2150-12-31 12:00:00+02","date_realisation":"2150-12-31 12:00:00+02","type_uid":"type1","passage_id":1,"stade_uid":"1"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement"
);

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

let body = {
    "designation": "Ev\u00e9nement 2",
    "observations": "Un autre \u00e9v\u00e9nement",
    "date_previsionnelle": "2150-12-31 12:00:00+02",
    "date_realisation": "2150-12-31 12:00:00+02",
    "type_uid": "type1",
    "passage_id": 1,
    "stade_uid": "1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Evénement 2',
            'observations' => 'Un autre événement',
            'date_previsionnelle' => '2150-12-31 12:00:00+02',
            'date_realisation' => '2150-12-31 12:00:00+02',
            'type_uid' => 'type1',
            'passage_id' => 1,
            'stade_uid' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Evénement 2",
        "observations": "Un autre événement",
        "date_previsionnelle": "2150-12-31 12:00:00+02",
        "date_realisation": "2150-12-31 12:00:00+02",
        "type": { ... },
        "passage": { ... },
        "stade": { ... }
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement

URL Parameters

euid  integer  
L'identifiant de l'essai.

Body Parameters

designation  string optional  
La designation de l'événement.

observations  string optional  
Les observations de l'événement.

date_previsionnelle  date optional  
La date prévisionnelle de l'événement.

date_realisation  date optional  
La date de réalisation de l'événement.

type_uid  string  
L'identifiant unique du type d'événement.

passage_id  integer optional  
L'identifiant de passage de l'événement.

stade_uid  string optional  
L'identifiant unique du stade de l'événement.

Evenement - Modifier

requires authentication

Modifie un événement d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"null","observations":"null","date_previsionnelle":"null","date_realisation":"null","type_uid":"type1","passage_id":0,"stade_uid":"null"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/2"
);

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

let body = {
    "designation": "null",
    "observations": "null",
    "date_previsionnelle": "null",
    "date_realisation": "null",
    "type_uid": "type1",
    "passage_id": 0,
    "stade_uid": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'null',
            'observations' => 'null',
            'date_previsionnelle' => 'null',
            'date_realisation' => 'null',
            'type_uid' => 'type1',
            'passage_id' => 0,
            'stade_uid' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": null,
        "observations": null,
        "date_previsionnelle": null,
        "date_realisation": null,
        "type": { ... },
        "passage": null,
        "stade": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de l'événement.

Body Parameters

designation  string optional  
La designation de l'événement.

observations  string optional  
Les observations de l'événement.

date_previsionnelle  date optional  
La date prévisionnelle de l'événement.

date_realisation  date optional  
La date de réalisation de l'événement.

type_uid  string  
L'identifiant unique du type d'événement.

passage_id  integer optional  
L'identifiant de passage de l'événement.

stade_uid  string optional  
L'identifiant unique du stade de l'événement.

Evenement - Supprimer

requires authentication

Supprime un événement d'un essai

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant de l'événement.

Evenement - Fiche - Conditions de traitement - Lister

requires authentication

Liste des fiches de conditions de traitement d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement?sort=nom.ASC%2Cid.DESC&page=11&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "11",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '11',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "reference": "Traitement1",
            "autre": "Une sorte de commentaire",
            "controlepulve_commentaires": "Un commentaire sur le controle de pulverisateur",
            "heure_debut": "09:00",
            "heure_fin": "11:00",
            "etat_vegetatif_culture": "Dodo",
            "temperature_debut": "0,0",
            "temperature_fin": "42",
            "hygrometrie_debut": "0,0",
            "hygrometrie_fin": "42",
            "vitessevent_min": "0,0",
            "vitessevent_max": "42",
            "nebulosite_mesure": "42",
            "pluie_24h": false,
            "pluie_quantite": "42",
            "pressionbuses_quantite": "42",
            "observations_cible": "Target located",
            "observations_traitement": "Pchit pchit",
            "validation_trigramme": "AZERTY123",
            "validation_date": "2150-12-31 12:00:00+02",
            "materielutilise": "Mon ordi",
            "typebuses": "on dit triple, pas type",
            "controle_pulverisateur": { ... },
            "vitesse_vent": { ... },
            "etat_surface_sol": { ... },
            "humidite_sol": { ... },
            "residus_recolte": { ... },
            "ensoleillement": { ... },
            "nebulosite": { ... },
            "rosee": { ... },
            "stade": { ... },
            "modalites": null
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/conditions_traitement

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Conditions de traitement - Voir

requires authentication

Détails d'une fiche de conditions de traitement d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "reference": "Traitement1",
        "autre": "Une sorte de commentaire",
        "controlepulve_commentaires": "Un commentaire sur le controle de pulverisateur",
        "heure_debut": "09:00",
        "heure_fin": "11:00",
        "etat_vegetatif_culture": "Dodo",
        "temperature_debut": "0,0",
        "temperature_fin": "42",
        "hygrometrie_debut": "0,0",
        "hygrometrie_fin": "42",
        "vitessevent_min": "0,0",
        "vitessevent_max": "42",
        "nebulosite_mesure": "42",
        "pluie_24h": false,
        "pluie_quantite": "42",
        "pressionbuses_quantite": "42",
        "observations_cible": "Target located",
        "observations_traitement": "Pchit pchit",
        "validation_trigramme": "AZERTY123",
        "validation_date": "2150-12-31 12:00:00+02",
        "materielutilise": "Mon ordi",
        "typebuses": "on dit triple, pas type",
        "controle_pulverisateur": { ... },
        "vitesse_vent": { ... },
        "etat_surface_sol": { ... },
        "humidite_sol": { ... },
        "residus_recolte": { ... },
        "ensoleillement": { ... },
        "nebulosite": { ... },
        "rosee": { ... },
        "stade": { ... },
        "modalites": null
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/conditions_traitement/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Conditions de traitement - Modifier

requires authentication

Modifie une fiche de conditions de traitement d'un événement de type traitement d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"reference":"null","autre":"null","controlepulve_commentaires":"null","heure_debut":"null","heure_fin":"null","etat_vegetatif_culture":"null","observations_cible":"null","observations_traitement":"null","validation_trigramme":"null","materielutilise":"null","typebuses":"null","temperature_debut":"null","temperature_fin":"null","hygrometrie_debut":"null","hygrometrie_fin":"null","vitessevent_min":"null","vitessevent_max":"null","nebulosite_mesure":"null","pluie_quantite":"null","pressionbuses_quantite":"null","pluie_24h":true,"validation_date":"null","controle_pulverisateur_id":0,"vitesse_vent_id":0,"etat_surface_sol_id":0,"humidite_sol_id":0,"residus_recolte_id":0,"ensoleillement_id":0,"nebulosite_id":0,"rosee_id":0,"stade_uid":"null.","modalites":[{"id":"1"},{"id":"1"}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement/2"
);

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

let body = {
    "reference": "null",
    "autre": "null",
    "controlepulve_commentaires": "null",
    "heure_debut": "null",
    "heure_fin": "null",
    "etat_vegetatif_culture": "null",
    "observations_cible": "null",
    "observations_traitement": "null",
    "validation_trigramme": "null",
    "materielutilise": "null",
    "typebuses": "null",
    "temperature_debut": "null",
    "temperature_fin": "null",
    "hygrometrie_debut": "null",
    "hygrometrie_fin": "null",
    "vitessevent_min": "null",
    "vitessevent_max": "null",
    "nebulosite_mesure": "null",
    "pluie_quantite": "null",
    "pressionbuses_quantite": "null",
    "pluie_24h": true,
    "validation_date": "null",
    "controle_pulverisateur_id": 0,
    "vitesse_vent_id": 0,
    "etat_surface_sol_id": 0,
    "humidite_sol_id": 0,
    "residus_recolte_id": 0,
    "ensoleillement_id": 0,
    "nebulosite_id": 0,
    "rosee_id": 0,
    "stade_uid": "null.",
    "modalites": [
        {
            "id": "1"
        },
        {
            "id": "1"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/conditions_traitement/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'reference' => 'null',
            'autre' => 'null',
            'controlepulve_commentaires' => 'null',
            'heure_debut' => 'null',
            'heure_fin' => 'null',
            'etat_vegetatif_culture' => 'null',
            'observations_cible' => 'null',
            'observations_traitement' => 'null',
            'validation_trigramme' => 'null',
            'materielutilise' => 'null',
            'typebuses' => 'null',
            'temperature_debut' => 'null',
            'temperature_fin' => 'null',
            'hygrometrie_debut' => 'null',
            'hygrometrie_fin' => 'null',
            'vitessevent_min' => 'null',
            'vitessevent_max' => 'null',
            'nebulosite_mesure' => 'null',
            'pluie_quantite' => 'null',
            'pressionbuses_quantite' => 'null',
            'pluie_24h' => true,
            'validation_date' => 'null',
            'controle_pulverisateur_id' => 0,
            'vitesse_vent_id' => 0,
            'etat_surface_sol_id' => 0,
            'humidite_sol_id' => 0,
            'residus_recolte_id' => 0,
            'ensoleillement_id' => 0,
            'nebulosite_id' => 0,
            'rosee_id' => 0,
            'stade_uid' => 'null.',
            'modalites' => [
                [
                    'id' => '1',
                ],
                [
                    'id' => '1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "reference": null,
        "autre": null,
        "controlepulve_commentaires": null,
        "heure_debut": null,
        "heure_fin": null,
        "etat_vegetatif_culture": null,
        "temperature_debut": null,
        "temperature_fin": null,
        "hygrometrie_debut": null,
        "hygrometrie_fin": null,
        "vitessevent_min": null,
        "vitessevent_max": null,
        "nebulosite_mesure": null,
        "pluie_24h": null,
        "pluie_quantite": null,
        "pressionbuses_quantite": null,
        "observations_cible": null,
        "observations_traitement": null,
        "validation_trigramme": null,
        "validation_date": null,
        "materielutilise": null,
        "typebuses": null,
        "controle_pulverisateur": null,
        "vitesse_vent": null,
        "etat_surface_sol": null,
        "humidite_sol": null,
        "residus_recolte": null,
        "ensoleillement": null,
        "nebulosite": null,
        "rosee": null,
        "stade": null,
        "modalites": [ ... ]
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/conditions_traitement/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

reference  string optional  
La référence de la fiche.

autre  string optional  
Les remarques de la fiche.

controlepulve_commentaires  string optional  
Les commentaires sur le controle de pulvérisateur de la fiche.

heure_debut  string optional  
L'heure de début du traitement de la fiche.

heure_fin  string optional  
L'heure de fin du traitement de la fiche.

etat_vegetatif_culture  string optional  
Les états végetatifs des cultures de la fiche.

observations_cible  string optional  
Les observations de cible de la fiche.

observations_traitement  string optional  
Les observations de traitement de la fiche.

validation_trigramme  string optional  
Le trigramme de validation de la fiche.

materielutilise  string optional  
Le materiel utilise de la fiche.

typebuses  string optional  
Les type de buses de la fiche.

temperature_debut  numeric optional  
La temperature de debut de traitement de la fiche.

temperature_fin  numeric optional  
La temperature de fin de traitement de la fiche.

hygrometrie_debut  numeric optional  
L'hygrometrie de debut de traitement de la fiche.

hygrometrie_fin  numeric optional  
L'hygrometrie de fin de traitement de la fiche.

vitessevent_min  numeric optional  
La vitesse de vent minimum de la fiche.

vitessevent_max  numeric optional  
La vitesse de vent maximum de la fiche.

nebulosite_mesure  numeric optional  
La mesure de nebulosite de la fiche.

pluie_quantite  numeric optional  
La quantite de pluie de la fiche.

pressionbuses_quantite  numeric optional  
La quantite de pression de buses de la fiche.

pluie_24h  boolean optional  
La présence de pluie dans les 24h de la fiche.

validation_date  date optional  
La date de validation de la fiche.

controle_pulverisateur_id  integer optional  
L'identifiant de la valeur du référentiel de controlepulverisateur.

vitesse_vent_id  integer optional  
L'identifiant de la valeur du référentiel de vitessevent.

etat_surface_sol_id  integer optional  
L'identifiant de la valeur du référentiel de etatsurfacesol.

humidite_sol_id  integer optional  
L'identifiant de la valeur du référentiel de humiditesol.

residus_recolte_id  integer optional  
L'identifiant de la valeur du référentiel de residusrecolte.

ensoleillement_id  integer optional  
L'identifiant de la valeur du référentiel de ensoleillement.

nebulosite_id  integer optional  
L'identifiant de la valeur du référentiel de nebulosite.

rosee_id  integer optional  
L'identifiant de la valeur du référentiel de rosee.

stade_uid  string optional  
L'identifiant unique de stade de la fiche.

modalites  object[] optional  
Les modalités de la fiche.

modalites[].id  intger optional  
Un identifiant de modalité existante.

Evenement - Fiche - Contamination - Lister

requires authentication

Liste des fiches contamination d'un événement de type contamination d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/contamination?sort=nom.ASC%2Cid.DESC&page=17&limit=19" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/contamination"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "17",
    "limit": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/contamination',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '17',
            'limit'=> '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "produitcontaminant": "Un produit"
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/contamination

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Contamination - Voir

requires authentication

Détails d'une fiche contamination d'un événement de type contamination d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/contamination/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/contamination/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/contamination/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "produitcontaminant": "Un produit"
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/contamination/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Contamination - Modifier

requires authentication

Modifie une fiche contamination d'un événement de type contamination d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/contamination/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"produitcontaminant":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/contamination/2"
);

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

let body = {
    "produitcontaminant": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/contamination/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'produitcontaminant' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "produitcontaminant": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/contamination/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

produitcontaminant  integer optional  
Le produit contaminant de la fiche.

Evenement - Fiche - Destruction - Lister

requires authentication

Liste des fiches de destruction d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/destruction?sort=nom.ASC%2Cid.DESC&page=9&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "trigramme_validation": "AZERTY123",
            "date_validation": "2150-12-31 12:00:00+02",
            "moment_destruction": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Destruction - Voir

requires authentication

Détails d'une fiche de destruction d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "trigramme_validation": "AZERTY123",
        "date_validation": "2150-12-31 12:00:00+02",
        "moment_destruction": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Destruction - Modifier

requires authentication

Modifie une fiche de destruction d'un événement de type traitement d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"trigramme_validation":"null","date_validation":"null","moment_destruction_id":"null."}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/2"
);

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

let body = {
    "trigramme_validation": "null",
    "date_validation": "null",
    "moment_destruction_id": "null."
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'trigramme_validation' => 'null',
            'date_validation' => 'null',
            'moment_destruction_id' => 'null.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "trigramme_validation": null,
        "date_validation": null,
        "moment_destruction": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

trigramme_validation  string optional  
Le trigramme de validation de la fiche.

date_validation  date optional  
La date de validation de la fiche.

moment_destruction_id  date optional  
L'identifiant de la valeur du référentiel de momentdestruction.

Evenement - Fiche - Destruction - Preuve - Lister

requires authentication

Liste des preuves d'une fiche de destruction d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve?sort=nom.ASC%2Cid.DESC&page=7&limit=2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "media": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/preuve

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Destruction - Preuve - Voir

requires authentication

Détails d'une preuve d'une fiche de destruction d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "media": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/preuve/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la preuve.

Evenement - Fiche - Destruction - Preuve - Ajouter

requires authentication

Ajoute une preuve d'une fiche de destruction d'un événement de type traitement d'un essai

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"media_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve"
);

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

let body = {
    "media_id": 0
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'media_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "media": { ... }
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/preuve

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Body Parameters

media_id  integer  
L'identifiant du media de preuve.

Evenement - Fiche - Destruction - Preuve - Modifier

requires authentication

Modifie une preuve d'une fiche de destruction d'un événement de type traitement d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"media_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/2"
);

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

let body = {
    "media_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'media_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "media": { ... }
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/preuve/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la preuve.

Body Parameters

media_id  integer  
L'identifiant du media de preuve.

Evenement - Fiche - Destruction - Preuve - Supprimer

requires authentication

Supprime une preuve d'une fiche de destruction d'un événement de type traitement d'un essai

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/preuve/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/preuve/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la preuve.

Evenement - Fiche - Destruction - Pesée - Modalité - Lister

requires authentication

Liste des modalités pesées de fiches destruction d'un événement de type destruction d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite?sort=nom.ASC%2Cid.DESC&page=17&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "17",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '17',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "mecanique_moyen": "Avion",
            "mecanique_date": "2150-12-31 12:00:00+02",
            "chimique_produit": "Le truc qui fait de la mousse",
            "chimique_dose": "12",
            "chimique_date": "2150-12-31 12:00:00+02",
            "quantite": "12",
            "modalite": { ... },
            "unite": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/modalite

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Destruction - Pesée - Modalité - Voir

requires authentication

Détails d'une modalité pesée d'une fiche destruction d'un événement de type destruction d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "mecanique_moyen": "Avion",
        "mecanique_date": "2150-12-31 12:00:00+02",
        "chimique_produit": "Le truc qui fait de la mousse",
        "chimique_dose": "12",
        "chimique_date": "2150-12-31 12:00:00+02",
        "quantite": "12",
        "modalite": { ... },
        "unite": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Evenement - Fiche - Fertilisation - Pesée - Modalité produit - Modifier

requires authentication

Modifie un produit de modalité pesée d'une fiche fertilisation d'un événement de ferti semis d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"mecanique_moyen":"null","mecanique_date":"null","chimique_produit":"null","chimique_dose":"null","chimique_date":"null","quantite":"null","unite_uid":"null"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite/2"
);

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

let body = {
    "mecanique_moyen": "null",
    "mecanique_date": "null",
    "chimique_produit": "null",
    "chimique_dose": "null",
    "chimique_date": "null",
    "quantite": "null",
    "unite_uid": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/destruction/modalite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'mecanique_moyen' => 'null',
            'mecanique_date' => 'null',
            'chimique_produit' => 'null',
            'chimique_dose' => 'null',
            'chimique_date' => 'null',
            'quantite' => 'null',
            'unite_uid' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "mecanique_moyen": null,
        "mecanique_date": null,
        "chimique_produit": null,
        "chimique_dose": null,
        "chimique_date": null,
        "quantite": null,
        "modalite": { ... },
        "unite": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/destruction/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Body Parameters

mecanique_moyen  string optional  
Les moyen mécanique.

mecanique_date  date optional  
La date d'usage du moyen mécanique.

chimique_produit  string optional  
Les produit chimique.

chimique_dose  numeric optional  
La dose de produit chimique.

chimique_date  date optional  
La date d'usage du produit chimique.

quantite  numeric optional  
La quantité de la modalité.

unite_uid  string optional  
L'identifiant unique du composant de la pesée du produit de la modalité.

Evenement - Fiche - Fertilisation - Pesée - Lister

requires authentication

Liste des pesées de fiches fertilisation d'un événement de type ferti d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee?sort=nom.ASC%2Cid.DESC&page=9&limit=4" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "marge_securite_pesee": "0.1",
            "validation_trigramme": "AZERTY123",
            "date_validation": "2150-12-31 12:00:00+02",
            "unite": { ... },
            "unite_dose_epandue": { ... },
            "composant": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/fertilisation/pesee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Fertilisation - Pesée - Voir

requires authentication

Détails d'une pesée d'une fiche fertilisation d'un événement de type ferti d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "marge_securite_pesee": "0.1",
        "validation_trigramme": "AZERTY123",
        "date_validation": "2150-12-31 12:00:00+02",
        "unite": { ... },
        "unite_dose_epandue": { ... },
        "composant": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/fertilisation/pesee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Evenement - Fiche - Fertilisation - Pesée - Modifier

requires authentication

Modifie une pesée d'une fiche fertilisation d'un événement de type ferti d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"marge_securite_pesee":"null","validation_trigramme":"null","date_validation":"null","unite_uid":0,"composant_uid":0,"unite_dose_epandue_id":"null."}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/2"
);

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

let body = {
    "marge_securite_pesee": "null",
    "validation_trigramme": "null",
    "date_validation": "null",
    "unite_uid": 0,
    "composant_uid": 0,
    "unite_dose_epandue_id": "null."
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'marge_securite_pesee' => 'null',
            'validation_trigramme' => 'null',
            'date_validation' => 'null',
            'unite_uid' => 0,
            'composant_uid' => 0,
            'unite_dose_epandue_id' => 'null.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "marge_securite_pesee": null,
        "validation_trigramme": null,
        "date_validation": null,
        "unite": null,
        "unite_dose_epandue": null,
        "composant": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/fertilisation/pesee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Body Parameters

marge_securite_pesee  numeric optional  
La marge de securité de la pesée.

validation_trigramme  string optional  
Le trigramme de validation de la pesée.

date_validation  date optional  
La date de validation de la pesée.

unite_uid  integer optional  
L'identifiant unique de l'unité de la pesée.

composant_uid  integer optional  
L'identifiant unique du composant de la pesée.

unite_dose_epandue_id  date optional  
L'identifiant de la valeur du référentiel d'unitedoseepandue.

Evenement - Fiche - Fertilisation - Pesée - Modalité produit - Lister

requires authentication

Liste des produits de modalités pesées de fiches fertilisation d'un événement de type ferti d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite?sort=nom.ASC%2Cid.DESC&page=9&limit=19" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "pesee_reelle": "12",
            "densite": "12",
            "dose_epandue": "12",
            "quantite_calculee_par_microparcelle": "12",
            "trigramme": "AZERTY123",
            "observations": "Flemme de calculer, alors surface et quantité sont à null",
            "date": "2150-12-31 12:00:00+02",
            "surface_application": null,
            "quantite_microparcelle": null,
            "modalite": { ... },
            "produit": { ... },
            "composant": { ... },
            "unite": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/fertilisation/pesee/modalite

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Fertilisation - Pesée - Modalité produit - Voir

requires authentication

Détails d'un produit de modalité pesée d'une fiche fertilisation d'un événement de type ferti d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "pesee_reelle": "12",
        "densite": "12",
        "dose_epandue": "12",
        "quantite_calculee_par_microparcelle": "12",
        "trigramme": "AZERTY123",
        "observations": "Flemme de calculer, alors surface et quantité sont à null",
        "date": "2150-12-31 12:00:00+02",
        "surface_application": null,
        "quantite_microparcelle": null,
        "modalite": { ... },
        "produit": { ... },
        "composant": { ... },
        "unite": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/fertilisation/pesee/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Evenement - Fiche - Fertilisation - Pesée - Modalité produit - Modifier

requires authentication

Modifie un produit de modalité pesée d'une fiche fertilisation d'un événement de ferti semis d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"pesee_reelle":"null","densite":"null","dose_epandue":"null","quantite_calculee_par_microparcelle":"null","trigramme":"null","observations":"null","date":"null","unite_uid":0,"composant_uid":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite/2"
);

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

let body = {
    "pesee_reelle": "null",
    "densite": "null",
    "dose_epandue": "null",
    "quantite_calculee_par_microparcelle": "null",
    "trigramme": "null",
    "observations": "null",
    "date": "null",
    "unite_uid": 0,
    "composant_uid": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/fertilisation/pesee/modalite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'pesee_reelle' => 'null',
            'densite' => 'null',
            'dose_epandue' => 'null',
            'quantite_calculee_par_microparcelle' => 'null',
            'trigramme' => 'null',
            'observations' => 'null',
            'date' => 'null',
            'unite_uid' => 0,
            'composant_uid' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "pesee_reelle": null,
        "densite": null,
        "dose_epandue": null,
        "quantite_calculee_par_microparcelle": null,
        "trigramme": null,
        "observations": null,
        "date": null,
        "surface_application": null,
        "quantite_microparcelle": null,
        "modalite": { ... },
        "produit": { ... },
        "composant": null,
        "unite": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/fertilisation/pesee/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Body Parameters

pesee_reelle  numeric optional  
La valeur de pesée réelle du produit de la modalité.

densite  numeric optional  
La valeur de densite du produit de la modalité.

dose_epandue  numeric optional  
La valeur de dose épandue du produit de la modalité.

quantite_calculee_par_microparcelle  numeric optional  
La quantité calculée par microparcelle du produit de la modalité.

trigramme  string optional  
Le trigramme de pesée du produit de la modalité.

observations  string optional  
Les observations sur la pesée du produit de la modalité.

date  date optional  
La date de la pesée du produit de la modalité.

unite_uid  integer optional  
L'identifiant unique de l'unité de la pesée du produit de la modalité.

composant_uid  integer optional  
L'identifiant unique du composant de la pesée du produit de la modalité.

Evenement - Fiche - Phytosanitaire - Pesée - Lister

requires authentication

Liste des pesées de fiches phytosanitaire d'un événement de type phyto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee?sort=nom.ASC%2Cid.DESC&page=14&limit=9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "marge_securite_calcul": "0.1",
            "cadence_traitement": "0.1",
            "tolerance_ecart_pesee": "0.1",
            "pulverisation": "0.1",
            "volume_bouillie_surface": "0.1",
            "validation_trigramme": "AZERTY123",
            "date_validation": "2150-12-31 12:00:00+02",
            "unite": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/phytosanitaire/pesee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Phytosanitaire - Pesée - Voir

requires authentication

Détails d'une pesée d'une fiche phytosanitaire d'un événement de type phyto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "marge_securite_calcul": "0.1",
        "cadence_traitement": "0.1",
        "tolerance_ecart_pesee": "0.1",
        "pulverisation": "0.1",
        "volume_bouillie_surface": "0.1",
        "validation_trigramme": "AZERTY123",
        "date_validation": "2150-12-31 12:00:00+02",
        "unite": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/phytosanitaire/pesee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Evenement - Fiche - Phytosanitaire - Pesée - Modifier

requires authentication

Modifie une pesée d'une fiche phytosanitaire d'un événement de type phyto d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"marge_securite_calcul":"null","cadence_traitement":"null","tolerance_ecart_pesee":"null","pulverisation":"null","volume_bouillie_surface":"null","validation_trigramme":"null","date_validation":"null","unite_uid":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/2"
);

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

let body = {
    "marge_securite_calcul": "null",
    "cadence_traitement": "null",
    "tolerance_ecart_pesee": "null",
    "pulverisation": "null",
    "volume_bouillie_surface": "null",
    "validation_trigramme": "null",
    "date_validation": "null",
    "unite_uid": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'marge_securite_calcul' => 'null',
            'cadence_traitement' => 'null',
            'tolerance_ecart_pesee' => 'null',
            'pulverisation' => 'null',
            'volume_bouillie_surface' => 'null',
            'validation_trigramme' => 'null',
            'date_validation' => 'null',
            'unite_uid' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "marge_securite_calcul": null,
        "cadence_traitement": null,
        "tolerance_ecart_pesee": null,
        "pulverisation": null,
        "volume_bouillie_surface": null,
        "validation_trigramme": null,
        "date_validation": null,
        "unite": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/phytosanitaire/pesee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Body Parameters

marge_securite_calcul  numeric optional  
La marge de securité de la pesée.

cadence_traitement  numeric optional  
La cadence de traitement de la pesée.

tolerance_ecart_pesee  numeric optional  
La tolérance d'écart de pesée de la pesée.

pulverisation  numeric optional  
La pulvérisation de la pesée.

volume_bouillie_surface  numeric optional  
Le volume bouillie surface de la pesée.

validation_trigramme  string optional  
Le trigramme de validation de la pesée.

date_validation  date optional  
La date de validation de la pesée.

unite_uid  integer optional  
L'identifiant unique de l'unité de la pesée.

Evenement - Fiche - Phytosanitaire - Pesée - Modalité produit - Lister

requires authentication

Liste des produits de modalités pesées de fiches phytosanitaire d'un événement de type phyto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite?sort=nom.ASC%2Cid.DESC&page=20&limit=3" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "20",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '20',
            'limit'=> '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "pesee_reelle": "12",
            "densite": "12",
            "trigramme": "AZERTY123",
            "observations": "Flemme de calculer, alors surface et quantité sont à null",
            "date": "2150-12-31 12:00:00+02",
            "surface_application": null,
            "surface": null,
            "quantite": null,
            "pesee_min": null,
            "pesee_max": null,
            "modalite": { ... },
            "produit": { ... },
            "unite": null
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/phytosanitaire/pesee/modalite

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Phytosanitaire - Pesée - Modalité produit - Voir

requires authentication

Détails d'un produit de modalité pesée d'une fiche phytosanitaire d'un événement de type phyto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "pesee_reelle": "12",
        "densite": "12",
        "trigramme": "AZERTY123",
        "observations": "Flemme de calculer, alors surface et quantité sont à null",
        "date": "2150-12-31 12:00:00+02",
        "surface_application": null,
        "surface": null,
        "quantite": null,
        "pesee_min": null,
        "pesee_max": null,
        "modalite": { ... },
        "produit": { ... },
        "unite": null
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/phytosanitaire/pesee/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Evenement - Fiche - Phytosanitaire - Pesée - Modalité produit - Modifier

requires authentication

Modifie un produit de modalité pesée d'une fiche phytosanitaire d'un événement de type phyto d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"pesee_reelle":"null","densite":"null","trigramme":"null","observations":"null","date":"null"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite/2"
);

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

let body = {
    "pesee_reelle": "null",
    "densite": "null",
    "trigramme": "null",
    "observations": "null",
    "date": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/phytosanitaire/pesee/modalite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'pesee_reelle' => 'null',
            'densite' => 'null',
            'trigramme' => 'null',
            'observations' => 'null',
            'date' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "pesee_reelle": null,
        "densite": null",
        "trigramme": null,
        "observations": null,
        "date": null,
        "surface_application": null,
        "surface": null,
        "quantite": null,
        "pesee_min": null,
        "pesee_max": null,
        "modalite": { ... },
        "produit": { ... },
        "unite": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/phytosanitaire/pesee/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Body Parameters

pesee_reelle  numeric optional  
La valeur de pesée réelle du produit de la modalité.

densite  numeric optional  
La valeur de densite du produit de la modalité.

trigramme  string optional  
Le trigramme de pesée du produit de la modalité.

observations  string optional  
Les observations sur la pesée du produit de la modalité.

date  date optional  
La date de la pesée du produit de la modalité.

Evenement - Fiche - Prélèvement - Lister

requires authentication

Liste des fiches de prélèvement d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/prelevement?sort=nom.ASC%2Cid.DESC&page=1&limit=5" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/prelevement"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/prelevement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "organe": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/prelevement

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Prélèvement - Voir

requires authentication

Détails d'une fiche de prélèvement d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/prelevement/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/prelevement/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/prelevement/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "organe": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/prelevement/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Prélèvement - Modifier

requires authentication

Modifie une fiche de prélèvement d'un événement de type traitement d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/prelevement/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"organe_id":"null."}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/prelevement/2"
);

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

let body = {
    "organe_id": "null."
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/prelevement/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'organe_id' => 'null.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "organe": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/prelevement/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

organe_id  date optional  
L'identifiant de la valeur du référentiel d'organe.

Evenement - Fiche - Récolte - Lister

requires authentication

Liste des fiches de récolte d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/recolte?sort=nom.ASC%2Cid.DESC&page=5&limit=5" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/recolte"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/recolte',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "commentaires": "récolte blablabla",
            "materielrecolte1": "Petites mains",
            "materielrecolte1": null,
            "conditions_recolte": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/recolte

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Récolte - Voir

requires authentication

Détails d'une fiche de récolte d'un événement de type traitement d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/recolte/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/recolte/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/recolte/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "commentaires": "récolte blablabla",
        "materielrecolte1": "Petites mains",
        "materielrecolte1": null,
        "conditions_recolte": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/recolte/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Conditions de traitement - Modifier

requires authentication

Modifie une fiche de conditions de traitement d'un événement de type traitement d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/recolte/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"commentaires":"null","materielrecolte1":"null","conditions_recolte_id":"null."}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/recolte/2"
);

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

let body = {
    "commentaires": "null",
    "materielrecolte1": "null",
    "conditions_recolte_id": "null."
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/recolte/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'commentaires' => 'null',
            'materielrecolte1' => 'null',
            'conditions_recolte_id' => 'null.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "commentaires": null,
        "materielrecolte1": null,
        "materielrecolte1": null,
        "conditions_recolte": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/recolte/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

commentaires  string optional  
Les commentaires de la fiche.

materielrecolte1  string optional  
Le second matériel de récolte de la fiche.

conditions_recolte_id  date optional  
L'identifiant de la valeur du référentiel de conditions de récolte.

Evenement - Fiche - Semis - Lister

requires authentication

Liste des fiches semis d'un événement de type semis d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/semis?sort=nom.ASC%2Cid.DESC&page=18&limit=14" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "18",
    "limit": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '18',
            'limit'=> '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "produit": { ... },
            "media": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Semis - Voir

requires authentication

Détails d'une fiche semis d'un événement de type semis d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/semis/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "produit": { ... },
        "media": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Semis - Modifier

requires authentication

Modifie une fiche semis d'un événement de type semis d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"media_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/2"
);

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

let body = {
    "media_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'media_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "produit": { ... },
        "media": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

media_id  integer optional  
L'identifiant du média de la fiche.

Evenement - Fiche - Semis - Pesée - Lister

requires authentication

Liste des pesées de fiches semis d'un événement de type semis d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee?sort=nom.ASC%2Cid.DESC&page=16&limit=3" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "marge_securite_pesee": "0.1",
            "validation_trigramme": "AZERTY123",
            "date_validation": "2150-12-31 12:00:00+02",
            "unite": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/pesee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Semis - Pesée - Voir

requires authentication

Détails d'une pesée d'une fiche semis d'un événement de type semis d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "marge_securite_pesee": "0.1",
        "validation_trigramme": "AZERTY123",
        "date_validation": "2150-12-31 12:00:00+02",
        "unite": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/pesee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Evenement - Fiche - Semis - Pesée - Modifier

requires authentication

Modifie une pesée d'une fiche semis d'un événement de type semis d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"marge_securite_pesee":"null","validation_trigramme":"null","date_validation":"null","unite_uid":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/2"
);

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

let body = {
    "marge_securite_pesee": "null",
    "validation_trigramme": "null",
    "date_validation": "null",
    "unite_uid": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'marge_securite_pesee' => 'null',
            'validation_trigramme' => 'null',
            'date_validation' => 'null',
            'unite_uid' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "marge_securite_pesee": null,
        "validation_trigramme": null,
        "date_validation": null,
        "unite": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/pesee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Body Parameters

marge_securite_pesee  numeric optional  
La marge de securité de la pesée.

validation_trigramme  string optional  
Le trigramme de validation de la pesée.

date_validation  date optional  
La date de validation de la pesée.

unite_uid  integer optional  
L'identifiant unique de l'unité de la pesée.

Evenement - Fiche - Semis - Pesée - Modalité semence - Lister

requires authentication

Liste des semences de modalités pesées de fiches semis d'un événement de type semis d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite?sort=nom.ASC%2Cid.DESC&page=8&limit=11" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "8",
    "limit": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '8',
            'limit'=> '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "pmg": "42.23",
            "faculte_germinative": "1",
            "pesee_reelle": "12",
            "trigramme": "AZERTY123",
            "observations": "Flemme de calculer, alors surface et quantité sont à null",
            "date": "2150-12-31 12:00:00+02",
            "surface_implantation": null,
            "quantite_microparcelle": null,
            "modalite": { ... },
            "produit": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/pesee/modalite

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Semis - Pesée - Modalité semence - Voir

requires authentication

Détails d'une semence de modalité pesée d'une fiche semis d'un événement de type semis d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "pmg": "42.23",
        "faculte_germinative": "1",
        "pesee_reelle": "12",
        "trigramme": "AZERTY123",
        "observations": "Flemme de calculer, alors surface et quantité sont à null",
        "date": "2150-12-31 12:00:00+02",
        "surface_implantation": null,
        "quantite_microparcelle": null,
        "modalite": { ... },
        "produit": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/pesee/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Evenement - Fiche - Semis - Pesée - Modalité semence - Modifier

requires authentication

Modifie une semence de modalité pesée d'une fiche semis d'un événement de type semis d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"pmg":"null","faculte_germinative":"null","pesee_reelle":"null","trigramme":"null","observations":"null","date":"null"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite/2"
);

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

let body = {
    "pmg": "null",
    "faculte_germinative": "null",
    "pesee_reelle": "null",
    "trigramme": "null",
    "observations": "null",
    "date": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/semis/pesee/modalite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'pmg' => 'null',
            'faculte_germinative' => 'null',
            'pesee_reelle' => 'null',
            'trigramme' => 'null',
            'observations' => 'null',
            'date' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "pmg": null,
        "faculte_germinative": null,
        "pesee_reelle": null,
        "trigramme": null,
        "observations": null,
        "date": null,
        "surface_implantation": null,
        "quantite_microparcelle": null,
        "modalite": { ... },
        "produit": { ... }
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/semis/pesee/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche pesée.

Body Parameters

pmg  numeric optional  
La valeur PMG de la semence.

faculte_germinative  numeric optional  
La valeur de faculte germinative de la semence de la modalité.

pesee_reelle  numeric optional  
La valeur de pesée réelle de la semence de la modalité.

trigramme  string optional  
Le trigramme de pesée de la semence de la modalité.

observations  string optional  
Les observations sur la pesée de la semence de la modalité.

date  date optional  
La date de la pesée de la semence de la modalité.

Evenement - Fiche - Volume non épandus - Lister

requires authentication

Liste des fiches de volume non épandus d'un événement de type phto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus?sort=nom.ASC%2Cid.DESC&page=15&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "15",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '15',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "calcul_volume_applique": "0.1",
            "volume_ha": "0.1",
            "ecart_tolere": "0.1",
            "validation_trigramme": "AZERTY123",
            "date_validation": "2150-12-31 12:00:00+02"
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/volume_non_epandus

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Volume non épandus - Voir

requires authentication

Détails d'une fiche de volume non épandus d'un événement de type phyto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "calcul_volume_applique": "0.1",
        "volume_ha": "0.1",
        "ecart_tolere": "0.1",
        "validation_trigramme": "AZERTY123",
        "date_validation": "2150-12-31 12:00:00+02"
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/volume_non_epandus/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Volume non épandus - Modifier

requires authentication

Modifie d'une fiche de volume non épandus d'un événement de type phyto d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"calcul_volume_applique":"null","volume_ha":"null","ecart_tolere":"null","validation_trigramme":"null","date_validation":"null"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/2"
);

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

let body = {
    "calcul_volume_applique": "null",
    "volume_ha": "null",
    "ecart_tolere": "null",
    "validation_trigramme": "null",
    "date_validation": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'calcul_volume_applique' => 'null',
            'volume_ha' => 'null',
            'ecart_tolere' => 'null',
            'validation_trigramme' => 'null',
            'date_validation' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "calcul_volume_applique": null,
        "volume_ha": null,
        "ecart_tolere": null,
        "validation_trigramme": null,
        "date_validation": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/volume_non_epandus/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

calcul_volume_applique  numeric optional  
Le calcul de colume appliqué de la fiche.

volume_ha  numeric optional  
Le volume en héctares non épandus de la fiche.

ecart_tolere  numeric optional  
L'écart toléré de la fiche.

validation_trigramme  string optional  
Le trigramme de validation de la fiche.

date_validation  date optional  
La date de validation de la fiche.

Evenement - Fiche - Volume non épandus - Modalite - Lister

requires authentication

Liste des modalités de fiche volume non épandus d'un événement de type phto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite?sort=nom.ASC%2Cid.DESC&page=3&limit=2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "3",
    "limit": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '3',
            'limit'=> '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "volume_restant": "0.1",
            "volume_applique": "0.1",
            "modalite": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/volume_non_epandus/modalite

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Fiche - Volume non épandus - Modalite - Voir

requires authentication

Détails d'une modalité de fiche volume non épandus d'un événement de type phto d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "volume_restant": "0.1",
        "volume_applique": "0.1",
        "modalite": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/volume_non_epandus/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Evenement - Fiche - Volume non épandus - Modalité - Modifier

requires authentication

Modifie une modalité de fiche volume non épandus d'un événement de type phto d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"volume_restant":"null","volume_applique":"null"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite/2"
);

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

let body = {
    "volume_restant": "null",
    "volume_applique": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/volume_non_epandus/modalite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'volume_restant' => 'null',
            'volume_applique' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "volume_restant": null,
        "volume_applique": null,
        "modalite": { ... }
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/volume_non_epandus/modalite/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la fiche.

Body Parameters

volume_restant  numeric optional  
La valeur de volume réstant de la modalité.

volume_applique  numeric optional  
La valeur de volume appliqué de la modalité.

Evenement - Notation - Lister

requires authentication

Liste des notations d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation?sort=nom.ASC%2Cid.DESC&page=1&limit=8" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "8",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '8',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "trigramme_validation": "AZERTY123",
            "date_validation": "2150-12-31 12:00:00+02",
            "chemin_personnalise": "droite,gauche,gauche,...",
            "surface_comptage": "15.2",
            "nb_grains_comptage_elementaire": 20,
            "aveugle": false,
            "coin_depart": { ... },
            "saisie_objet": { ... },
            "saisie_ordre": { ... },
            "saisie_ordre_global": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Notation - Voir

requires authentication

Détails d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "trigramme_validation": "AZERTY123",
        "date_validation": "2150-12-31 12:00:00+02",
        "chemin_personnalise": "droite,gauche,gauche,...",
        "surface_comptage": "15.2",
        "nb_grains_comptage_elementaire": 20,
        "aveugle": false,
        "coin_depart": { ... },
        "saisie_objet": { ... },
        "saisie_ordre": { ... },
        "saisie_ordre_global": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la notation.

Evenement - Notation - Ajouter

requires authentication

Ajoute une notation à un événement

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"trigramme_validation":"AZERTY12345","chemin_personnalise":"gauche,droite,gauche,...","surface_comptage":"12.5","nb_grains_comptage_elementaire":42,"aveugle":true,"date_validation":"null","coin_depart_uid":"cd1","saisie_objet_uid":"so1","saisie_ordre_uid":"so1","saisie_ordre_global_uid":"sog1"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation"
);

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

let body = {
    "trigramme_validation": "AZERTY12345",
    "chemin_personnalise": "gauche,droite,gauche,...",
    "surface_comptage": "12.5",
    "nb_grains_comptage_elementaire": 42,
    "aveugle": true,
    "date_validation": "null",
    "coin_depart_uid": "cd1",
    "saisie_objet_uid": "so1",
    "saisie_ordre_uid": "so1",
    "saisie_ordre_global_uid": "sog1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'trigramme_validation' => 'AZERTY12345',
            'chemin_personnalise' => 'gauche,droite,gauche,...',
            'surface_comptage' => '12.5',
            'nb_grains_comptage_elementaire' => 42,
            'aveugle' => true,
            'date_validation' => 'null',
            'coin_depart_uid' => 'cd1',
            'saisie_objet_uid' => 'so1',
            'saisie_ordre_uid' => 'so1',
            'saisie_ordre_global_uid' => 'sog1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "trigramme_validation": "AZERTY12345",
        "date_validation": null,
        "chemin_personnalise": "gauche,droite,gauche,...",
        "surface_comptage": "12.5",
        "nb_grains_comptage_elementaire": 42,
        "aveugle": true,
        "coin_depart": { ... },
        "saisie_objet": { ... },
        "saisie_ordre": { ... },
        "saisie_ordre_global": { ... }
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

Body Parameters

trigramme_validation  string optional  
Le trigramme de validation de la notation.

chemin_personnalise  string optional  
Le chemin personnalisé de la notation.

surface_comptage  numeric optional  
La surface de comptage de la notation.

nb_grains_comptage_elementaire  integer optional  
Le nombre de grains de comptage élementaire de la notation.

aveugle  boolean optional  
La surface de comptage de la notation.

date_validation  date optional  
Le date de validation de la notation.

coin_depart_uid  string optional  
L'identifiant unique du coin de départ de la notation.

saisie_objet_uid  string  
L'identifiant unique de l'objet de saisie de la notation.

saisie_ordre_uid  string optional  
L'identifiant unique de l'ordre de saisie de la notation.

saisie_ordre_global_uid  string optional  
L'identifiant unique de l'ordre global de saisie de la notation.

Evenement - Notation - Modifier

requires authentication

Modifie une notation d'un événement

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"trigramme_validation":"null","chemin_personnalise":"null","surface_comptage":"null","nb_grains_comptage_elementaire":0,"aveugle":true,"date_validation":"null","coin_depart_uid":"null","saisie_objet_uid":"so1","saisie_ordre_uid":"null","saisie_ordre_global_uid":"null"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2"
);

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

let body = {
    "trigramme_validation": "null",
    "chemin_personnalise": "null",
    "surface_comptage": "null",
    "nb_grains_comptage_elementaire": 0,
    "aveugle": true,
    "date_validation": "null",
    "coin_depart_uid": "null",
    "saisie_objet_uid": "so1",
    "saisie_ordre_uid": "null",
    "saisie_ordre_global_uid": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'trigramme_validation' => 'null',
            'chemin_personnalise' => 'null',
            'surface_comptage' => 'null',
            'nb_grains_comptage_elementaire' => 0,
            'aveugle' => true,
            'date_validation' => 'null',
            'coin_depart_uid' => 'null',
            'saisie_objet_uid' => 'so1',
            'saisie_ordre_uid' => 'null',
            'saisie_ordre_global_uid' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "trigramme_validation": null,
        "date_validation": null,
        "chemin_personnalise": null,
        "surface_comptage": null,
        "nb_grains_comptage_elementaire": null,
        "aveugle": null,
        "coin_depart": null,
        "saisie_objet": { ... },
        "saisie_ordre": null,
        "saisie_ordre_global": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la notation.

Body Parameters

trigramme_validation  string optional  
Le trigramme de validation de la notation.

chemin_personnalise  string optional  
Le chemin personnalisé de la notation.

surface_comptage  numeric optional  
La surface de comptage de la notation.

nb_grains_comptage_elementaire  integer optional  
Le nombre de grains de comptage élementaire de la notation.

aveugle  boolean optional  
La surface de comptage de la notation.

date_validation  date optional  
Le date de validation de la notation.

coin_depart_uid  string optional  
L'identifiant unique du coin de départ de la notation.

saisie_objet_uid  string  
L'identifiant unique de l'objet de saisie de la notation.

saisie_ordre_uid  string optional  
L'identifiant unique de l'ordre de saisie de la notation.

saisie_ordre_global_uid  string optional  
L'identifiant unique de l'ordre global de saisie de la notation.

Evenement - Notation - Fusion

requires authentication

Fusione une notation d'un événement avec une autre

Example request:

curl -X PATCH \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2/fusion/3" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2/fusion/3"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/2/fusion/3',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 4,
        "trigramme_validation": null,
        "date_validation": null,
        "chemin_personnalise": null,
        "surface_comptage": null,
        "nb_grains_comptage_elementaire": null,
        "aveugle": null,
        "coin_depart": null,
        "saisie_objet": { ... },
        "saisie_ordre": null,
        "saisie_ordre_global": null
    }
}

Request   

PATCH essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{goku:[0-9]+}/fusion/{vegeta:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

goku  integer  
L'identifiant de la notation.

vegeta  integer  
L'identifiant de la notation.

Evenement - Notation - Validation

requires authentication

Revalide une notation d'un événement

Example request:

curl -X PATCH \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2/validation" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2/validation"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/2/validation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 4,
        "trigramme_validation": null,
        "date_validation": null,
        "chemin_personnalise": null,
        "surface_comptage": null,
        "nb_grains_comptage_elementaire": null,
        "aveugle": null,
        "coin_depart": null,
        "saisie_objet": { ... },
        "saisie_ordre": null,
        "saisie_ordre_global": null
    }
}

Request   

PATCH essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{uid:[0-9]+}/validation

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la notation.

Evenement - Notation - Supprimer

requires authentication

Supprime une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la notation.

Evenement - Notation - Trames

requires authentication

Trames d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/trames" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/trames"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/trames',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "labo": [ {
            "microparcelle": { modalite: {} ... },
            "groupe": [ "ORGANE" | "ECHANTILLON" ],
            "variables_etudiees": [ {
                "valeurs": [] | NULL (pour les selects),
                "organes": [ {
                    "nbr_echantillons": n,
                    "note": {
                        "valeur": [ JSON (si grp / organe ou grp / echantillon) | string (si non organe) | NULL (si premier passage) ]
                    }
                } ],
                "echantillon": n | NULL
                "note": { "valeur": "string" | NULL }
            } ]
        } ]
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{uid:[0-9]+}/trames

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la notation.

Evenement - Notation - Données

requires authentication

Données d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/donnees" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/donnees"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/donnees',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [ {
        "valeur": 12,
        "modalite": {},
        "organe": null | {},
        "echantillon": null | int
    } ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{uid:[0-9]+}/donnees

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la notation.

Evenement - Notation - Réservation - Lister

requires authentication

Liste des réservations d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation?sort=nom.ASC%2Cid.DESC&page=1&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "date": "2150-12-31 12:00:00+02",
            "date_validite": "2150-12-31 12:00:00+02",
            "etat": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/reservation

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Notation - Réservation - Voir

requires authentication

Détails d'une réservation d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "date": "2150-12-31 12:00:00+02",
        "date_validite": "2150-12-31 12:00:00+02",
        "etat": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/reservation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la réservation.

Evenement - Notation - Réservation - Ajouter

requires authentication

Ajoute une réservation d'une notation à un événement

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"date":"2150-12-31 12:00:00+02","date_validite":"2150-12-31 12:00:00+02","etat_uid":"e1"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation"
);

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

let body = {
    "date": "2150-12-31 12:00:00+02",
    "date_validite": "2150-12-31 12:00:00+02",
    "etat_uid": "e1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'date' => '2150-12-31 12:00:00+02',
            'date_validite' => '2150-12-31 12:00:00+02',
            'etat_uid' => 'e1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "date": "2150-12-31 12:00:00+02",
        "date_validite": "2150-12-31 12:00:00+02",
        "etat": { ... }
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/reservation

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Body Parameters

date  date  
La date de la réservation.

date_validite  date  
La date de validité de la réservation.

etat_uid  string  
L'identifiant unique de l'état de la réservation.

Evenement - Notation - Réservation - Modifier

requires authentication

Modifie une réservation d'une notation d'un événement

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"date":"2150-12-31 12:00:00+02","date_validite":"2150-12-31 12:00:00+02","etat_uid":"e1"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2"
);

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

let body = {
    "date": "2150-12-31 12:00:00+02",
    "date_validite": "2150-12-31 12:00:00+02",
    "etat_uid": "e1"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'date' => '2150-12-31 12:00:00+02',
            'date_validite' => '2150-12-31 12:00:00+02',
            'etat_uid' => 'e1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "date": "2150-12-31 12:00:00+02",
        "date_validite": "2150-12-31 12:00:00+02",
        "etat": { ... }
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/reservation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la réservation.

Body Parameters

date  date  
La date de la réservation.

date_validite  date  
La date de validité de la réservation.

etat_uid  string  
L'identifiant unique de l'état de la réservation.

Evenement - Notation - Réservation - Supprimer

requires authentication

Supprime une réservation d'une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/reservation/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la réservation.

Evenement - Notation - Réservation - Cloturer

requires authentication

Clôture une réservation d'une notation d'un événement

Example request:

curl -X PATCH \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2/cloture" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2/cloture"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/reservation/2/cloture',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "date": "2150-12-31 12:00:00+02",
        "date_validite": "2150-12-31 12:00:00+02",
        "etat": { ... }
    }
}

Request   

PATCH essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/reservation/{uid:[0-9]+}/cloture

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la réservation.

Evenement - Notation - Variable - Lister

requires authentication

Liste des variables d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee?sort=nom.ASC%2Cid.DESC&page=1&limit=6" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Variable",
            "ordre":1,
            "valeur_min": 0,
            "valeur_max": 12.5,
            "laboratoire": true,
            "variablepersonnalisee": false,
            "type": { ... },
            "variable": { ... },
            "unite": { ... },
            "saisie_niveau": { ... },
            "cible": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Notation - Variable - Voir

requires authentication

Détails d'une variable d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Variable",
        "ordre":1,
        "valeur_min": 0,
        "valeur_max": 12.5,
        "laboratoire": true,
        "variablepersonnalisee": false,
        "type": { ... },
        "variable": { ... },
        "unite": { ... },
        "saisie_niveau": { ... },
        "cible": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la variable étudiée.

Evenement - Notation - Variable - Ajouter

requires authentication

Ajoute une variable d'une notation à un événement

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Variable2","ordre":2,"valeur_min":"0","valeur_max":"42","laboratoire":true,"variablepersonnalisee":true,"type_uid":"t1","variable_uid":"v1","unite_uid":"u1","saisie_niveau_uid":"sn1","cible_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee"
);

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

let body = {
    "designation": "Variable2",
    "ordre": 2,
    "valeur_min": "0",
    "valeur_max": "42",
    "laboratoire": true,
    "variablepersonnalisee": true,
    "type_uid": "t1",
    "variable_uid": "v1",
    "unite_uid": "u1",
    "saisie_niveau_uid": "sn1",
    "cible_id": 0
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Variable2',
            'ordre' => 2,
            'valeur_min' => '0',
            'valeur_max' => '42',
            'laboratoire' => true,
            'variablepersonnalisee' => true,
            'type_uid' => 't1',
            'variable_uid' => 'v1',
            'unite_uid' => 'u1',
            'saisie_niveau_uid' => 'sn1',
            'cible_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Variable2",
        "ordre": 2,
        "valeur_min": 0,
        "valeur_max": 42,
        "laboratoire": true,
        "variablepersonnalisee": true,
        "type": { ... },
        "variable": { ... },
        "unite": { ... },
        "saisie_niveau": { ... },
        "cible": { ... }
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Body Parameters

designation  string optional  
La designation de la variable étudiée.

ordre  integer optional  
L'ordre de la variable étudiée.

valeur_min  numeric optional  
La valeur mininmale de la variable étudiée.

valeur_max  numeric optional  
La valeur maxinmale de la variable étudiée.

laboratoire  boolean  
La provenance laboratoire de la variable étudiée.

variablepersonnalisee  boolean  
La personnalisation de la variable étudiée.

type_uid  string optional  
L'identifiant unique du type de la variable étudiée.

variable_uid  string optional  
L'identifiant unique de la variable associée à variable étudiée.

unite_uid  string optional  
L'identifiant unique de l'unité de la variable étudiée.

saisie_niveau_uid  string  
L'identifiant unique de niveau de saisie de la variable étudiée.

cible_id  integer optional  
L'identifiant de la valeur de référentiel cible.

Evenement - Notation - Variable - Modifier

requires authentication

Modifie une variable d'une notation d'un événement

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"null","ordre":0,"valeur_min":"null","valeur_max":"null","laboratoire":false,"variablepersonnalisee":false,"type_uid":"null","variable_uid":"null","unite_uid":"null","saisie_niveau_uid":"sn1","cible_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/2"
);

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

let body = {
    "designation": "null",
    "ordre": 0,
    "valeur_min": "null",
    "valeur_max": "null",
    "laboratoire": false,
    "variablepersonnalisee": false,
    "type_uid": "null",
    "variable_uid": "null",
    "unite_uid": "null",
    "saisie_niveau_uid": "sn1",
    "cible_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'null',
            'ordre' => 0,
            'valeur_min' => 'null',
            'valeur_max' => 'null',
            'laboratoire' => false,
            'variablepersonnalisee' => false,
            'type_uid' => 'null',
            'variable_uid' => 'null',
            'unite_uid' => 'null',
            'saisie_niveau_uid' => 'sn1',
            'cible_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": null,
        "ordre": 3,
        "valeur_min": null,
        "valeur_max": null,
        "laboratoire": false,
        "variablepersonnalisee": false,
        "type": null,
        "variable": null,
        "unite": null,
        "saisie_niveau": { ... },
        "cible": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la variable étudiée.

Body Parameters

designation  string optional  
La designation de la variable étudiée.

ordre  integer optional  
L'ordre de la variable étudiée.

valeur_min  numeric optional  
La valeur mininmale de la variable étudiée.

valeur_max  numeric optional  
La valeur maxinmale de la variable étudiée.

laboratoire  boolean  
La provenance laboratoire de la variable étudiée.

variablepersonnalisee  boolean  
La personnalisation de la variable étudiée.

type_uid  string optional  
L'identifiant unique du type de la variable étudiée.

variable_uid  string optional  
L'identifiant unique de la variable associée à variable étudiée.

unite_uid  string optional  
L'identifiant unique de l'unité de la variable étudiée.

saisie_niveau_uid  string  
L'identifiant unique de niveau de saisie de la variable étudiée.

cible_id  integer optional  
L'identifiant de la valeur de référentiel cible.

Evenement - Notation - Variable - Supprimer

requires authentication

Supprime une variable d'une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la variable étudiée.

Evenement - Notation - Variable - Note - Lister

requires authentication

Liste des notes des variables d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note?sort=nom.ASC%2Cid.DESC&page=1&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "euid": null,
            "valeur": "12",
            "valeurautre": "test",
            "nonapplicable": false,
            "numeroechantillon": 1,
            "variable": { ... },
            "valeur_liste": { ... },
            "organe": { ... },
            "microparcelle": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/note

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Notation - Variable - Note - Voir

requires authentication

Détails d'une note d'une variable d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "euid": null,
        "valeur": "12",
        "valeurautre": "test",
        "nonapplicable": false,
        "numeroechantillon": 1,
        "variable": { ... },
        "valeur_liste": { ... },
        "organe": { ... },
        "microparcelle": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/note/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la note.

Evenement - Notation - Variable - Note - Ajouter

requires authentication

Ajoute de notes une variable d'une notation à un événement

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"euid":"N42","valeur":"42","valeurautre":"42","nonapplicable":true,"numeroechantillon":1,"variable_id":0,"valeur_liste_id":0,"organe_id":0,"microparcelle_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note"
);

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

let body = {
    "euid": "N42",
    "valeur": "42",
    "valeurautre": "42",
    "nonapplicable": true,
    "numeroechantillon": 1,
    "variable_id": 0,
    "valeur_liste_id": 0,
    "organe_id": 0,
    "microparcelle_id": 0
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'euid' => 'N42',
            'valeur' => '42',
            'valeurautre' => '42',
            'nonapplicable' => true,
            'numeroechantillon' => 1,
            'variable_id' => 0,
            'valeur_liste_id' => 0,
            'organe_id' => 0,
            'microparcelle_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "euid": "N42",
        "valeur": "12",
        "valeurautre": "test",
        "nonapplicable": true,
        "numeroechantillon": 2,
        "variable": { ... },
        "valeur_liste": { ... },
        "organe": { ... },
        "microparcelle": { ... }
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/note

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Body Parameters

euid  string optional  
L'euid de la note.

valeur  numeric optional  
La valeur de la note.

valeurautre  numeric optional  
La valeur de la note.

nonapplicable  boolean optional  
Le charactère non applicapble de la note.

numeroechantillon  integer optional  
Le numero d'échantillon de la note.

variable_id  integer  
L'identifiant de la variable cible.

valeur_liste_id  integer optional  
L'identifiant de la valeur de la note de type liste.

organe_id  integer optional  
L'identifiant de l'organe de la note.

microparcelle_id  integer optional  
L'identifiant de la microparcelle de la note.

Evenement - Notation - Variable - Note - Modifier

requires authentication

Modifie des notes une variable d'une notation d'un événement

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"euid":"null","valeur":"null","valeurautre":"null","nonapplicable":true,"numeroechantillon":0,"variable_id":0,"valeur_liste_id":0,"organe_id":0,"microparcelle_id":0}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note"
);

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

let body = {
    "euid": "null",
    "valeur": "null",
    "valeurautre": "null",
    "nonapplicable": true,
    "numeroechantillon": 0,
    "variable_id": 0,
    "valeur_liste_id": 0,
    "organe_id": 0,
    "microparcelle_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'euid' => 'null',
            'valeur' => 'null',
            'valeurautre' => 'null',
            'nonapplicable' => true,
            'numeroechantillon' => 0,
            'variable_id' => 0,
            'valeur_liste_id' => 0,
            'organe_id' => 0,
            'microparcelle_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "euid": null,
        "valeur": null,
        "valeurautre": null,
        "nonapplicable": null,
        "numeroechantillon": null,
        "variable": { ... },
        "valeur_liste": null,
        "organe": null,
        "microparcelle": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/note

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Body Parameters

euid  string optional  
L'euid de la note.

valeur  numeric optional  
La valeur de la note.

valeurautre  numeric optional  
La valeur de la note.

nonapplicable  boolean optional  
Le charactère non applicapble de la note.

numeroechantillon  integer optional  
Le numero d'échantillon de la note.

variable_id  integer  
L'identifiant de la variable cible.

valeur_liste_id  integer optional  
L'identifiant de la valeur de la note de type liste.

organe_id  integer optional  
L'identifiant de l'organe de la note.

microparcelle_id  integer optional  
L'identifiant de la microparcelle de la note.

Evenement - Notation - Variable - Note - Supprimer

requires authentication

Supprime des notes une variable d'une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"id":2}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note"
);

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

let body = {
    "id": 2
}

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/note

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Body Parameters

id  integer optional  
L'identifiant la note.

Evenement - Notation - Variable - Note - Supprimer tout

requires authentication

Supprime toutes les notes d'une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note/all" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note/all"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/note/all',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/note/all

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Evenement - Notation - Variable - Valeur - Lister

requires authentication

Liste des valeurs d'une variable d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur?sort=nom.ASC%2Cid.DESC&page=18&limit=19" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "18",
    "limit": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '18',
            'limit'=> '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Azertyuiop"
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/valeur

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Notation - Variable - Valeur - Voir

requires authentication

Détails d'une valeur d'une variable d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Azertyuiop"
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de la valeur.

Evenement - Notation - Variable - Valeur - Ajouter

requires authentication

Ajoute une valeur à une variable d'une notation à un événement

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Poiuytreza"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur"
);

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

let body = {
    "designation": "Poiuytreza"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Poiuytreza',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Poiuytreza"
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/valeur

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

Body Parameters

designation  string  
La designation de la valeur.

Evenement - Notation - Variable - Valeur - Modifier

requires authentication

Modifie une valeur d'une variable d'une notation d'un événement

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Nouvelle valeur"}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/2"
);

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

let body = {
    "designation": "Nouvelle valeur"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Nouvelle valeur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Nouvelle valeur"
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de la valeur.

Body Parameters

designation  string  
La designation de la valeur.

Evenement - Notation - Variable - Valeur - Supprimer

requires authentication

Supprime une valeur d'une variable d'une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/valeur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de la valeur.

Evenement - Notation - Variable - Organe - Lister

requires authentication

Liste des organes d'une variable d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie?sort=nom.ASC%2Cid.DESC&page=7&limit=10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Variable",
            "ordre": 1,
            "nb_echantillons": 1
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/niveau_saisie

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Notation - Variable - Organe - Voir

requires authentication

Détails d'un organe d'une variable d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Variable",
        "ordre": 1,
        "nb_echantillons": 1
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/niveau_saisie/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de l'organe.

Evenement - Notation - Variable - Organe - Ajouter

requires authentication

Ajoute un organe à une variable d'une notation à un événement

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Variable2","ordre":2,"nb_echantillons":2}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie"
);

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

let body = {
    "designation": "Variable2",
    "ordre": 2,
    "nb_echantillons": 2
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Variable2',
            'ordre' => 2,
            'nb_echantillons' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Variable2",
        "ordre": 2,
        "nb_echantillons": 2
    }
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/niveau_saisie

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

Body Parameters

designation  required optional  
La designation de la variable étudiée.

ordre  integer  
L'ordre de la variable étudiée.

nb_echantillons  integer  
Le nombre d'echantillons de la variable étudiée.

Evenement - Notation - Variable - Organe - Modifier

requires authentication

Modifie un organe d'une variable d'une notation d'un événement

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Variable3","ordre":3,"nb_echantillons":3}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/2"
);

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

let body = {
    "designation": "Variable3",
    "ordre": 3,
    "nb_echantillons": 3
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Variable3',
            'ordre' => 3,
            'nb_echantillons' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Variable3",
        "ordre": 3,
        "nb_echantillons": 3
    }
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/niveau_saisie/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de l'organe.

Body Parameters

designation  required optional  
La designation de la variable étudiée.

ordre  integer optional  
L'ordre de la variable étudiée.

nb_echantillons  integer  
Le nombre d'echantillons de la variable étudiée.

Evenement - Notation - Variable - Organe - Supprimer

requires authentication

Supprime un organe d'une variable d'une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_etudiee/1/niveau_saisie/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_etudiee/{vuid:[0-9]+}/niveau_saisie/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de l'organe.

Evenement - Notation - Variable calculée - Lister

requires authentication

Liste des variables calculées d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee?sort=nom.ASC%2Cid.DESC&page=16&limit=19" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "calcul": { ... },
            "cible": { ... },
            "parametres": [ ... ]
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_calculee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Notation - Variable calculée - Voir

requires authentication

Détails d'une variable calculée d'une notation d'un événement

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "calcul": { ... },
        "cible": { ... },
        "parametres": [ ... ]
    }
}

Request   

GET essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_calculee/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

uid  integer  
L'identifiant de la variable calculée.

Evenement - Notation - Variable calculée - Ajouter

requires authentication

Ajoute une variable calculée d'une notation à un événement

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"calcul_id":0,"cible_id":0,"parametres":[{"id":1,"valeur":"42.666"},{"id":1}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee"
);

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

let body = {
    "calcul_id": 0,
    "cible_id": 0,
    "parametres": [
        {
            "id": 1,
            "valeur": "42.666"
        },
        {
            "id": 1
        }
    ]
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'calcul_id' => 0,
            'cible_id' => 0,
            'parametres' => [
                [
                    'id' => 1,
                    'valeur' => '42.666',
                ],
                [
                    'id' => 1,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "calcul": { ... },
            "cible": { ... },
            "parametres": [ ... ]
        }
    ]
}

Request   

POST essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_calculee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Body Parameters

calcul_id  integer  
L'identifiant de la variable associée à variable calculée.

cible_id  integer optional  
L'identifiant de la valeur de référentiel cible.

parametres  object[]  
Les paramètres de la variable calculée.

parametres[].id  integer  
Un identifiant de paramétrage existant de variable calculée.

parametres[].valeur  numeric optional  
requiredLa valeur à associer au paramétrage de la variable calculée.

Evenement - Notation - Variable calculée - Modifier

requires authentication

Modifie une variable calculée d'une notation d'un événement

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"calcul_id":0,"cible_id":0,"parametres":[{"id":2,"valeur":"42.666"},{"id":2}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee"
);

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

let body = {
    "calcul_id": 0,
    "cible_id": 0,
    "parametres": [
        {
            "id": 2,
            "valeur": "42.666"
        },
        {
            "id": 2
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'calcul_id' => 0,
            'cible_id' => 0,
            'parametres' => [
                [
                    'id' => 2,
                    'valeur' => '42.666',
                ],
                [
                    'id' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "calcul": { ... },
            "cible": { ... },
            "parametres": [ ... ]
        }
    ]
}

Request   

PUT essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_calculee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Body Parameters

calcul_id  integer  
L'identifiant de la variable associée à variable calculée.

cible_id  integer optional  
L'identifiant de la valeur de référentiel cible.

parametres  object[]  
Les paramètres de la variable calculée.

parametres[].id  integer  
Un identifiant de paramétrage existant de variable calculée.

parametres[].valeur  numeric optional  
requiredLa valeur à associer au paramétrage de la variable calculée.

Evenement - Notation - Variable calculée - Supprimer

requires authentication

Supprime une variable calculée d'une notation d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/evenement/1/fiche/notation/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/evenement/{evuid:[0-9]+}/fiche/notation/{nuid:[0-9]+}/variable_calculee

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Evenement - Notation - Fichier - Export

requires authentication

Première analyse d'un fichier de données

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/evenement/fiche/notation/fichier/export" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/fiche/notation/fichier/export"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/evenement/fiche/notation/fichier/export',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


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

Request   

POST essai/{euid:[0-9]+}/evenement/fiche/notation/fichier/export

URL Parameters

euid  integer  
L'identifiant de l'essai.

evuid  integer  
L'identifiant de l'événement.

nuid  integer  
L'identifiant de la notation.

Evenement - Notation - Variable - Lister

requires authentication

Liste des variables d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/evenement/fiche/notation/variable?sort=nom.ASC%2Cid.DESC&page=8&limit=6" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/evenement/fiche/notation/variable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "8",
    "limit": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/evenement/fiche/notation/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '8',
            'limit'=> '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Variable",
            "ordre":1,
            "valeur_min": 0,
            "valeur_max": 12.5,
            "laboratoire": true,
            "variablepersonnalisee": false,
            "type": { ... },
            "variable": { ... },
            "unite": { ... },
            "saisie_niveau": { ... },
            "cible": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/evenement/fiche/notation/variable

URL Parameters

euid  integer  
L'identifiant de l'essai.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Rapport - Lister

requires authentication

Liste des rapports d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/rapport?sort=nom.ASC%2Cid.DESC&page=8&limit=1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/rapport"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "8",
    "limit": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/rapport',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '8',
            'limit'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Rapport 1",
            "details_erreur": null,
            "date_creation": "2150-12-31 12:00:00+02",
            "date_generation_debut": null,
            "date_generation_fin": null,
            "finalise": false,
            "erreur": false,
            "media": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/rapport

URL Parameters

euid  integer  
L'identifiant de l'essai.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Rapport - Voir

requires authentication

Détails d'un rapport d'un essai

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/rapport/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/rapport/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Rapport 1",
        "details_erreur": null,
        "date_creation": "2150-12-31 12:00:00+02",
        "date_generation_debut": null,
        "date_generation_fin": null,
        "finalise": false,
        "erreur": false,
        "media": { ... }
    }
}

Request   

GET essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Rapport - Ajouter

requires authentication

Ajoute un rapport d'un essai

Example request:

curl -X POST \
    "https://api.oss.coop/essai/1/rapport" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Rapport 2"}'

const url = new URL(
    "https://api.oss.coop/essai/1/rapport"
);

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

let body = {
    "designation": "Rapport 2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/essai/1/rapport',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Rapport 2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Rapport 2",
        "details_erreur": null,
        "date_creation": "2150-12-31 12:00:00+02",
        "date_generation_debut": null,
        "date_generation_fin": null,
        "finalise": false,
        "erreur": false,
        "media": null
    }
}

Request   

POST essai/{euid:[0-9]+}/rapport

URL Parameters

euid  integer  
L'identifiant de l'essai.

Body Parameters

designation  string optional  
La designation du rapport.

Rapport - Modifier

requires authentication

Modifie un rapport d'un essai

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/rapport/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Rapport 3"}'

const url = new URL(
    "https://api.oss.coop/essai/1/rapport/2"
);

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

let body = {
    "designation": "Rapport 3"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/rapport/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Rapport 3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Rapport 3",
        "details_erreur": null,
        "date_creation": "2150-12-31 12:00:00+02",
        "date_generation_debut": null,
        "date_generation_fin": null,
        "finalise": false,
        "erreur": false,
        "media": null
    }
}

Request   

PUT essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Body Parameters

designation  string optional  
La designation du rapport.

Rapport - Supprimer

requires authentication

Supprime un rapport d'un essai

Example request:

curl -X DELETE \
    "https://api.oss.coop/essai/1/rapport/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/rapport/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/essai/1/rapport/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Rapport - Statistiques

requires authentication

Génere les statistiques d'un rapport d'un essai

Example request:

curl -X PATCH \
    "https://api.oss.coop/essai/1/rapport/2/statistiques" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Rapport 3"}'

const url = new URL(
    "https://api.oss.coop/essai/1/rapport/2/statistiques"
);

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

let body = {
    "designation": "Rapport 3"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/essai/1/rapport/2/statistiques',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Rapport 3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Rapport 3",
        "details_erreur": null,
        "date_creation": "2150-12-31 12:00:00+02",
        "date_generation_debut": null,
        "date_generation_fin": null,
        "finalise": false,
        "erreur": false,
        "media": null
    }
}

Request   

PATCH essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/statistiques

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Body Parameters

designation  string optional  
La designation du rapport.

Rapport - Modalites - Lister

requires authentication

Liste des modalités d'un rapport

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/rapport/1/modalite" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/modalite"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/rapport/1/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "numero": "AZERTY123",
            "destruction": false,
            "ordre": 1,
            "type": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/modalite

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Rapport - Modalites - Modifier

requires authentication

Modifie les modalités d'un rapport

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/rapport/1/modalite" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"modalites":[{"id":2},{"id":2}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/modalite"
);

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

let body = {
    "modalites": [
        {
            "id": 2
        },
        {
            "id": 2
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/rapport/1/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'modalites' => [
                [
                    'id' => 2,
                ],
                [
                    'id' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "numero": "AZERTY123",
            "destruction": false,
            "ordre": 1,
            "type": { ... }
        }
    ]
}

Request   

PUT essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/modalite

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Body Parameters

modalites  object[]  
Les modalités du rapport.

modalites[].id  integer  
Un identifiant de modalité existant.

Rapport - Répétitions - Lister

requires authentication

Liste des répétitions d'un rapport

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/rapport/1/repetition" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/repetition"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/rapport/1/repetition',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "repetition": 1
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/repetition

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Rapport - Répétitions - Modifier

requires authentication

Modifie les répétitions d'un rapport

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/rapport/1/repetition" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"repetitions":[{"repetition":2},{"repetition":2}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/repetition"
);

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

let body = {
    "repetitions": [
        {
            "repetition": 2
        },
        {
            "repetition": 2
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/rapport/1/repetition',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'repetitions' => [
                [
                    'repetition' => 2,
                ],
                [
                    'repetition' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "repetition": 2
        }
    ]
}

Request   

PUT essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/repetition

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Body Parameters

repetitions  object[]  
Les répétitions calculées du rapport.

repetitions[].repetition  integer  
Un numéro de répétition.

Rapport - Variables - Lister

requires authentication

Liste des variables d'un rapport

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/rapport/1/variable" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/variable"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/rapport/1/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Variable",
            "ordre":1,
            "valeur_min": 0,
            "valeur_max": 12.5,
            "laboratoire": true,
            "variablepersonnalisee": false,
            "type": { ... },
            "variable": { ... },
            "unite": { ... },
            "saisie_niveau": { ... },
            "cible": { ... }
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/variable

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Rapport - Variables - Modifier

requires authentication

Modifie les variables d'un rapport

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/rapport/1/variable" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variables":[{"id":2},{"id":2}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/variable"
);

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

let body = {
    "variables": [
        {
            "id": 2
        },
        {
            "id": 2
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/rapport/1/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variables' => [
                [
                    'id' => 2,
                ],
                [
                    'id' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "designation": "Variable",
            "ordre":1,
            "valeur_min": 0,
            "valeur_max": 12.5,
            "laboratoire": true,
            "variablepersonnalisee": false,
            "type": { ... },
            "variable": { ... },
            "unite": { ... },
            "saisie_niveau": { ... },
            "cible": { ... }
        }
    ]
}

Request   

PUT essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/variable

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Body Parameters

variables  object[]  
Les variables du rapport.

variables[].id  integer  
Un identifiant de variable de notation existant.

Rapport - Variables Calculées - Lister

requires authentication

Liste des variables calculées d'un rapport

Example request:

curl -X GET \
    -G "https://api.oss.coop/essai/1/rapport/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/variable_calculee"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/essai/1/rapport/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "calcul": { ... },
            "cible": null,
            "parametres": [ ... ]
        }
    ]
}

Request   

GET essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/variable_calculee

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Rapport - Variables Calculées - Modifier

requires authentication

Modifie les variables calculées d'un rapport

Example request:

curl -X PUT \
    "https://api.oss.coop/essai/1/rapport/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variables_calculees":[{"id":2},{"id":2}]}'

const url = new URL(
    "https://api.oss.coop/essai/1/rapport/1/variable_calculee"
);

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

let body = {
    "variables_calculees": [
        {
            "id": 2
        },
        {
            "id": 2
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/essai/1/rapport/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variables_calculees' => [
                [
                    'id' => 2,
                ],
                [
                    'id' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "calcul": { ... },
            "cible": null,
            "parametres": [ ... ]
        }
    ]
}

Request   

PUT essai/{euid:[0-9]+}/rapport/{uid:[0-9]+}/variable_calculee

URL Parameters

euid  integer  
L'identifiant de l'essai.

uid  integer  
L'identifiant du rapport.

Body Parameters

variables_calculees  object[]  
Les variables calculées du rapport.

variables_calculees[].id  integer  
Un identifiant de variable calculée de notation existant.

Etiquettes

Modele - Lister

requires authentication

Liste des modeles d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/etiquette/modele?sort=nom.ASC%2Cid.DESC&page=10&limit=9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/etiquette/modele"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "10",
    "limit": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/etiquette/modele',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '10',
            'limit'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "valeur",
            "type": { ... },
            "gabarit": { ... }
        }
    ]
}

Request   

GET etiquette/modele

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Modele - Voir

requires authentication

Détails d'un modele d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/etiquette/modele/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/etiquette/modele/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/etiquette/modele/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "valeur",
        "type": { ... },
        "gabarit": { ... }
    }
}

Request   

GET etiquette/modele/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du modele d'étiquettes.

Modele - Ajouter

requires authentication

Ajoute un modele d'étiquettes

Example request:

curl -X POST \
    "https://api.oss.coop/etiquette/modele" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"valeur2","type_uid":"type1","gabarit_uid":"gabarit1"}'

const url = new URL(
    "https://api.oss.coop/etiquette/modele"
);

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

let body = {
    "nom": "valeur2",
    "type_uid": "type1",
    "gabarit_uid": "gabarit1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/etiquette/modele',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'valeur2',
            'type_uid' => 'type1',
            'gabarit_uid' => 'gabarit1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "valeur",
        "type": { ... },
        "gabarit": { ... }
    }
}

Request   

POST etiquette/modele

Body Parameters

nom  string  
Le nom du modele d'étiquettes.

type_uid  string  
L'identifiant unique du type du modele d'étiquettes.

gabarit_uid  string optional  
L'identifiant unique du gabarit du modele d'étiquettes.

Modele - Modifier

requires authentication

Modifie un modele d'étiquettes

Example request:

curl -X PUT \
    "https://api.oss.coop/etiquette/modele/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"valeur2","type_uid":"type1","gabarit_uid":"null"}'

const url = new URL(
    "https://api.oss.coop/etiquette/modele/2"
);

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

let body = {
    "nom": "valeur2",
    "type_uid": "type1",
    "gabarit_uid": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/etiquette/modele/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'valeur2',
            'type_uid' => 'type1',
            'gabarit_uid' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "valeur",
        "type": { ... },
        "gabarit": null
    }
}

Request   

PUT etiquette/modele/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du modele d'étiquettes.

Body Parameters

nom  string  
Le nom du modele d'étiquettes.

type_uid  string  
L'identifiant unique du type du modele d'étiquettes.

gabarit_uid  string optional  
L'identifiant unique du gabarit du modele d'étiquettes.

Modele - Supprimer

requires authentication

Supprime un modele d'étiquettes

Example request:

curl -X DELETE \
    "https://api.oss.coop/etiquette/modele/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/etiquette/modele/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/etiquette/modele/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE etiquette/modele/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du modele d'étiquettes.

Fichiers

Lister

requires authentication

Liste des fichiers

Example request:

curl -X GET \
    -G "https://api.oss.coop/fichier?sort=nom.ASC%2Cid.DESC&page=6&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fichier"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "description": "valeur",
            "categorie": { ... },
            "media": { ... }
        }
    ]
}

Request   

GET fichier

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un fichier

Example request:

curl -X GET \
    -G "https://api.oss.coop/fichier/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fichier/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/fichier/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "description": "valeur",
        "categorie": { ... },
        "media": { ... }
    }
}

Request   

GET fichier/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du fichier.

Ajouter

requires authentication

Ajoute un fichier

Example request:

curl -X POST \
    "https://api.oss.coop/fichier" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"description":"valeur2","categorie_id":1,"media_id":1}'

const url = new URL(
    "https://api.oss.coop/fichier"
);

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

let body = {
    "description": "valeur2",
    "categorie_id": 1,
    "media_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'description' => 'valeur2',
            'categorie_id' => 1,
            'media_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "description": "valeur2",
        "categorie": { ... },
        "media": { ... }
    }
}

Request   

POST fichier

Body Parameters

description  string  
La description du fichier.

categorie_id  integer optional  
L'identifiant de la categorie du fichier.

media_id  integer  
L'identifiant du média associé au fichier.

Modifier

requires authentication

Modifie un fichier

Example request:

curl -X PUT \
    "https://api.oss.coop/fichier/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"description":"valeur3","categorie_id":2,"media_id":2}'

const url = new URL(
    "https://api.oss.coop/fichier/2"
);

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

let body = {
    "description": "valeur3",
    "categorie_id": 2,
    "media_id": 2
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/fichier/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'description' => 'valeur3',
            'categorie_id' => 2,
            'media_id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "description": "valeur3",
        "categorie": { ... },
        "media": { ... }
    }
}

Request   

PUT fichier/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du fichier.

Body Parameters

description  string  
La description du fichier.

categorie_id  integer optional  
L'identifiant de la categorie du fichier.

media_id  integer  
L'identifiant du média associé au fichier.

Supprimer

requires authentication

Supprime un fichier

Example request:

curl -X DELETE \
    "https://api.oss.coop/fichier/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fichier/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/fichier/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE fichier/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du fichier.

Fournisseur

Lister

requires authentication

Liste des fournisseurs

Example request:

curl -X GET \
    -G "https://api.oss.coop/fournisseur?sort=nom.ASC%2Cid.DESC&page=15&limit=8" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fournisseur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "15",
    "limit": "8",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/fournisseur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '15',
            'limit'=> '8',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "nom": "nom",
            "thematiques": [ ... ]
        }
    ]
}

Request   

GET fournisseur

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un fournisseur

Example request:

curl -X GET \
    -G "https://api.oss.coop/fournisseur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fournisseur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/fournisseur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "nom": "nom",
        "thematiques": [ ... ]
    }
}

Request   

GET fournisseur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du fournisseur.

Ajouter

requires authentication

Ajoute un fournisseur

Example request:

curl -X POST \
    "https://api.oss.coop/fournisseur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","nom":"nom2","thematiques":[{"uid":"1"},{"uid":"1"}]}'

const url = new URL(
    "https://api.oss.coop/fournisseur"
);

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

let body = {
    "uid": "id_unique_universel2",
    "nom": "nom2",
    "thematiques": [
        {
            "uid": "1"
        },
        {
            "uid": "1"
        }
    ]
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/fournisseur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'nom' => 'nom2',
            'thematiques' => [
                [
                    'uid' => '1',
                ],
                [
                    'uid' => '1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "nom": "nom2",
        "thematiques": [ ... ]
    }
}

Request   

POST fournisseur

Body Parameters

uid  string  
L'identifiant unique du fournisseur.

nom  string  
Le nom du fournisseur.

thematiques  object[]  
Les thematiques du fournisseur.

thematiques[].uid  string optional  
Un identifiant unique de thematique existant.

Modifier

requires authentication

Modifie un fournisseur

Example request:

curl -X PUT \
    "https://api.oss.coop/fournisseur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","nom":"nom3","thematiques":[{"uid":"1"},{"uid":"1"}]}'

const url = new URL(
    "https://api.oss.coop/fournisseur/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "nom": "nom3",
    "thematiques": [
        {
            "uid": "1"
        },
        {
            "uid": "1"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/fournisseur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'nom' => 'nom3',
            'thematiques' => [
                [
                    'uid' => '1',
                ],
                [
                    'uid' => '1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "nom": "nom3",
        "thematiques": [ ... ]
    }
}

Request   

PUT fournisseur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du fournisseur.

Body Parameters

uid  string  
L'identifiant unique du fournisseur.

nom  string  
Le nom du fournisseur.

thematiques  object[]  
Les thematiques du fournisseur.

thematiques[].uid  string optional  
Un identifiant unique de thematique existant.

Supprimer

requires authentication

Supprime un fournisseur

Example request:

curl -X DELETE \
    "https://api.oss.coop/fournisseur/13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fournisseur/13"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/fournisseur/13',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE fournisseur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant dU fournisseur.

Contact - Lister

requires authentication

Liste des contacts d'un fournisseur

Example request:

curl -X GET \
    -G "https://api.oss.coop/fournisseur/1/contact?sort=nom.ASC%2Cid.DESC&page=14&limit=8" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fournisseur/1/contact"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "8",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/fournisseur/1/contact',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '8',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "nom",
            "prenom": "prenom",
            "fonction": "fonction",
            "email": "email",
            "telephonefixe": "0123456789",
            "telephoneportable": "0607123456",
            "telephoneentreprise": "0123456789",
            "remarques": "remarques",
            "actif": true,
            "fournisseur": { ... }
        }
    ]
}

Request   

GET fournisseur/{fuid:[0-9]+}/contact

URL Parameters

fuid  integer  
L'identifiant du fournisseur.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Contact - Voir

requires authentication

Détails d'un contact d'un fournisseur

Example request:

curl -X GET \
    -G "https://api.oss.coop/fournisseur/1/contact/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fournisseur/1/contact/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/fournisseur/1/contact/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "nom",
        "prenom": "prenom",
        "fonction": "fonction",
        "email": "n.prenom@societe.com",
        "telephonefixe": "0123456789",
        "telephoneportable": "0607123456",
        "telephoneentreprise": "0123456789",
        "remarques": "remarques",
        "actif": true,
        "fournisseur": { ... }
    }
}

Request   

GET fournisseur/{fuid:[0-9]+}/contact/{uid:[0-9]+}

URL Parameters

fuid  integer  
L'identifiant du fournisseur.

uid  integer  
L'identifiant du contact.

Contact - Ajouter

requires authentication

Ajoute un contact à un fournisseur

Example request:

curl -X POST \
    "https://api.oss.coop/fournisseur/1/contact" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"nom2","prenom":"prenom2","fonction":"fonction2","email":"n2.prenom2@societe.com","telephonefixe":"0123456789","telephoneportable":"0607123456","telephoneentreprise":"0123456789","remarques":"remarques2","actif":true}'

const url = new URL(
    "https://api.oss.coop/fournisseur/1/contact"
);

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

let body = {
    "nom": "nom2",
    "prenom": "prenom2",
    "fonction": "fonction2",
    "email": "n2.prenom2@societe.com",
    "telephonefixe": "0123456789",
    "telephoneportable": "0607123456",
    "telephoneentreprise": "0123456789",
    "remarques": "remarques2",
    "actif": true
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/fournisseur/1/contact',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'nom2',
            'prenom' => 'prenom2',
            'fonction' => 'fonction2',
            'email' => 'n2.prenom2@societe.com',
            'telephonefixe' => '0123456789',
            'telephoneportable' => '0607123456',
            'telephoneentreprise' => '0123456789',
            'remarques' => 'remarques2',
            'actif' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "nom2",
        "prenom": "prenom2",
        "fonction": "fonction2",
        "email": "n2.prenom2@societe.com",
        "telephonefixe": "0123456789",
        "telephoneportable": "0607123456",
        "telephoneentreprise": "0123456789",
        "remarques": "remarques2",
        "actif": true,
        "fournisseur": { ... }
    }
}

Request   

POST fournisseur/{fuid:[0-9]+}/contact

URL Parameters

fuid  integer  
L'identifiant du fournisseur.

Body Parameters

nom  string  
Le nom du contact.

prenom  string  
Le prenom du contact.

fonction  string optional  
La fonction du contact.

email  string  
L'email du contact.

telephonefixe  string optional  
Le numéro de téléphone fixe du contact.

telephoneportable  string optional  
Le numéro de téléphone portable du contact.

telephoneentreprise  string optional  
Le numéro de téléphone de l'entreprise du contact.

remarques  string optional  
Les remarques sur le contact.

actif  boolean optional  
Si le contact est actif. Défaut à true

Contact - Modifier

requires authentication

Modifie un contact d'un fournisseur

Example request:

curl -X PUT \
    "https://api.oss.coop/fournisseur/1/contact/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"nom3","prenom":"prenom3","fonction":"null","email":"n3.prenom3@societe.com","telephonefixe":"null","telephoneportable":"null","telephoneentreprise":"null","remarques":"null","actif":true}'

const url = new URL(
    "https://api.oss.coop/fournisseur/1/contact/2"
);

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

let body = {
    "nom": "nom3",
    "prenom": "prenom3",
    "fonction": "null",
    "email": "n3.prenom3@societe.com",
    "telephonefixe": "null",
    "telephoneportable": "null",
    "telephoneentreprise": "null",
    "remarques": "null",
    "actif": true
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/fournisseur/1/contact/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'nom3',
            'prenom' => 'prenom3',
            'fonction' => 'null',
            'email' => 'n3.prenom3@societe.com',
            'telephonefixe' => 'null',
            'telephoneportable' => 'null',
            'telephoneentreprise' => 'null',
            'remarques' => 'null',
            'actif' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "nom3",
        "prenom": "prenom3",
        "fonction": null,
        "email": "n3.prenom3@societe.com",
        "telephonefixe": null,
        "telephoneportable": null,
        "telephoneentreprise": null,
        "remarques": null,
        "actif": true,
        "fournisseur": { ... }
    }
}

Request   

PUT fournisseur/{fuid:[0-9]+}/contact/{uid:[0-9]+}

URL Parameters

fuid  integer  
L'identifiant du fournisseur.

uid  integer  
L'identifiant du contact.

Body Parameters

nom  string  
Le nom du contact.

prenom  string  
Le prenom du contact.

fonction  string optional  
La fonction du contact.

email  string  
L'email du contact.

telephonefixe  string optional  
Le numéro de téléphone fixe du contact.

telephoneportable  string optional  
Le numéro de téléphone portable du contact.

telephoneentreprise  string optional  
Le numéro de téléphone de l'entreprise du contact.

remarques  string optional  
Les remarques sur le contact.

actif  boolean optional  
Si le contact est actif. Défaut à true

Contact - Supprimer

requires authentication

Supprime un contact d'un fournisseur

Example request:

curl -X DELETE \
    "https://api.oss.coop/fournisseur/1/contact/7" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/fournisseur/1/contact/7"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/fournisseur/1/contact/7',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE fournisseur/{fuid:[0-9]+}/contact/{uid:[0-9]+}

URL Parameters

fuid  integer  
L'identifiant du fournisseur.

uid  integer  
L'identifiant du contact.

Internal

interne/{user_id:[0-9]+}/donnees/{type:notation|variable|rapport}/{uid:[0-9]+}

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/interne/{user_id:[0-9]+}/donnees/{type:notation|variable|rapport}/{uid:[0-9]+}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/interne/{user_id:[0-9]+}/donnees/{type:notation|variable|rapport}/{uid:[0-9]+}"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/interne/{user_id:[0-9]+}/donnees/{type:notation|variable|rapport}/{uid:[0-9]+}',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET interne/{user_id:[0-9]+}/donnees/{type:notation|variable|rapport}/{uid:[0-9]+}

interne/{user_id:[0-9]+}/resultats/variable_calculee/{uid:[0-9]+}/microparcelle/{muid:[0-9]+}

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/interne/{user_id:[0-9]+}/resultats/variable_calculee/{uid:[0-9]+}/microparcelle/{muid:[0-9]+}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/interne/{user_id:[0-9]+}/resultats/variable_calculee/{uid:[0-9]+}/microparcelle/{muid:[0-9]+}"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/interne/{user_id:[0-9]+}/resultats/variable_calculee/{uid:[0-9]+}/microparcelle/{muid:[0-9]+}',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET interne/{user_id:[0-9]+}/resultats/variable_calculee/{uid:[0-9]+}/microparcelle/{muid:[0-9]+}

interne/{user_id:[0-9]+}/export/{type:[a-z]+}/{ressource:[a-zA-Z-]+}/{rid:[0-9]+}[/{child_ressource:[a-zA-Z-]+}]

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/interne/{user_id:[0-9]+}/export/{type:[a-z]+}/{ressource:[a-zA-Z-]+}/{rid:[0-9]+}[/{child_ressource:[a-zA-Z-]+}]" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/interne/{user_id:[0-9]+}/export/{type:[a-z]+}/{ressource:[a-zA-Z-]+}/{rid:[0-9]+}[/{child_ressource:[a-zA-Z-]+}]"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/interne/{user_id:[0-9]+}/export/{type:[a-z]+}/{ressource:[a-zA-Z-]+}/{rid:[0-9]+}[/{child_ressource:[a-zA-Z-]+}]',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET interne/{user_id:[0-9]+}/export/{type:[a-z]+}/{ressource:[a-zA-Z-]+}/{rid:[0-9]+}[/{child_ressource:[a-zA-Z-]+}]

Logs

Lister

requires authentication

Liste des logs

Example request:

curl -X GET \
    -G "https://api.oss.coop/log?sort=nom.ASC%2Cid.DESC&page=6&limit=16" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/log"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/log',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "type": {
                "id": 1,
                "uid": "CREATE",
                "designation": "Création"
            },
            "date": "2021-04-18 21:00:12",
            "objet": "{ \"id\": 2, \"uid\": \"id_unique_universel2\", \"designation\": \"valeur2\" }",
            "ressource": "profil",
            "ressource_id": "2",
            "ressource_secondaire_id": ""
        }
    ]
}

Request   

GET log

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un log

Example request:

curl -X GET \
    -G "https://api.oss.coop/log/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/log/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/log/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "type": {
            "id": 1,
            "uid": "CREATE",
            "designation": "Création"
        },
        "date": "2021-04-18 21:00:12",
            "objet": "{ \"id\": 2, \"uid\": \"id_unique_universel2\", \"designation\": \"valeur2\" }",
        "ressource": "profil",
        "ressource_id": "2",
        "ressource_secondaire_id": ""
    }
}

Request   

GET log/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du log.

Noms Commerciaux

Lister

requires authentication

Liste des noms commerciaux

Example request:

curl -X GET \
    -G "https://api.oss.coop/nom_commercial?sort=nom.ASC%2Cid.DESC&page=5&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/nom_commercial"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/nom_commercial',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "produit",
            "code_ean13": "barcode",
            "code_interne": "produit42",
            "fournisseur": { ... }
        }
    ]
}

Request   

GET nom_commercial

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un nom commercial

Example request:

curl -X GET \
    -G "https://api.oss.coop/nom_commercial/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/nom_commercial/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/nom_commercial/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "nom": "produit",
        "code_ean13": "barcode",
        "code_interne": "produit42",
        "fournisseur": { ... }
    }
}

Request   

GET nom_commercial/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du nom commercial.

Ajouter

requires authentication

Ajoute un nom commercial

Example request:

curl -X POST \
    "https://api.oss.coop/nom_commercial" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"produit2","code_ean13":"facilis","code_interne":"repellendus","produit_id":1,"fournisseur_uid":1}'

const url = new URL(
    "https://api.oss.coop/nom_commercial"
);

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

let body = {
    "nom": "produit2",
    "code_ean13": "facilis",
    "code_interne": "repellendus",
    "produit_id": 1,
    "fournisseur_uid": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/nom_commercial',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'produit2',
            'code_ean13' => 'facilis',
            'code_interne' => 'repellendus',
            'produit_id' => 1,
            'fournisseur_uid' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "produit2",
        "code_ean13": null,
        "code_interne": null,
        "fournisseur": { ... }
    }
}

Request   

POST nom_commercial

Body Parameters

nom  string optional  
Le nom commercial du produit lié.

code_ean13  string optional  
Le code barre du produit lié.

code_interne  string  
Le code OSS du produit lié.

produit_id  integer  
L'identifiant unique du produit lié.

fournisseur_uid  integer  
L'identifiant unique du fournisseur associé au nom commercial.

Modifier

requires authentication

Modifie un nom commercial

Example request:

curl -X PUT \
    "https://api.oss.coop/nom_commercial/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"produit2","code_ean13":"barcode2","code_interne":"OSS42","produit_id":1,"fournisseur_uid":1}'

const url = new URL(
    "https://api.oss.coop/nom_commercial/2"
);

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

let body = {
    "nom": "produit2",
    "code_ean13": "barcode2",
    "code_interne": "OSS42",
    "produit_id": 1,
    "fournisseur_uid": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/nom_commercial/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'produit2',
            'code_ean13' => 'barcode2',
            'code_interne' => 'OSS42',
            'produit_id' => 1,
            'fournisseur_uid' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "produit2",
        "code_ean13": "barcode2",
        "code_interne": "OSS42",
        "fournisseur": { ... }
    }
}

Request   

PUT nom_commercial/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du nom commercial.

Body Parameters

nom  string optional  
Le nom commercial du produit lié.

code_ean13  string optional  
Le code barre du produit lié.

code_interne  string  
Le code OSS du produit lié.

produit_id  integer  
L'identifiant unique du produit lié.

fournisseur_uid  integer  
L'identifiant unique du fournisseur associé au nom commercial.

Supprimer

requires authentication

Supprime un nom commercial

Example request:

curl -X DELETE \
    "https://api.oss.coop/nom_commercial/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/nom_commercial/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/nom_commercial/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE nom_commercial/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du nom commercial.

Parcelles

Lister

requires authentication

Liste des parcelles

Example request:

curl -X GET \
    -G "https://api.oss.coop/parcelle?sort=nom.ASC%2Cid.DESC&page=4&limit=1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/parcelle"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "4",
    "limit": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/parcelle',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '4',
            'limit'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Diatem",
            "adresse": "2 Rue de Dublin",
            "cp": "67300",
            "ville": "SCHILTIGHEIM",
            "latitude": "48.612769045719666",
            "longitude": "7.710393441008134",
            "nom_agriculteur": "Mathieu",
            "tel": "0123456789",
            "email": "dev@diatem.net",
            "cpmeteo": "67000",
            "villemeteo": "Strasbourg",
            "plateforme": false,
            "media": { ... }
        }
    ]
}

Request   

GET parcelle

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'une parcelle

Example request:

curl -X GET \
    -G "https://api.oss.coop/parcelle/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/parcelle/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/parcelle/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Diatem",
        "adresse": "2 Rue de Dublin",
        "cp": "67300",
        "ville": "SCHILTIGHEIM",
        "latitude": "48.612769045719666",
        "longitude": "7.710393441008134",
        "nom_agriculteur": "Mathieu",
        "tel": "0123456789",
        "email": "dev@diatem.net",
        "cpmeteo": "67000",
        "villemeteo": "Strasbourg",
        "plateforme": false,
        "media": { ... }
    }
}

Request   

GET parcelle/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la parcelle.

Ajouter

requires authentication

Ajoute une parcelle

Example request:

curl -X POST \
    "https://api.oss.coop/parcelle" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Enfer","adresse":"42 rue Pacool","cp":"42666","ville":"DIATEM","latitude":"48.612769045719666","longitude":"7.710393441008134","nom_agriculteur":"Lo\u00efc","tel":"0123456789","email":"lgerard@diatem.net","cpmeteo":"67000","villemeteo":"Strasbourg","plateforme":false,"media_id":1}'

const url = new URL(
    "https://api.oss.coop/parcelle"
);

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

let body = {
    "designation": "Enfer",
    "adresse": "42 rue Pacool",
    "cp": "42666",
    "ville": "DIATEM",
    "latitude": "48.612769045719666",
    "longitude": "7.710393441008134",
    "nom_agriculteur": "Lo\u00efc",
    "tel": "0123456789",
    "email": "lgerard@diatem.net",
    "cpmeteo": "67000",
    "villemeteo": "Strasbourg",
    "plateforme": false,
    "media_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/parcelle',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Enfer',
            'adresse' => '42 rue Pacool',
            'cp' => '42666',
            'ville' => 'DIATEM',
            'latitude' => '48.612769045719666',
            'longitude' => '7.710393441008134',
            'nom_agriculteur' => 'Loïc',
            'tel' => '0123456789',
            'email' => 'lgerard@diatem.net',
            'cpmeteo' => '67000',
            'villemeteo' => 'Strasbourg',
            'plateforme' => false,
            'media_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Enfer",
        "adresse": "42 rue Pacool",
        "cp": "42666",
        "ville": "DIATEM",
        "latitude": "48.612769045719666",
        "longitude": "7.710393441008134",
        "nom_agriculteur": "Loïc",
        "tel": "0123456789",
        "email": "lgerard@diatem.net",
        "cpmeteo": "67000",
        "villemeteo": "Strasbourg",
        "plateforme": false,
        "media": { ... }
    }
}

Request   

POST parcelle

Body Parameters

designation  string  
La designation de la parcelle.

adresse  string optional  
L'adresse de la parcelle.

cp  string optional  
Le code postal de la parcelle.

ville  string optional  
La ville de la parcelle.

latitude  string optional  
La latitude de la parcelle.

longitude  string optional  
La longitude de la parcelle.

nom_agriculteur  string optional  
Le nom de l'agriculteur de la parcelle.

tel  string optional  
La numéro de téléphone associé à la parcelle.

email  string optional  
L'email de contact associé à la parcelle.

cpmeteo  string optional  
Le code postal des données météo de la parcelle.

villemeteo  string optional  
La ville des données météo de la parcelle.

plateforme  boolean optional  
La plateforme de la parcelle.

media_id  integer optional  
Le média associé à la parcelle.

Modifier

requires authentication

Modifie une parcelle

Example request:

curl -X PUT \
    "https://api.oss.coop/parcelle/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Enfer","adresse":"null","cp":"null","ville":"null","latitude":"null","longitude":"null","nom_agriculteur":"null","tel":"null","email":"null","cpmeteo":"null","villemeteo":"null","plateforme":true,"media_id":0}'

const url = new URL(
    "https://api.oss.coop/parcelle/2"
);

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

let body = {
    "designation": "Enfer",
    "adresse": "null",
    "cp": "null",
    "ville": "null",
    "latitude": "null",
    "longitude": "null",
    "nom_agriculteur": "null",
    "tel": "null",
    "email": "null",
    "cpmeteo": "null",
    "villemeteo": "null",
    "plateforme": true,
    "media_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/parcelle/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Enfer',
            'adresse' => 'null',
            'cp' => 'null',
            'ville' => 'null',
            'latitude' => 'null',
            'longitude' => 'null',
            'nom_agriculteur' => 'null',
            'tel' => 'null',
            'email' => 'null',
            'cpmeteo' => 'null',
            'villemeteo' => 'null',
            'plateforme' => true,
            'media_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Enfer",
        "adresse": null,
        "cp": null,
        "ville": null,
        "latitude": null,
        "longitude": null,
        "nom_agriculteur": null,
        "tel": null,
        "email": null,
        "cpmeteo": null,
        "villemeteo": null,
        "plateforme": null,
        "media": null
    }
}

Request   

PUT parcelle/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la parcelle.

Body Parameters

designation  string  
La designation de la parcelle.

adresse  string optional  
L'adresse de la parcelle.

cp  string optional  
Le code postal de la parcelle.

ville  string optional  
La ville de la parcelle.

latitude  string optional  
La latitude de la parcelle.

longitude  string optional  
La longitude de la parcelle.

nom_agriculteur  string optional  
Le nom de l'agriculteur de la parcelle.

tel  string optional  
La numéro de téléphone associé à la parcelle.

email  string optional  
L'email de contact associé à la parcelle.

cpmeteo  string optional  
Le code postal des données météo de la parcelle.

villemeteo  string optional  
La ville des données météo de la parcelle.

plateforme  boolean optional  
La plateforme de la parcelle.

media_id  integer optional  
Le média associé à la parcelle.

Supprimer

requires authentication

Supprime une parcelle

Example request:

curl -X DELETE \
    "https://api.oss.coop/parcelle/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/parcelle/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/parcelle/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE parcelle/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la parcelle.

Fiche - Lister

requires authentication

Liste des fiches d'une parcelle

Example request:

curl -X GET \
    -G "https://api.oss.coop/parcelle/1/fiche?sort=nom.ASC%2Cid.DESC&page=14&limit=18" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/parcelle/1/fiche"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "18",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/parcelle/1/fiche',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '18',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "variete": "Développeur",
            "exposition": "Non",
            "situation_particuliere": "Télétravail",
            "conditionssemis": "Paslaforme",
            "fumure_mineraux_date": "2150-12-31 12:00:00+02",
            "fumure_mineraux_produits": "Cailloux",
            "fumure_organique_date": "2150-12-31 12:00:00+02",
            "fumure_organique_produits": "Pas cailloux",
            "fumure_calcaire_date": "2150-12-31 12:00:00+02",
            "fumure_calcaire_produits": "Cailloux aussi",
            "fumure_oligo_date": "2150-12-31 12:00:00+02",
            "fumure_oligo_produits": "Pas cailloux non plus",
            "protection_herbicides_date": "2150-12-31 12:00:00+02",
            "protection_herbicides_produits": "Tuelesol",
            "protection_fongicides_date": "2150-12-31 12:00:00+02",
            "protection_fongicides_produits": "Tuelesbestioles",
            "protection_inscticides_date": "2150-12-31 12:00:00+02",
            "protection_insecticides_produits": "Tuelesbestiolesaussimaispaslesmemes",
            "protection_regulateurs_date": "2150-12-31 12:00:00+02",
            "protection_regulateurs_produits": "Tuedestrucs?",
            "protection_autres_date": "2150-12-31 12:00:00+02",
            "protection_autres_produits": "Tuelereste",
            "argile": "42",
            "limon": "42",
            "sable": "42",
            "ecartement_rangs": "42",
            "objectifs_rendement": "42",
            "densitesemis": "42",
            "sensibilite_secheresse": true,
            "sensibilite_exces_eau": true,
            "irrigation": true,
            "drainage": true,
            "sol_en_pente": true,
            "cultureproduction": true,
            "analyse_sol_dispo": true,
            "date_analyse_sol": "2150-12-31 12:00:00+02",
            "date_semis": "2150-12-31 12:00:00+02",
            "date_levee": "2150-12-31 12:00:00+02",
            "unite": { ... },
            "culture": { ... },
            "culture_precedante": { ... },
            "cailloux": { ... },
            "reserve_utile": { ... },
            "densite_semis": { ... },
            "sol_type": { ... },
            "sol_profondeur": { ... },
            "sol_travail": { ... }
        }
    ]
}

Request   

GET parcelle/{puid:[0-9]+}/fiche

URL Parameters

puid  integer  
L'identifiant de la parcelle.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Fiche - Voir

requires authentication

Détails d'une fiche d'une parcelle

Example request:

curl -X GET \
    -G "https://api.oss.coop/parcelle/1/fiche/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/parcelle/1/fiche/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/parcelle/1/fiche/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "variete": "Développeur",
        "exposition": "Non",
        "situation_particuliere": "Télétravail",
        "conditionssemis": "Paslaforme",
        "fumure_mineraux_date": "2150-12-31 12:00:00+02",
        "fumure_mineraux_produits": "Cailloux",
        "fumure_organique_date": "2150-12-31 12:00:00+02",
        "fumure_organique_produits": "Pas cailloux",
        "fumure_calcaire_date": "2150-12-31 12:00:00+02",
        "fumure_calcaire_produits": "Cailloux aussi",
        "fumure_oligo_date": "2150-12-31 12:00:00+02",
        "fumure_oligo_produits": "Pas cailloux non plus",
        "protection_herbicides_date": "2150-12-31 12:00:00+02",
        "protection_herbicides_produits": "Tuelesol",
        "protection_fongicides_date": "2150-12-31 12:00:00+02",
        "protection_fongicides_produits": "Tuelesbestioles",
        "protection_inscticides_date": "2150-12-31 12:00:00+02",
        "protection_insecticides_produits": "Tuelesbestiolesaussimaispaslesmemes",
        "protection_regulateurs_date": "2150-12-31 12:00:00+02",
        "protection_regulateurs_produits": "Tuedestrucs?",
        "protection_autres_date": "2150-12-31 12:00:00+02",
        "protection_autres_produits": "Tuelereste",
        "argile": "42",
        "limon": "42",
        "sable": "42",
        "ecartement_rangs": "42",
        "objectifs_rendement": "42",
        "densitesemis": "42",
        "sensibilite_secheresse": true,
        "sensibilite_exces_eau": true,
        "irrigation": true,
        "drainage": true,
        "sol_en_pente": true,
        "cultureproduction": true,
        "analyse_sol_dispo": true,
        "date_analyse_sol": "2150-12-31 12:00:00+02",
        "date_semis": "2150-12-31 12:00:00+02",
        "date_levee": "2150-12-31 12:00:00+02",
        "unite": { ... },
        "culture": { ... },
        "culture_precedante": { ... },
        "cailloux": { ... },
        "reserve_utile": { ... },
        "densite_semis": { ... },
        "sol_type": { ... },
        "sol_profondeur": { ... },
        "sol_travail": { ... }
    }
}

Request   

GET parcelle/{puid:[0-9]+}/fiche/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant de la parcelle.

uid  integer  
L'identifiant de la fiche.

Fiche - Modifier

requires authentication

Modifie une fiche d'une parcelle

Example request:

curl -X PUT \
    "https://api.oss.coop/parcelle/1/fiche/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variete":"null","exposition":"null","situation_particuliere":"null","conditionssemis":"null","fumure_mineraux_date":"null","fumure_mineraux_produits":"null","fumure_organique_date":"null","fumure_organique_produits":"null","fumure_calcaire_date":"null","fumure_calcaire_produits":"null","fumure_oligo_date":"null","fumure_oligo_produits":"null","protection_herbicides_date":"null","protection_herbicides_produits":"null","protection_fongicides_date":"null","protection_inscticides_date":"null","protection_insecticides_produits":"null","protection_regulateurs_date":"null","protection_regulateurs_produits":"null","protection_autres_date":"null","protection_autres_produits":"null","argile":"null","limon":"null","sable":"null","ecartement_rangs":"null","objectifs_rendement":"null","sensibilite_secheresse":true,"sensibilite_exces_eau":true,"irrigation":true,"drainage":true,"sol_en_pente":true,"cultureproduction":true,"analyse_sol_dispo":true,"densitesemis":"null","date_analyse_sol":"null","date_semis":"null","date_levee":"null","unite_uid":"null","culture_uid":"null","culture_precedante_uid":"null","densite_semis_uid":"null","cailloux_id":0,"reserve_utile_id":0,"sol_type_id":0,"sol_profondeur_id":0,"sol_travail_id":0}'

const url = new URL(
    "https://api.oss.coop/parcelle/1/fiche/2"
);

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

let body = {
    "variete": "null",
    "exposition": "null",
    "situation_particuliere": "null",
    "conditionssemis": "null",
    "fumure_mineraux_date": "null",
    "fumure_mineraux_produits": "null",
    "fumure_organique_date": "null",
    "fumure_organique_produits": "null",
    "fumure_calcaire_date": "null",
    "fumure_calcaire_produits": "null",
    "fumure_oligo_date": "null",
    "fumure_oligo_produits": "null",
    "protection_herbicides_date": "null",
    "protection_herbicides_produits": "null",
    "protection_fongicides_date": "null",
    "protection_inscticides_date": "null",
    "protection_insecticides_produits": "null",
    "protection_regulateurs_date": "null",
    "protection_regulateurs_produits": "null",
    "protection_autres_date": "null",
    "protection_autres_produits": "null",
    "argile": "null",
    "limon": "null",
    "sable": "null",
    "ecartement_rangs": "null",
    "objectifs_rendement": "null",
    "sensibilite_secheresse": true,
    "sensibilite_exces_eau": true,
    "irrigation": true,
    "drainage": true,
    "sol_en_pente": true,
    "cultureproduction": true,
    "analyse_sol_dispo": true,
    "densitesemis": "null",
    "date_analyse_sol": "null",
    "date_semis": "null",
    "date_levee": "null",
    "unite_uid": "null",
    "culture_uid": "null",
    "culture_precedante_uid": "null",
    "densite_semis_uid": "null",
    "cailloux_id": 0,
    "reserve_utile_id": 0,
    "sol_type_id": 0,
    "sol_profondeur_id": 0,
    "sol_travail_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/parcelle/1/fiche/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variete' => 'null',
            'exposition' => 'null',
            'situation_particuliere' => 'null',
            'conditionssemis' => 'null',
            'fumure_mineraux_date' => 'null',
            'fumure_mineraux_produits' => 'null',
            'fumure_organique_date' => 'null',
            'fumure_organique_produits' => 'null',
            'fumure_calcaire_date' => 'null',
            'fumure_calcaire_produits' => 'null',
            'fumure_oligo_date' => 'null',
            'fumure_oligo_produits' => 'null',
            'protection_herbicides_date' => 'null',
            'protection_herbicides_produits' => 'null',
            'protection_fongicides_date' => 'null',
            'protection_inscticides_date' => 'null',
            'protection_insecticides_produits' => 'null',
            'protection_regulateurs_date' => 'null',
            'protection_regulateurs_produits' => 'null',
            'protection_autres_date' => 'null',
            'protection_autres_produits' => 'null',
            'argile' => 'null',
            'limon' => 'null',
            'sable' => 'null',
            'ecartement_rangs' => 'null',
            'objectifs_rendement' => 'null',
            'sensibilite_secheresse' => true,
            'sensibilite_exces_eau' => true,
            'irrigation' => true,
            'drainage' => true,
            'sol_en_pente' => true,
            'cultureproduction' => true,
            'analyse_sol_dispo' => true,
            'densitesemis' => 'null',
            'date_analyse_sol' => 'null',
            'date_semis' => 'null',
            'date_levee' => 'null',
            'unite_uid' => 'null',
            'culture_uid' => 'null',
            'culture_precedante_uid' => 'null',
            'densite_semis_uid' => 'null',
            'cailloux_id' => 0,
            'reserve_utile_id' => 0,
            'sol_type_id' => 0,
            'sol_profondeur_id' => 0,
            'sol_travail_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "variete": null,
        "exposition": null,
        "situation_particuliere": null,
        "conditionssemis": null,
        "fumure_mineraux_date": null,
        "fumure_mineraux_produits": null,
        "fumure_organique_date": null,
        "fumure_organique_produits": null,
        "fumure_calcaire_date": null,
        "fumure_calcaire_produits": null,
        "fumure_oligo_date": null,
        "fumure_oligo_produits": null,
        "protection_herbicides_date": null,
        "protection_herbicides_produits": null,
        "protection_fongicides_date": null,
        "protection_fongicides_produits": null,
        "protection_inscticides_date": null,
        "protection_insecticides_produits": null,
        "protection_regulateurs_date": null,
        "protection_regulateurs_produits": null,
        "protection_autres_date": null,
        "protection_autres_produits": null,
        "argile": null,
        "limon": null,
        "sable": null,
        "ecartement_rangs": null,
        "objectifs_rendement": null,
        "densitesemis": null,
        "sensibilite_secheresse": null,
        "sensibilite_exces_eau": null,
        "irrigation": null,
        "drainage": null,
        "sol_en_pente": null,
        "cultureproduction": null,
        "analyse_sol_dispo": null,
        "date_analyse_sol": null,
        "date_semis": null,
        "date_levee": null,
        "unite": null,
        "culture": null,
        "culture_precedante": null,
        "cailloux": null,
        "reserve_utile": null,
        "densite_semis": null,
        "sol_type": null,
        "sol_profondeur": null,
        "sol_travail": null
    }
}

Request   

PUT parcelle/{puid:[0-9]+}/fiche/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant de la parcelle.

uid  integer  
L'identifiant de la fiche.

Body Parameters

variete  string optional  
La variété associée à la fiche de la parcelle.

exposition  string optional  
L'exposition de la parcelle.

situation_particuliere  string optional  
La situation particuliere de la parcelle.

conditionssemis  string optional  
Les semis contenus dans parcelle.

fumure_mineraux_date  date optional  
La date de dispersion d'angrais minéraux (fumure / fertilisation) de la parcelle.

fumure_mineraux_produits  string optional  
Les produits / quantités d'angrais minéraux (fumure / fertilisation) de la parcelle.

fumure_organique_date  date optional  
La date de dispersion de produits organiques (fumure / fertilisation) de la parcelle.

fumure_organique_produits  string optional  
Les produits / quantités de produits organiques (fumure / fertilisation) de la parcelle.

fumure_calcaire_date  date optional  
La date de dispersion d'amendemants calcaires (fumure / fertilisation) de la parcelle.

fumure_calcaire_produits  string optional  
Les produits / quantités d'amendemants calcaires (fumure / fertilisation) de la parcelle.

fumure_oligo_date  date optional  
La date de dispersion d'oligoéléments (fumure / fertilisation) de la parcelle.

fumure_oligo_produits  string optional  
Les produits / quantités d'oligoéléments (fumure / fertilisation) de la parcelle.

protection_herbicides_date  date optional  
La date de dispersion d'herbicides (protection des cultures) de la parcelle.

protection_herbicides_produits  string optional  
Les produits / quantités de fongicides (protection des cultures) de la parcelle.

protection_fongicides_date  date optional  
La date de dispersion de fongicides (protection des cultures) de la parcelle.

protection_inscticides_date  date optional  
La date de dispersion d'inscticides (protection des cultures) de la parcelle.

protection_insecticides_produits  string optional  
Les produits / quantités d'inscticides (protection des cultures) de la parcelle.

protection_regulateurs_date  date optional  
La date de dispersion de régulateurs (protection des cultures) de la parcelle.

protection_regulateurs_produits  string optional  
Les produits / quantités de régulateurs (protection des cultures) de la parcelle.

protection_autres_date  date optional  
La date de dispersion d'autres produits (protection des cultures) de la parcelle.

protection_autres_produits  string optional  
Les produits / quantités d'autres produits (protection des cultures) de la parcelle.

argile  numeric optional  
La quantité d'argile de la parcelle en pourcent.

limon  numeric optional  
La quantité de limon de la parcelle en pourcent.

sable  numeric optional  
La quantité de sable de la parcelle en pourcent.

ecartement_rangs  numeric optional  
L'écartement des rangs de la parcelle.

objectifs_rendement  numeric optional  
Les objectifs de rendement de la parcelle.

sensibilite_secheresse  boolean optional  
Le caractère sensible à la sècheresse de la parcelle.

sensibilite_exces_eau  boolean optional  
Le caractère sensible aux exes d'eau de la parcelle.

irrigation  boolean optional  
Le caractère d'irrigation de la parcelle.

drainage  boolean optional  
Le caractère de drainage de la parcelle.

sol_en_pente  boolean optional  
Le caractère de pente du sol de la parcelle.

cultureproduction  boolean optional  
Le caractère production de culture de la parcelle.

analyse_sol_dispo  boolean optional  
Le caractère de disponibilité de l'analyse du sol de la parcelle.

densitesemis  numeric optional  
La densité de semis de la parcelle.

date_analyse_sol  date optional  
La date d'analyse de la parcelle.

date_semis  date optional  
La date de semis de la parcelle.

date_levee  date optional  
La date de levée de la parcelle.

unite_uid  string optional  
L'identifiant unique de l'unité des objectifs de rendement de la parcelle.

culture_uid  string optional  
L'identifiant unique de la culture de la parcelle.

culture_precedante_uid  string optional  
L'identifiant unique de la culture précédante de la parcelle.

densite_semis_uid  string optional  
L'identifiant unique de l'unité des densités de semis.

cailloux_id  integer optional  
L'identifiant de la valeur du référentiel cailloux.

reserve_utile_id  integer optional  
L'identifiant de la valeur du référentiel reserve utile.

sol_type_id  integer optional  
L'identifiant de la valeur du référentiel type de sol.

sol_profondeur_id  integer optional  
L'identifiant de la valeur du référentiel profondeur de sol.

sol_travail_id  integer optional  
L'identifiant de la valeur du référentiel travail du sol.

Pictogrammes

Lister

requires authentication

Liste des pictogrammes

Example request:

curl -X GET \
    -G "https://api.oss.coop/pictogramme?sort=nom.ASC%2Cid.DESC&page=14&limit=5" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/pictogramme"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "5",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/pictogramme',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "nom": "produitpascool",
            "valeur": "valeur"
        }
    ]
}

Request   

GET pictogramme

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un pictogramme

Example request:

curl -X GET \
    -G "https://api.oss.coop/pictogramme/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/pictogramme/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/pictogramme/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "nom": "produitpascool",
        "media": { ... }
    }
}

Request   

GET pictogramme/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du pictogramme.

Ajouter

requires authentication

Ajoute un pictogramme

Example request:

curl -X POST \
    "https://api.oss.coop/pictogramme" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","nom":"produitpascool2","media_id":2}'

const url = new URL(
    "https://api.oss.coop/pictogramme"
);

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

let body = {
    "uid": "id_unique_universel2",
    "nom": "produitpascool2",
    "media_id": 2
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/pictogramme',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'nom' => 'produitpascool2',
            'media_id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "nom": "produitpascool2",
        "media": { ... }
    }
}

Request   

POST pictogramme

Body Parameters

uid  string  
L'identifiant unique du pictogramme.

nom  string optional  
Le nom du pictogramme.

media_id  integer  
L'identifiant unique du média associé au pictogramme.

Modifier

requires authentication

Modifie un pictogramme

Example request:

curl -X PUT \
    "https://api.oss.coop/pictogramme/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","nom":"null","media_id":3}'

const url = new URL(
    "https://api.oss.coop/pictogramme/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "nom": "null",
    "media_id": 3
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/pictogramme/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'nom' => 'null',
            'media_id' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "nom": null,
        "media": { ... }
    }
}

Request   

PUT pictogramme/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du pictogramme.

Body Parameters

uid  string  
L'identifiant unique du pictogramme.

nom  string optional  
Le nom du pictogramme.

media_id  integer  
L'identifiant unique du média associé au pictogramme.

Supprimer

requires authentication

Supprime un pictogramme

Example request:

curl -X DELETE \
    "https://api.oss.coop/pictogramme/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/pictogramme/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/pictogramme/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE pictogramme/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du pictogramme.

Produits

Lister

requires authentication

Liste des produits

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit?sort=nom.ASC%2Cid.DESC&page=15&limit=18" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "15",
    "limit": "18",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '15',
            'limit'=> '18',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "euid": "encore un code",
            "nom": "test",
            "remarques": null,
            "informations_complementaires": null,
            "annee_inscription": null,
            "code_cooperative": null,
            "code_invivo": null,
            "code_bpe": null,
            "code_obtenteur": null,
            "code_ctps": null,
            "code_gnis": null,
            "numero_amm": null,
            "numero_homologation": null,
            "serie": null,
            "typ_var1": null,
            "typ_var2": null,
            "typ_var3": null,
            "typ_var4": null,
            "typ_var5": null,
            "date_fincommercialisation": null,
            "date_finutilisation": null,
            "biocontrole": null,
            "agriculturebiologique": null,
            "actif": true,
            "type": {
                "id": 1,
                "uid": "SANTEVEGETALE",
                "designation": "Produit de santé végétale"
            },
            "famille": null,
            "entite": {
                "id": 1,
                "nom": "Diatem",
                "adresse": "2 Rue de Dublin",
                "cp": "67300",
                "ville": "Schiltigheim",
                "actif": true,
                "description": "Une entreprise pas comme les autres",
                "type": {
                    "id": 1,
                    "uid": "CENTRALEACHATNATIONALE",
                    "designation": "Centrale d'achat nationale"
                },
                "parent": null,
                "pays": null,
                "logo_prim": null,
                "logo_sec": null,
                "logo_ter": null
            },
            "unite": null,
            "norme": null,
            "formulation": null,
            "categorie_fonctionnelle": null,
            "categorie_matieres_constitutives": null
        }
    ]
}

Request   

GET produit

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Lister

requires authentication

Liste des produits des protocoles

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit/protocoles?sort=nom.ASC%2Cid.DESC&page=14&limit=2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/protocoles"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit/protocoles',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "euid": "encore un code",
            "nom": "test",
            "remarques": null,
            "informations_complementaires": null,
            "annee_inscription": null,
            "code_cooperative": null,
            "code_invivo": null,
            "code_bpe": null,
            "code_obtenteur": null,
            "code_ctps": null,
            "code_gnis": null,
            "numero_amm": null,
            "numero_homologation": null,
            "serie": null,
            "typ_var1": null,
            "typ_var2": null,
            "typ_var3": null,
            "typ_var4": null,
            "typ_var5": null,
            "date_fincommercialisation": null,
            "date_finutilisation": null,
            "biocontrole": null,
            "agriculturebiologique": null,
            "actif": true,
            "type": {
                "id": 1,
                "uid": "SANTEVEGETALE",
                "designation": "Produit de santé végétale"
            },
            "famille": null,
            "entite": {
                "id": 1,
                "nom": "Diatem",
                "adresse": "2 Rue de Dublin",
                "cp": "67300",
                "ville": "Schiltigheim",
                "actif": true,
                "description": "Une entreprise pas comme les autres",
                "type": {
                    "id": 1,
                    "uid": "CENTRALEACHATNATIONALE",
                    "designation": "Centrale d'achat nationale"
                },
                "parent": null,
                "pays": null,
                "logo_prim": null,
                "logo_sec": null,
                "logo_ter": null
            },
            "unite": null,
            "norme": null,
            "formulation": null,
            "categorie_fonctionnelle": null,
            "categorie_matieres_constitutives": null
        }
    ]
}

Request   

GET produit/protocoles

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Lister

requires authentication

Liste des produits des protocoles enfants

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit/protocoles_enfants?sort=nom.ASC%2Cid.DESC&page=8&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/protocoles_enfants"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "8",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit/protocoles_enfants',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '8',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "euid": "encore un code",
            "nom": "test",
            "remarques": null,
            "informations_complementaires": null,
            "annee_inscription": null,
            "code_cooperative": null,
            "code_invivo": null,
            "code_bpe": null,
            "code_obtenteur": null,
            "code_ctps": null,
            "code_gnis": null,
            "numero_amm": null,
            "numero_homologation": null,
            "serie": null,
            "typ_var1": null,
            "typ_var2": null,
            "typ_var3": null,
            "typ_var4": null,
            "typ_var5": null,
            "date_fincommercialisation": null,
            "date_finutilisation": null,
            "biocontrole": null,
            "agriculturebiologique": null,
            "actif": true,
            "type": {
                "id": 1,
                "uid": "SANTEVEGETALE",
                "designation": "Produit de santé végétale"
            },
            "famille": null,
            "entite": {
                "id": 1,
                "nom": "Diatem",
                "adresse": "2 Rue de Dublin",
                "cp": "67300",
                "ville": "Schiltigheim",
                "actif": true,
                "description": "Une entreprise pas comme les autres",
                "type": {
                    "id": 1,
                    "uid": "CENTRALEACHATNATIONALE",
                    "designation": "Centrale d'achat nationale"
                },
                "parent": null,
                "pays": null,
                "logo_prim": null,
                "logo_sec": null,
                "logo_ter": null
            },
            "unite": null,
            "norme": null,
            "formulation": null,
            "categorie_fonctionnelle": null,
            "categorie_matieres_constitutives": null
        }
    ]
}

Request   

GET produit/protocoles_enfants

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Lister commandables

requires authentication

Liste des produits commandables

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit/commandable?sort=nom.ASC%2Cid.DESC&page=15&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/commandable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "15",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit/commandable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '15',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "euid": "encore un code",
            "nom": "test",
            "remarques": null,
            "informations_complementaires": null,
            "annee_inscription": null,
            "code_cooperative": null,
            "code_invivo": null,
            "code_bpe": null,
            "code_obtenteur": null,
            "code_ctps": null,
            "code_gnis": null,
            "numero_amm": null,
            "numero_homologation": null,
            "serie": null,
            "typ_var1": null,
            "typ_var2": null,
            "typ_var3": null,
            "typ_var4": null,
            "typ_var5": null,
            "date_fincommercialisation": null,
            "date_finutilisation": null,
            "biocontrole": null,
            "agriculturebiologique": null,
            "actif": true,
            "type": {
                "id": 1,
                "uid": "SANTEVEGETALE",
                "designation": "Produit de santé végétale"
            },
            "famille": null,
            "entite": {
                "id": 1,
                "nom": "Diatem",
                "adresse": "2 Rue de Dublin",
                "cp": "67300",
                "ville": "Schiltigheim",
                "actif": true,
                "description": "Une entreprise pas comme les autres",
                "type": {
                    "id": 1,
                    "uid": "CENTRALEACHATNATIONALE",
                    "designation": "Centrale d'achat nationale"
                },
                "parent": null,
                "pays": null,
                "logo_prim": null,
                "logo_sec": null,
                "logo_ter": null
            },
            "unite": null,
            "norme": null,
            "formulation": null,
            "categorie_fonctionnelle": null,
            "categorie_matieres_constitutives": null
        }
    ]
}

Request   

GET produit/commandable

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un produit

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "euid": "encore un code",
        "nom": "Kiturien",
        "remarques": null,
        "informations_complementaires": null,
        "annee_inscription": null,
        "code_cooperative": null,
        "code_invivo": null,
        "code_bpe": null,
        "code_obtenteur": null,
        "code_ctps": null,
        "code_gnis": null,
        "numero_amm": null,
        "numero_homologation": null,
        "serie": null,
        "typ_var1": null,
        "typ_var2": null,
        "typ_var3": null,
        "typ_var4": null,
        "typ_var5": null,
        "date_fincommercialisation": null,
        "date_finutilisation": null,
        "biocontrole": null,
        "agriculturebiologique": null,
        "actif": true,
        "type": {
            "id": 1,
            "uid": "SANTEVEGETALE",
            "designation": "Produit de santé végétale"
        },
        "famille": null,
        "entite": {
            "id": 1,
            "nom": "Diatem",
            "adresse": "2 Rue de Dublin",
            "cp": "67300",
            "ville": "Schiltigheim",
            "actif": true,
            "description": "Une entreprise pas comme les autres",
            "type": {
                "id": 1,
                "uid": "CENTRALEACHATNATIONALE",
                "designation": "Centrale d'achat nationale"
            },
            "parent": null,
            "pays": null,
            "logo_prim": null,
            "logo_sec": null,
            "logo_ter": null
        },
        "unite": null,
        "norme": null,
        "formulation": null,
        "categorie_fonctionnelle": null,
        "categorie_matieres_constitutives": null
    }
}

Request   

GET produit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du produit.

Ajouter

requires authentication

Ajoute un produit

Example request:

curl -X POST \
    "https://api.oss.coop/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"eui":"Kitutout","nom":"Kitutout","remarques":"Kitutout tue tout et m\u00eame plus","code_cooperative":"COOP21","type_uid":"SANTEVEGETALE","obtenteur_uid":"FOURNISSEUR1","famille_uid":"id_unique_universel","entite_id":1,"unite_uid":"id_unique_universel","pictogrammes":[{"uid":"1"},{"uid":"1"}],"cultures":[{"uid":"1"},[]],"sous_thematiques":[{"uid":"1"},{"uid":"1"}],"numero_amm":"AMM0123456789","agriculturebiologique":false,"formulation_id":1,"code_invivo":"INVIVO0123456789","code_bpe":"BPE0123456789","date_fincommercialisation":"2150-12-31 12:00:00+0200","date_finutilisation":"2150-12-31 12:00:00+0200","biocontrole":false,"numero_homologation":"H0123456789","norme_id":2,"categorie_fonctionnelle_id":3,"categorie_matieres_constitutives_id":4,"annee_inscription":2021,"informations_complementaires":"Kitutout tue tout et m\u00eame plus que Kituriensauftasante","serie":"S0123456789","typ_var1":"string","typ_var2":"integer","typ_var3":"float","typ_var4":"datetime","typ_var5":"boolean","code_obtenteur":"O0123456789","code_ctps":"CTPS0123456789","code_gnis":"GNIS0123456789"}'

const url = new URL(
    "https://api.oss.coop/produit"
);

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

let body = {
    "eui": "Kitutout",
    "nom": "Kitutout",
    "remarques": "Kitutout tue tout et m\u00eame plus",
    "code_cooperative": "COOP21",
    "type_uid": "SANTEVEGETALE",
    "obtenteur_uid": "FOURNISSEUR1",
    "famille_uid": "id_unique_universel",
    "entite_id": 1,
    "unite_uid": "id_unique_universel",
    "pictogrammes": [
        {
            "uid": "1"
        },
        {
            "uid": "1"
        }
    ],
    "cultures": [
        {
            "uid": "1"
        },
        []
    ],
    "sous_thematiques": [
        {
            "uid": "1"
        },
        {
            "uid": "1"
        }
    ],
    "numero_amm": "AMM0123456789",
    "agriculturebiologique": false,
    "formulation_id": 1,
    "code_invivo": "INVIVO0123456789",
    "code_bpe": "BPE0123456789",
    "date_fincommercialisation": "2150-12-31 12:00:00+0200",
    "date_finutilisation": "2150-12-31 12:00:00+0200",
    "biocontrole": false,
    "numero_homologation": "H0123456789",
    "norme_id": 2,
    "categorie_fonctionnelle_id": 3,
    "categorie_matieres_constitutives_id": 4,
    "annee_inscription": 2021,
    "informations_complementaires": "Kitutout tue tout et m\u00eame plus que Kituriensauftasante",
    "serie": "S0123456789",
    "typ_var1": "string",
    "typ_var2": "integer",
    "typ_var3": "float",
    "typ_var4": "datetime",
    "typ_var5": "boolean",
    "code_obtenteur": "O0123456789",
    "code_ctps": "CTPS0123456789",
    "code_gnis": "GNIS0123456789"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'eui' => 'Kitutout',
            'nom' => 'Kitutout',
            'remarques' => 'Kitutout tue tout et même plus',
            'code_cooperative' => 'COOP21',
            'type_uid' => 'SANTEVEGETALE',
            'obtenteur_uid' => 'FOURNISSEUR1',
            'famille_uid' => 'id_unique_universel',
            'entite_id' => 1,
            'unite_uid' => 'id_unique_universel',
            'pictogrammes' => [
                [
                    'uid' => '1',
                ],
                [
                    'uid' => '1',
                ],
            ],
            'cultures' => [
                [
                    'uid' => '1',
                ],
                [],
            ],
            'sous_thematiques' => [
                [
                    'uid' => '1',
                ],
                [
                    'uid' => '1',
                ],
            ],
            'numero_amm' => 'AMM0123456789',
            'agriculturebiologique' => false,
            'formulation_id' => 1,
            'code_invivo' => 'INVIVO0123456789',
            'code_bpe' => 'BPE0123456789',
            'date_fincommercialisation' => '2150-12-31 12:00:00+0200',
            'date_finutilisation' => '2150-12-31 12:00:00+0200',
            'biocontrole' => false,
            'numero_homologation' => 'H0123456789',
            'norme_id' => 2,
            'categorie_fonctionnelle_id' => 3,
            'categorie_matieres_constitutives_id' => 4,
            'annee_inscription' => 2021,
            'informations_complementaires' => 'Kitutout tue tout et même plus que Kituriensauftasante',
            'serie' => 'S0123456789',
            'typ_var1' => 'string',
            'typ_var2' => 'integer',
            'typ_var3' => 'float',
            'typ_var4' => 'datetime',
            'typ_var5' => 'boolean',
            'code_obtenteur' => 'O0123456789',
            'code_ctps' => 'CTPS0123456789',
            'code_gnis' => 'GNIS0123456789',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "euid": "encore un autre code",
        "nom": "Kitutout",
        "remarques": "Kitutout tue tout et même plus",
        "informations_complementaires": "Kitutout tue tout et même plus que Kituriensauftasante",
        "annee_inscription": 2021,
        "code_cooperative": "COOP21",
        "code_invivo": "INVIVO0123456789",
        "code_bpe": "BPE0123456789",
        "code_obtenteur": "O0123456789",
        "code_ctps": "CTPS0123456789",
        "code_gnis": "GNIS0123456789",
        "numero_amm": "AMM0123456789",
        "numero_homologation": "H0123456789",
        "serie": "S0123456789",
        "typ_var1": "string",
        "typ_var2": "integer",
        "typ_var3": "float",
        "typ_var4": "datetime",
        "typ_var5": "boolean",
        "date_fincommercialisation": "2150-12-31 12:00:00+02",
        "date_finutilisation": "2150-12-31 12:00:00+02",
        "biocontrole": false,
        "agriculturebiologique": false,
        "actif": true,
        "type": {
            "id": 1,
            "uid": "SANTEVEGETALE",
            "designation": "Produit de santé végétale"
        },
        "famille": {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        },
        "entite": {
            "id": 1,
            "nom": "Diatem",
            "adresse": "2 Rue de Dublin",
            "cp": "67300",
            "ville": "Schiltigheim",
            "actif": true,
            "description": "Une entreprise pas comme les autres",
            "type": {
                "id": 1,
                "uid": "CENTRALEACHATNATIONALE",
                "designation": "Centrale d'achat nationale"
            },
            "parent": null,
            "pays": null,
            "logo_prim": null,
            "logo_sec": null,
            "logo_ter": null
        },
        "unite": {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        },
        "norme": {
            "id": 2,
            "valeur": "norme"
        },
        "formulation": {
            "id": 1,
            "valeur": "formulation"
        },
        "categorie_fonctionnelle": {
            "id": 3,
            "valeur": "categorie_fonctionnelle"
        },
        "categorie_matieres_constitutives": {
            "id": 4,
            "valeur": "categorie_matieres_constitutives"
        }
    }
}

Request   

POST produit

Body Parameters

eui  string optional  
L'identifient unique externe (ERP) du produit.

nom  string  
Le nom du produit.

remarques  string optional  
Les remarques sur le produit.

code_cooperative  string optional  
Le code de la coopérative du produit.

type_uid  string  
L'identifiant unique du type de produit.

obtenteur_uid  string  
L'identifiant unique du fournisseur obtenteur.

famille_uid  string optional  
L'identifiant unique de la famille de produit.

entite_id  integer  
L'identifiant de l'entité du produit.

unite_uid  string optional  
L'identifiant unique de l'unité du produit.

pictogrammes  object[] optional  
Les pictogrammes du produit.

pictogrammes[].uid  string optional  
Un identifiant unique de pictogramme existant.

cultures  object[] optional  
Les cultures du produit.

cultures[].uid  string optional  
Un identifiant unique de culture existant.

sous_thematiques  object[] optional  
Les sous thematiques du produit.

sous_thematiques[].uid  string optional  
Un identifiant unique de thematique existant.

numero_amm  string optional  
Le numéro d'autorisation de mise sur le marché du produit (type SANTEVEGETALE et FERTILISANT uniquement).

agriculturebiologique  boolean  
Le caractère biologique du produit (type SANTEVEGETALE et FERTILISANT uniquement).

formulation_id  integer  
L'identifiant de la valeur du référentiel formulation (type SANTEVEGETALE et FERTILISANT uniquement).

code_invivo  string  
Le code Invivo du produit (type SANTEVEGETALE uniquement).

code_bpe  string  
Le code BPE du produit (type SANTEVEGETALE uniquement).

date_fincommercialisation  date optional  
La date de fin de commercialisation du produit (type SANTEVEGETALE uniquement).

date_finutilisation  date optional  
La date de fin d'utilisation du produit (type SANTEVEGETALE uniquement).

biocontrole  boolean  
Le contrôle du caractère biologique du produit (type SANTEVEGETALE uniquement).

numero_homologation  string  
Le numéro d'homologation du produit (type FERTILISANT uniquement).

norme_id  integer  
L'identifiant de la valeur du référentiel norme (type FERTILISANT uniquement).

categorie_fonctionnelle_id  integer  
L'identifiant de la valeur du référentiel categoriefonctionnelle (type FERTILISANT uniquement).

categorie_matieres_constitutives_id  integer  
L'identifiant de la valeur du référentiel categorieatieresconstitutives (type FERTILISANT uniquement).

annee_inscription  integer  
L'année d'inscription du produit (type SEMENCE uniquement).

informations_complementaires  string  
Les informations complémentaires sur le produit (type SEMENCE uniquement).

serie  string  
La série du produit (type SEMENCE uniquement).

typ_var1  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var2  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var3  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var4  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var5  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

code_obtenteur  string  
Le code obtenteur du produit (type SEMENCE uniquement).

code_ctps  string  
Le code organisme de validation des variétés apportant un 'plus' (type SEMENCE uniquement).

code_gnis  string  
Le code GNIS du produit (type SEMENCE uniquement).

Modifier

requires authentication

Modifie un produit

Example request:

curl -X PUT \
    "https://api.oss.coop/produit/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"eui":"Kitutout","nom":"Kitutout","remarques":"Kitutout tue tout et m\u00eame plus","code_cooperative":"COOP21","type_uid":"SANTEVEGETALE","obtenteur_uid":"FOURNISSEUR2","famille_uid":"id_unique_universel","entite_id":1,"unite_uid":"id_unique_universel","pictogrammes":[{"uid":"2"},[]],"cultures":[{"uid":"2"},[]],"sous_thematiques":[{"uid":"2"},{"uid":"2"}],"numero_amm":"AMM0123456789","agriculturebiologique":false,"formulation_id":1,"code_invivo":"INVIVO0123456789","code_bpe":"BPE0123456789","date_fincommercialisation":"2150-12-31 12:00:00+0200","date_finutilisation":"2150-12-31 12:00:00+0200","biocontrole":false,"numero_homologation":"H0123456789","norme_id":2,"categorie_fonctionnelle_id":3,"categorie_matieres_constitutives_id":4,"annee_inscription":2021,"informations_complementaires":"Kitutout tue tout et m\u00eame plus que Kituriensauftasante","serie":"S0123456789","typ_var1":"string","typ_var2":"integer","typ_var3":"float","typ_var4":"datetime","typ_var5":"boolean","code_obtenteur":"O0123456789","code_ctps":"CTPS0123456789","code_gnis":"GNIS0123456789"}'

const url = new URL(
    "https://api.oss.coop/produit/2"
);

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

let body = {
    "eui": "Kitutout",
    "nom": "Kitutout",
    "remarques": "Kitutout tue tout et m\u00eame plus",
    "code_cooperative": "COOP21",
    "type_uid": "SANTEVEGETALE",
    "obtenteur_uid": "FOURNISSEUR2",
    "famille_uid": "id_unique_universel",
    "entite_id": 1,
    "unite_uid": "id_unique_universel",
    "pictogrammes": [
        {
            "uid": "2"
        },
        []
    ],
    "cultures": [
        {
            "uid": "2"
        },
        []
    ],
    "sous_thematiques": [
        {
            "uid": "2"
        },
        {
            "uid": "2"
        }
    ],
    "numero_amm": "AMM0123456789",
    "agriculturebiologique": false,
    "formulation_id": 1,
    "code_invivo": "INVIVO0123456789",
    "code_bpe": "BPE0123456789",
    "date_fincommercialisation": "2150-12-31 12:00:00+0200",
    "date_finutilisation": "2150-12-31 12:00:00+0200",
    "biocontrole": false,
    "numero_homologation": "H0123456789",
    "norme_id": 2,
    "categorie_fonctionnelle_id": 3,
    "categorie_matieres_constitutives_id": 4,
    "annee_inscription": 2021,
    "informations_complementaires": "Kitutout tue tout et m\u00eame plus que Kituriensauftasante",
    "serie": "S0123456789",
    "typ_var1": "string",
    "typ_var2": "integer",
    "typ_var3": "float",
    "typ_var4": "datetime",
    "typ_var5": "boolean",
    "code_obtenteur": "O0123456789",
    "code_ctps": "CTPS0123456789",
    "code_gnis": "GNIS0123456789"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/produit/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'eui' => 'Kitutout',
            'nom' => 'Kitutout',
            'remarques' => 'Kitutout tue tout et même plus',
            'code_cooperative' => 'COOP21',
            'type_uid' => 'SANTEVEGETALE',
            'obtenteur_uid' => 'FOURNISSEUR2',
            'famille_uid' => 'id_unique_universel',
            'entite_id' => 1,
            'unite_uid' => 'id_unique_universel',
            'pictogrammes' => [
                [
                    'uid' => '2',
                ],
                [],
            ],
            'cultures' => [
                [
                    'uid' => '2',
                ],
                [],
            ],
            'sous_thematiques' => [
                [
                    'uid' => '2',
                ],
                [
                    'uid' => '2',
                ],
            ],
            'numero_amm' => 'AMM0123456789',
            'agriculturebiologique' => false,
            'formulation_id' => 1,
            'code_invivo' => 'INVIVO0123456789',
            'code_bpe' => 'BPE0123456789',
            'date_fincommercialisation' => '2150-12-31 12:00:00+0200',
            'date_finutilisation' => '2150-12-31 12:00:00+0200',
            'biocontrole' => false,
            'numero_homologation' => 'H0123456789',
            'norme_id' => 2,
            'categorie_fonctionnelle_id' => 3,
            'categorie_matieres_constitutives_id' => 4,
            'annee_inscription' => 2021,
            'informations_complementaires' => 'Kitutout tue tout et même plus que Kituriensauftasante',
            'serie' => 'S0123456789',
            'typ_var1' => 'string',
            'typ_var2' => 'integer',
            'typ_var3' => 'float',
            'typ_var4' => 'datetime',
            'typ_var5' => 'boolean',
            'code_obtenteur' => 'O0123456789',
            'code_ctps' => 'CTPS0123456789',
            'code_gnis' => 'GNIS0123456789',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "euid": null,
        "nom": "Kitutout",
        "remarques": "Kitutout tue tout et même plus",
        "informations_complementaires": "Kitutout tue tout et même plus que Kituriensauftasante",
        "annee_inscription": 2021,
        "code_cooperative": "COOP21",
        "code_invivo": "INVIVO0123456789",
        "code_bpe": "BPE0123456789",
        "code_obtenteur": "O0123456789",
        "code_ctps": "CTPS0123456789",
        "code_gnis": "GNIS0123456789",
        "numero_amm": "AMM0123456789",
        "numero_homologation": "H0123456789",
        "serie": "S0123456789",
        "typ_var1": "string",
        "typ_var2": "integer",
        "typ_var3": "float",
        "typ_var4": "datetime",
        "typ_var5": "boolean",
        "date_fincommercialisation": "2150-12-31 12:00:00+02",
        "date_finutilisation": "2150-12-31 12:00:00+02",
        "biocontrole": false,
        "agriculturebiologique": false,
        "actif": true,
        "type": {
            "id": 1,
            "uid": "SANTEVEGETALE",
            "designation": "Produit de santé végétale"
        },
        "famille": {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        },
        "entite": {
            "id": 1,
            "nom": "Diatem",
            "adresse": "2 Rue de Dublin",
            "cp": "67300",
            "ville": "Schiltigheim",
            "actif": true,
            "description": "Une entreprise pas comme les autres",
            "type": {
                "id": 1,
                "uid": "CENTRALEACHATNATIONALE",
                "designation": "Centrale d'achat nationale"
            },
            "parent": null,
            "pays": null,
            "logo_prim": null,
            "logo_sec": null,
            "logo_ter": null
        },
        "unite": {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        },
        "norme": {
            "id": 2,
            "valeur": "norme"
        },
        "formulation": {
            "id": 1,
            "valeur": "formulation"
        },
        "categorie_fonctionnelle": {
            "id": 3,
            "valeur": "categorie_fonctionnelle"
        },
        "categorie_matieres_constitutives": {
            "id": 4,
            "valeur": "categorie_matieres_constitutives"
        }
    }
}

Request   

PUT produit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du produit.

Body Parameters

eui  string optional  
L'identifient unique externe (ERP) du produit.

nom  string  
Le nom du produit.

remarques  string optional  
Les remarques sur le produit.

code_cooperative  string optional  
Le code de la coopérative du produit.

type_uid  string  
L'identifiant unique du type de produit.

obtenteur_uid  string  
L'identifiant unique du fournisseur obtenteur.

famille_uid  string optional  
L'identifiant unique de la famille de produit.

entite_id  integer  
L'identifiant de l'entité du produit.

unite_uid  string optional  
L'identifiant unique de l'unité du produit.

pictogrammes  object[] optional  
Les pictogrammes du produit.

pictogrammes[].uid  string optional  
Un identifiant unique de pictogramme existant.

cultures  object[] optional  
Les cultures du produit.

cultures[].uid  string optional  
Un identifiant unique de culture existant.

sous_thematiques  object[] optional  
Les sous thematiques du produit.

sous_thematiques[].uid  string optional  
Un identifiant unique de thematique existant.

numero_amm  string optional  
Le numéro d'autorisation de mise sur le marché du produit (type SANTEVEGETALE et FERTILISANT uniquement).

agriculturebiologique  boolean  
Le caractère biologique du produit (type SANTEVEGETALE et FERTILISANT uniquement).

formulation_id  integer  
L'identifiant de la valeur du référentiel formulation (type SANTEVEGETALE et FERTILISANT uniquement).

code_invivo  string  
Le code Invivo du produit (type SANTEVEGETALE uniquement).

code_bpe  string  
Le code BPE du produit (type SANTEVEGETALE uniquement).

date_fincommercialisation  date optional  
La date de fin de commercialisation du produit (type SANTEVEGETALE uniquement).

date_finutilisation  date optional  
La date de fin d'utilisation du produit (type SANTEVEGETALE uniquement).

biocontrole  boolean  
Le contrôle du caractère biologique du produit (type SANTEVEGETALE uniquement).

numero_homologation  string  
Le numéro d'homologation du produit (type FERTILISANT uniquement).

norme_id  integer  
L'identifiant de la valeur du référentiel norme (type FERTILISANT uniquement).

categorie_fonctionnelle_id  integer  
L'identifiant de la valeur du référentiel categoriefonctionnelle (type FERTILISANT uniquement).

categorie_matieres_constitutives_id  integer  
L'identifiant de la valeur du référentiel categorieatieresconstitutives (type FERTILISANT uniquement).

annee_inscription  integer  
L'année d'inscription du produit (type SEMENCE uniquement).

informations_complementaires  string  
Les informations complémentaires sur le produit (type SEMENCE uniquement).

serie  string  
La série du produit (type SEMENCE uniquement).

typ_var1  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var2  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var3  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var4  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

typ_var5  string  
Je sais pas ce que c'est XD (type SEMENCE uniquement).

code_obtenteur  string  
Le code obtenteur du produit (type SEMENCE uniquement).

code_ctps  string  
Le code organisme de validation des variétés apportant un 'plus' (type SEMENCE uniquement).

code_gnis  string  
Le code GNIS du produit (type SEMENCE uniquement).

Supprimer

requires authentication

Supprime un produit

Example request:

curl -X DELETE \
    "https://api.oss.coop/produit/17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/17"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/produit/17',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE produit/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du produit.

Composant - Lister

requires authentication

Liste des composants d'un produit

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit/1/composition" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/1/composition"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit/1/composition',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "composant1",
            "nom": "composant",
            "observation": null,
            "pivot": {
                "quantite": "12",
                "unite": { ... }
            },
            "produit_type": { ... },
            "thematique": { ... }
        }
    ]
}

Request   

GET produit/{uid:[0-9]+}/composition

URL Parameters

uid  integer  
L'identifiant du produit.

Composant - Modifier

requires authentication

Modifie les composants d'un produit

Example request:

curl -X PUT \
    "https://api.oss.coop/produit/1/composition" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"composants":[{"uid":"2","quantite":"20","unite_uid":"unite1"},{"uid":"2","quantite":"20","unite_uid":"unite1"}]}'

const url = new URL(
    "https://api.oss.coop/produit/1/composition"
);

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

let body = {
    "composants": [
        {
            "uid": "2",
            "quantite": "20",
            "unite_uid": "unite1"
        },
        {
            "uid": "2",
            "quantite": "20",
            "unite_uid": "unite1"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/produit/1/composition',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'composants' => [
                [
                    'uid' => '2',
                    'quantite' => '20',
                    'unite_uid' => 'unite1',
                ],
                [
                    'uid' => '2',
                    'quantite' => '20',
                    'unite_uid' => 'unite1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "uid": "composant2",
            "nom": "composant2",
            "observation": null,
            "pivot": {
                "quantite": "20",
                "unite": { ... }
            },
            "produit_type": null,
            "thematique": null
        }
    ]
}

Request   

PUT produit/{uid:[0-9]+}/composition

URL Parameters

uid  integer  
L'identifiant du produit.

Body Parameters

composants  object[]  
Les composants du profil.

composants[].uid  string  
Un identifiant unique de composant existant.

composants[].quantite  numeric  
La quantite du composant d'un produit.

composants[].unite_uid  string  
Un identifiant unique d'une unité de mesure de la quantité du composant d'un produit.

Dose - Lister

requires authentication

Liste des doses d'un produit

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit/1/dose?sort=nom.ASC%2Cid.DESC&page=9&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/1/dose"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit/1/dose',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "dose": "12",
            "unite": { ... },
            "culture": { ... },
            "cible": { ... }
        }
    ]
}

Request   

GET produit/{puid:[0-9]+}/dose

URL Parameters

puid  integer  
L'identifiant du produit.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Dose - Voir

requires authentication

Détails d'une dose d'un produit

Example request:

curl -X GET \
    -G "https://api.oss.coop/produit/1/dose/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/1/dose/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/produit/1/dose/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "dose": "12",
        "unite": { ... },
        "culture": { ... },
        "cible": { ... }
    }
}

Request   

GET produit/{puid:[0-9]+}/dose/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du produit.

uid  integer  
L'identifiant de la dose.

Dose - Ajouter

requires authentication

Ajoute une dose à un produit

Example request:

curl -X POST \
    "https://api.oss.coop/produit/1/dose" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"dose":"42","unite_uid":"unite1","culture_uid":"culture1","cible_id":"1"}'

const url = new URL(
    "https://api.oss.coop/produit/1/dose"
);

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

let body = {
    "dose": "42",
    "unite_uid": "unite1",
    "culture_uid": "culture1",
    "cible_id": "1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/produit/1/dose',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'dose' => '42',
            'unite_uid' => 'unite1',
            'culture_uid' => 'culture1',
            'cible_id' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "dose": "42",
        "unite": { ... },
        "culture": { ... },
        "cible": { ... }
    }
}

Request   

POST produit/{puid:[0-9]+}/dose

URL Parameters

puid  integer  
L'identifiant du produit.

Body Parameters

dose  numeric  
La dose.

unite_uid  string  
Lidentifiant unique de l'unité de la dose.

culture_uid  string optional  
Lidentifiant unique de la culture de la dose.

cible_id  string optional  
Lidentifiant de la cible de la dose.

Dose - Modifier

requires authentication

Modifie une dose d'un produit

Example request:

curl -X PUT \
    "https://api.oss.coop/produit/1/dose/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"dose":"42","unite_uid":"unite1","culture_uid":"null","cible_id":"null"}'

const url = new URL(
    "https://api.oss.coop/produit/1/dose/2"
);

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

let body = {
    "dose": "42",
    "unite_uid": "unite1",
    "culture_uid": "null",
    "cible_id": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/produit/1/dose/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'dose' => '42',
            'unite_uid' => 'unite1',
            'culture_uid' => 'null',
            'cible_id' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "dose": "42",
        "unite": { ... },
        "culture": null,
        "cible": null
    }
}

Request   

PUT produit/{puid:[0-9]+}/dose/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du produit.

uid  integer  
L'identifiant de la dose.

Body Parameters

dose  numeric  
La dose.

unite_uid  string  
Lidentifiant unique de l'unité de la dose.

culture_uid  string optional  
Lidentifiant unique de la culture de la dose.

cible_id  string optional  
Lidentifiant de la cible de la dose.

Dose - Supprimer

requires authentication

Supprime une dose d'un produit

Example request:

curl -X DELETE \
    "https://api.oss.coop/produit/1/dose/13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/produit/1/dose/13"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/produit/1/dose/13',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE produit/{puid:[0-9]+}/dose/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du produit.

uid  integer  
L'identifiant du contact.

Profils

Lister

requires authentication

Liste des profils

Example request:

curl -X GET \
    -G "https://api.oss.coop/profil?sort=nom.ASC%2Cid.DESC&page=16&limit=14" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/profil"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/profil',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET profil

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un profil

Example request:

curl -X GET \
    -G "https://api.oss.coop/profil/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/profil/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/profil/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "designation": "valeur"
    }
}

Request   

GET profil/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du profil.

Ajouter

requires authentication

Ajoute un profil

Example request:

curl -X POST \
    "https://api.oss.coop/profil" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","designation":"valeur2"}'

const url = new URL(
    "https://api.oss.coop/profil"
);

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

let body = {
    "uid": "id_unique_universel2",
    "designation": "valeur2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/profil',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'designation' => 'valeur2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "designation": "valeur2"
    }
}

Request   

POST profil

Body Parameters

uid  string  
L'identifiant unique du profil.

designation  string  
La designation du profil.

Modifier

requires authentication

Modifie un profil

Example request:

curl -X PUT \
    "https://api.oss.coop/profil/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","designation":"valeur3"}'

const url = new URL(
    "https://api.oss.coop/profil/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "designation": "valeur3"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/profil/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'designation' => 'valeur3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "designation": "valeur3"
    }
}

Request   

PUT profil/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du profil.

Body Parameters

uid  string  
L'identifiant unique du profil.

designation  string  
La designation du profil.

Supprimer

requires authentication

Supprime un profil

Example request:

curl -X DELETE \
    "https://api.oss.coop/profil/18" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/profil/18"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/profil/18',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE profil/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du profil.

Droit - Lister

requires authentication

Liste des droits d'un profil

Example request:

curl -X GET \
    -G "https://api.oss.coop/profil/1/droit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/profil/1/droit"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/profil/1/droit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "categorie": {
                "id": 1,
                "uid": "id_unique_universel",
                "designation": "valeur"
            },
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET profil/{uid:[0-9]+}/droit

URL Parameters

uid  integer  
L'identifiant du profil.

Droit - Modifier

requires authentication

Modifie les droits d'un profil

Example request:

curl -X PUT \
    "https://api.oss.coop/profil/1/droit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"droits":[{"uid":"id_unique_universel2"},{"uid":"id_unique_universel2"}]}'

const url = new URL(
    "https://api.oss.coop/profil/1/droit"
);

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

let body = {
    "droits": [
        {
            "uid": "id_unique_universel2"
        },
        {
            "uid": "id_unique_universel2"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/profil/1/droit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'droits' => [
                [
                    'uid' => 'id_unique_universel2',
                ],
                [
                    'uid' => 'id_unique_universel2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "categorie": {
                "id": 1,
                "uid": "id_unique_universel",
                "designation": "valeur"
            },
            "uid": "id_unique_universel2",
            "designation": "valeur2"
        }
    ]
}

Request   

PUT profil/{uid:[0-9]+}/droit

URL Parameters

uid  integer  
L'identifiant du profil.

Body Parameters

droits  object[]  
Les droits du profil.

droits[].uid  string  
Un identifiant de droit unique existant.

Type Entité - Lister

requires authentication

Liste des types d'entités d'un profil

Example request:

curl -X GET \
    -G "https://api.oss.coop/profil/1/entite_type" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/profil/1/entite_type"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/profil/1/entite_type',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET profil/{uid:[0-9]+}/entite_type

URL Parameters

uid  integer  
L'identifiant du profil.

Type Entité - Modifier

requires authentication

Modifie les types d'entités d'un profil

Example request:

curl -X PUT \
    "https://api.oss.coop/profil/1/entite_type" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"entite_types":[{"uid":"id_unique_universel2"},{"uid":"id_unique_universel2"}]}'

const url = new URL(
    "https://api.oss.coop/profil/1/entite_type"
);

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

let body = {
    "entite_types": [
        {
            "uid": "id_unique_universel2"
        },
        {
            "uid": "id_unique_universel2"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/profil/1/entite_type',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'entite_types' => [
                [
                    'uid' => 'id_unique_universel2',
                ],
                [
                    'uid' => 'id_unique_universel2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "uid": "id_unique_universel2",
            "designation": "valeur2"
        }
    ]
}

Request   

PUT profil/{uid:[0-9]+}/entite_type

URL Parameters

uid  integer  
L'identifiant du profil.

Body Parameters

entite_types  object[]  
Les types d'entité du profil.

entite_types[].uid  string  
Un identifiant de type d'entité unique existant.

Protocoles

Lister

requires authentication

Liste des protocoles créés ou acceptés

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole?sort=nom.ASC%2Cid.DESC&page=2&limit=19" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "2",
    "limit": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '2',
            'limit'=> '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "titre": "Super protocole",
            "donneur_ordre": "Mathieu",
            "donneur_ordre_code": "God",
            "donneur_ordre_contact": "Grand bureau",
            "numero_devis": "AZERTYUIOP123",
            "commentaires": "Un commentaire",
            "objectifs": "Finir le dev de la phase C",
            "situation_a_favoriser": "La glande",
            "secteur_geographique": "Le lac",
            "orientation_semis": "↑↑↓↓←→←→BA",
            "type_sol": "Cendres",
            "mode_appl_phyto": "La j'ai pas d'idée",
            "methodes_internes": "Pas mieux",
            "methode_ceb_reference": "Mais c'est quoi ces noms de champs ?",
            "guidelines_oepp_reference": "Quelqu'un comprend ?",
            "observations": "ça je sais, c'est une observation mais pas un commentaire",
            "couvertures_possibles": "Couette",
            "couvertures_interdites": "Peau d'ours vivant",
            "tests_statistiques": "Mes valeurs de champs sont-elles drôles ?",
            "national_qualification": "Concour de dad jokes !",
            "type_qualification": "La grosse poilade !",
            "objectif_qualification": "Être drôle avec des blagues pourrites",
            "code_national": "FR",
            "code_regional": "AL",
            "code_entite": "Dia",
            "surface_microparcelles": "0.4",
            "volume_bouillie": "12.4",
            "nombre_blocs": 145,
            "agriculture_biologique": true,
            "utilisation_phyto": true,
            "contamination_artificielle": true,
            "brumisation": true,
            "prestation_service": true,
            "agriculture_biologique": false,
            "bpe": true,
            "partage_accepte": null,
            "date_partage": null,
            "type": { ... },
            "statut": { ... },
            "dispositif_experimental": { ... },
            "thematique": { ... },
            "unite": { ... },
            "implantation_temoins": { ... },
            "annee_recolte": { ... },
            "declaration_protocole": { ... }
            "cibles": [ ... ]
        }
    ]
}

Request   

GET protocole

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Lister - Paratages

requires authentication

Liste des protocoles partagés avec mon entité

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/partage?sort=nom.ASC%2Cid.DESC&page=1&limit=4" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/partage"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "1",
    "limit": "4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/partage',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '1',
            'limit'=> '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "titre": "Super protocole",
            "donneur_ordre": "Mathieu",
            "donneur_ordre_code": "God",
            "donneur_ordre_contact": "Grand bureau",
            "numero_devis": "AZERTYUIOP123",
            "commentaires": "Un commentaire",
            "objectifs": "Finir le dev de la phase C",
            "situation_a_favoriser": "La glande",
            "secteur_geographique": "Le lac",
            "orientation_semis": "↑↑↓↓←→←→BA",
            "type_sol": "Cendres",
            "mode_appl_phyto": "La j'ai pas d'idée",
            "methodes_internes": "Pas mieux",
            "methode_ceb_reference": "Mais c'est quoi ces noms de champs ?",
            "guidelines_oepp_reference": "Quelqu'un comprend ?",
            "observations": "ça je sais, c'est une observation mais pas un commentaire",
            "couvertures_possibles": "Couette",
            "couvertures_interdites": "Peau d'ours vivant",
            "tests_statistiques": "Mes valeurs de champs sont-elles drôles ?",
            "national_qualification": "Concour de dad jokes !",
            "type_qualification": "La grosse poilade !",
            "objectif_qualification": "Être drôle avec des blagues pourrites",
            "code_national": "FR",
            "code_regional": "AL",
            "code_entite": "Dia",
            "surface_microparcelles": "0.4",
            "volume_bouillie": "12.4",
            "nombre_blocs": 145,
            "agriculture_biologique": true,
            "utilisation_phyto": true,
            "contamination_artificielle": true,
            "brumisation": true,
            "prestation_service": true,
            "agriculture_biologique": false,
            "bpe": true,
            "partage_accepte": null,
            "date_partage": null,
            "type": { ... },
            "statut": { ... },
            "dispositif_experimental": { ... },
            "thematique": { ... },
            "unite": { ... },
            "implantation_temoins": { ... },
            "annee_recolte": { ... },
            "declaration_protocole": { ... }
            "cibles": [ ... ]
        }
    ]
}

Request   

GET protocole/partage

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Lister - Enfants accèptés

requires authentication

Liste des protocoles des entitées enfant

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/enfants?sort=nom.ASC%2Cid.DESC&page=7&limit=9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/enfants"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "7",
    "limit": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/enfants',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '7',
            'limit'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "titre": "Super protocole",
            "donneur_ordre": "Mathieu",
            "donneur_ordre_code": "God",
            "donneur_ordre_contact": "Grand bureau",
            "numero_devis": "AZERTYUIOP123",
            "commentaires": "Un commentaire",
            "objectifs": "Finir le dev de la phase C",
            "situation_a_favoriser": "La glande",
            "secteur_geographique": "Le lac",
            "orientation_semis": "↑↑↓↓←→←→BA",
            "type_sol": "Cendres",
            "mode_appl_phyto": "La j'ai pas d'idée",
            "methodes_internes": "Pas mieux",
            "methode_ceb_reference": "Mais c'est quoi ces noms de champs ?",
            "guidelines_oepp_reference": "Quelqu'un comprend ?",
            "observations": "ça je sais, c'est une observation mais pas un commentaire",
            "couvertures_possibles": "Couette",
            "couvertures_interdites": "Peau d'ours vivant",
            "tests_statistiques": "Mes valeurs de champs sont-elles drôles ?",
            "national_qualification": "Concour de dad jokes !",
            "type_qualification": "La grosse poilade !",
            "objectif_qualification": "Être drôle avec des blagues pourrites",
            "code_national": "FR",
            "code_regional": "AL",
            "code_entite": "Dia",
            "surface_microparcelles": "0.4",
            "volume_bouillie": "12.4",
            "nombre_blocs": 145,
            "agriculture_biologique": true,
            "utilisation_phyto": true,
            "contamination_artificielle": true,
            "brumisation": true,
            "prestation_service": true,
            "agriculture_biologique": false,
            "bpe": true,
            "partage_accepte": null,
            "date_partage": null,
            "type": { ... },
            "statut": { ... },
            "dispositif_experimental": { ... },
            "thematique": { ... },
            "unite": { ... },
            "implantation_temoins": { ... },
            "annee_recolte": { ... },
            "declaration_protocole": { ... }
            "cibles": [ ... ]
        }
    ]
}

Request   

GET protocole/enfants

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Lister - Enfants

requires authentication

Liste des protocoles partagés de mon entité

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/{uid:[0-9]+}/enfants?sort=nom.ASC%2Cid.DESC&page=17&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/{uid:[0-9]+}/enfants"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "17",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/{uid:[0-9]+}/enfants',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '17',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "titre": "Super protocole",
            "donneur_ordre": "Mathieu",
            "donneur_ordre_code": "God",
            "donneur_ordre_contact": "Grand bureau",
            "numero_devis": "AZERTYUIOP123",
            "commentaires": "Un commentaire",
            "objectifs": "Finir le dev de la phase C",
            "situation_a_favoriser": "La glande",
            "secteur_geographique": "Le lac",
            "orientation_semis": "↑↑↓↓←→←→BA",
            "type_sol": "Cendres",
            "mode_appl_phyto": "La j'ai pas d'idée",
            "methodes_internes": "Pas mieux",
            "methode_ceb_reference": "Mais c'est quoi ces noms de champs ?",
            "guidelines_oepp_reference": "Quelqu'un comprend ?",
            "observations": "ça je sais, c'est une observation mais pas un commentaire",
            "couvertures_possibles": "Couette",
            "couvertures_interdites": "Peau d'ours vivant",
            "tests_statistiques": "Mes valeurs de champs sont-elles drôles ?",
            "national_qualification": "Concour de dad jokes !",
            "type_qualification": "La grosse poilade !",
            "objectif_qualification": "Être drôle avec des blagues pourrites",
            "code_national": "FR",
            "code_regional": "AL",
            "code_entite": "Dia",
            "surface_microparcelles": "0.4",
            "volume_bouillie": "12.4",
            "nombre_blocs": 145,
            "agriculture_biologique": true,
            "utilisation_phyto": true,
            "contamination_artificielle": true,
            "brumisation": true,
            "prestation_service": true,
            "agriculture_biologique": false,
            "bpe": true,
            "partage_accepte": null,
            "date_partage": null,
            "type": { ... },
            "statut": { ... },
            "dispositif_experimental": { ... },
            "thematique": { ... },
            "unite": { ... },
            "implantation_temoins": { ... },
            "annee_recolte": { ... },
            "declaration_protocole": { ... }
            "cibles": [ ... ]
        }
    ]
}

Request   

GET protocole/{uid:[0-9]+}/enfants

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "titre": "Super protocole",
        "donneur_ordre": "Mathieu",
        "donneur_ordre_code": "God",
        "donneur_ordre_contact": "Grand bureau",
        "numero_devis": "AZERTYUIOP123",
        "commentaires": "Un commentaire",
        "objectifs": "Finir le dev de la phase C",
        "situation_a_favoriser": "La glande",
        "secteur_geographique": "Le lac",
        "orientation_semis": "↑↑↓↓←→←→BA",
        "type_sol": "Cendres",
        "mode_appl_phyto": "La j'ai pas d'idée",
        "methodes_internes": "Pas mieux",
        "methode_ceb_reference": "Mais c'est quoi ces noms de champs ?",
        "guidelines_oepp_reference": "Quelqu'un comprend ?",
        "observations": "ça je sais, c'est une observation mais pas un commentaire",
        "couvertures_possibles": "Couette",
        "couvertures_interdites": "Peau d'ours vivant",
        "tests_statistiques": "Mes valeurs de champs sont-elles drôles ?",
        "national_qualification": "Concour de dad jokes !",
        "type_qualification": "La grosse poilade !",
        "objectif_qualification": "Être drôle avec des blagues pourrites",
        "code_national": "FR",
        "code_regional": "AL",
        "code_entite": "Dia",
        "surface_microparcelles": "0.4",
        "volume_bouillie": "12.4",
        "nombre_blocs": 145,
        "agriculture_biologique": true,
        "utilisation_phyto": true,
        "contamination_artificielle": true,
        "brumisation": true,
        "prestation_service": true,
        "agriculture_biologique": false,
        "bpe": true,
        "partage_accepte": null,
        "date_partage": null,
        "type": { ... },
        "statut": { ... },
        "dispositif_experimental": { ... },
        "thematique": { ... },
        "unite": { ... },
        "implantation_temoins": { ... },
        "annee_recolte": { ... },
        "declaration_protocole": { ... }
        "cibles": [ ... ]
    }
}

Request   

GET protocole/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du protocole.

Ajouter

requires authentication

Ajoute un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"titre":"Protocole2","donneur_ordre":"Barbapapa","donneur_ordre_code":"ULAHUP","donneur_ordre_contact":"Barbatruc","numero_devis":"AZERTYUIOP789","commentaires":"Un autre commentaire","objectifs":"Passer au dev de la phase D","situation_a_favoriser":"La communication !","secteur_geographique":"Sous l'oc\u00e9an","orientation_semis":"Vers la mecque","type_sol":"Tapis","mode_appl_phyto":"Avion","methodes_internes":"L'imagination me manque","methode_ceb_reference":"Je renonce \u00e0 tout... \u00e0 l'amour, aux plaisirs, \u00e0 la vie...","guidelines_oepp_reference":"Beware, beware. I am the prince of drakness. Beware ! Beware !","observations":"Comme commentaire \u00e9tait d\u00e9j\u00e0 utilis\u00e9...","couvertures_possibles":"Y'a des jours comme \u00e7a, on ne sait plus qui on est ni o\u00f9 on va...","couvertures_interdites":"Qui suis-je ? O\u00f9 vais-je ? Dans quel \u00e9tat j'erre...","tests_statistiques":"Le nombre moyen d'imb\u00e9ciles qui vont lire les d\u00e9scriptifs de la doc","national_qualification":"Celui qui \u00e0 lu le commentaire de param\u00e8tre pr\u00e9c\u00e9dent \u00e0 \u00e9t\u00e9 nationalement qualifi\u00e9 d'imb\u00e9cile...","type_qualification":"Imb\u00e9cile est une insulte mais c'est gentil quand c'est \u00e9crit avec hamour (c'est de l'amour dr\u00f4le, une blague orthographique quoi)","objectif_qualification":"Faire rire, pleurer, ... Mais surtout, m'occuper","code_national":"Franchemant, qui aime \u00e9crire de la doc ?","code_regional":"Sur 4h de dev, je passe 1h \u00e0 code et 3h \u00e0 faire la doc...","code_entite":"Je suis gav\u00e9. Comme mort \u00e0 l'int\u00e9rieur","surface_microparcelles":"D\u00e9senchant\u00e9, cette documentation m'a vol\u00e9 mes r\u00eaves","volume_bouillie":"Un volume de bouillie ? S\u00e9rieusement ?","nombre_blocs":42,"agriculture_biologique":false,"utilisation_phyto":false,"prestation_service":false,"contamination_artificielle":false,"brumisation":false,"bpe":false,"type_uid":"type1","dispositif_experimental_uid":"de1","thematique_uid":"thematique1","unite_uid":"unite1","implantation_temoins_id":1,"annee_recolte_id":1,"declaration_protocole_id":1,"sous_thematiques":[{"uid":"1"},[]],"cultures":[{"uid":"1"},{"uid":"1"}],"cibles":[{"id":1},{"id":1}]}'

const url = new URL(
    "https://api.oss.coop/protocole"
);

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

let body = {
    "titre": "Protocole2",
    "donneur_ordre": "Barbapapa",
    "donneur_ordre_code": "ULAHUP",
    "donneur_ordre_contact": "Barbatruc",
    "numero_devis": "AZERTYUIOP789",
    "commentaires": "Un autre commentaire",
    "objectifs": "Passer au dev de la phase D",
    "situation_a_favoriser": "La communication !",
    "secteur_geographique": "Sous l'oc\u00e9an",
    "orientation_semis": "Vers la mecque",
    "type_sol": "Tapis",
    "mode_appl_phyto": "Avion",
    "methodes_internes": "L'imagination me manque",
    "methode_ceb_reference": "Je renonce \u00e0 tout... \u00e0 l'amour, aux plaisirs, \u00e0 la vie...",
    "guidelines_oepp_reference": "Beware, beware. I am the prince of drakness. Beware ! Beware !",
    "observations": "Comme commentaire \u00e9tait d\u00e9j\u00e0 utilis\u00e9...",
    "couvertures_possibles": "Y'a des jours comme \u00e7a, on ne sait plus qui on est ni o\u00f9 on va...",
    "couvertures_interdites": "Qui suis-je ? O\u00f9 vais-je ? Dans quel \u00e9tat j'erre...",
    "tests_statistiques": "Le nombre moyen d'imb\u00e9ciles qui vont lire les d\u00e9scriptifs de la doc",
    "national_qualification": "Celui qui \u00e0 lu le commentaire de param\u00e8tre pr\u00e9c\u00e9dent \u00e0 \u00e9t\u00e9 nationalement qualifi\u00e9 d'imb\u00e9cile...",
    "type_qualification": "Imb\u00e9cile est une insulte mais c'est gentil quand c'est \u00e9crit avec hamour (c'est de l'amour dr\u00f4le, une blague orthographique quoi)",
    "objectif_qualification": "Faire rire, pleurer, ... Mais surtout, m'occuper",
    "code_national": "Franchemant, qui aime \u00e9crire de la doc ?",
    "code_regional": "Sur 4h de dev, je passe 1h \u00e0 code et 3h \u00e0 faire la doc...",
    "code_entite": "Je suis gav\u00e9. Comme mort \u00e0 l'int\u00e9rieur",
    "surface_microparcelles": "D\u00e9senchant\u00e9, cette documentation m'a vol\u00e9 mes r\u00eaves",
    "volume_bouillie": "Un volume de bouillie ? S\u00e9rieusement ?",
    "nombre_blocs": 42,
    "agriculture_biologique": false,
    "utilisation_phyto": false,
    "prestation_service": false,
    "contamination_artificielle": false,
    "brumisation": false,
    "bpe": false,
    "type_uid": "type1",
    "dispositif_experimental_uid": "de1",
    "thematique_uid": "thematique1",
    "unite_uid": "unite1",
    "implantation_temoins_id": 1,
    "annee_recolte_id": 1,
    "declaration_protocole_id": 1,
    "sous_thematiques": [
        {
            "uid": "1"
        },
        []
    ],
    "cultures": [
        {
            "uid": "1"
        },
        {
            "uid": "1"
        }
    ],
    "cibles": [
        {
            "id": 1
        },
        {
            "id": 1
        }
    ]
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'titre' => 'Protocole2',
            'donneur_ordre' => 'Barbapapa',
            'donneur_ordre_code' => 'ULAHUP',
            'donneur_ordre_contact' => 'Barbatruc',
            'numero_devis' => 'AZERTYUIOP789',
            'commentaires' => 'Un autre commentaire',
            'objectifs' => 'Passer au dev de la phase D',
            'situation_a_favoriser' => 'La communication !',
            'secteur_geographique' => 'Sous l\'océan',
            'orientation_semis' => 'Vers la mecque',
            'type_sol' => 'Tapis',
            'mode_appl_phyto' => 'Avion',
            'methodes_internes' => 'L\'imagination me manque',
            'methode_ceb_reference' => 'Je renonce à tout... à l\'amour, aux plaisirs, à la vie...',
            'guidelines_oepp_reference' => 'Beware, beware. I am the prince of drakness. Beware ! Beware !',
            'observations' => 'Comme commentaire était déjà utilisé...',
            'couvertures_possibles' => 'Y\'a des jours comme ça, on ne sait plus qui on est ni où on va...',
            'couvertures_interdites' => 'Qui suis-je ? Où vais-je ? Dans quel état j\'erre...',
            'tests_statistiques' => 'Le nombre moyen d\'imbéciles qui vont lire les déscriptifs de la doc',
            'national_qualification' => 'Celui qui à lu le commentaire de paramètre précédent à été nationalement qualifié d\'imbécile...',
            'type_qualification' => 'Imbécile est une insulte mais c\'est gentil quand c\'est écrit avec hamour (c\'est de l\'amour drôle, une blague orthographique quoi)',
            'objectif_qualification' => 'Faire rire, pleurer, ... Mais surtout, m\'occuper',
            'code_national' => 'Franchemant, qui aime écrire de la doc ?',
            'code_regional' => 'Sur 4h de dev, je passe 1h à code et 3h à faire la doc...',
            'code_entite' => 'Je suis gavé. Comme mort à l\'intérieur',
            'surface_microparcelles' => 'Désenchanté, cette documentation m\'a volé mes rêves',
            'volume_bouillie' => 'Un volume de bouillie ? Sérieusement ?',
            'nombre_blocs' => 42,
            'agriculture_biologique' => false,
            'utilisation_phyto' => false,
            'prestation_service' => false,
            'contamination_artificielle' => false,
            'brumisation' => false,
            'bpe' => false,
            'type_uid' => 'type1',
            'dispositif_experimental_uid' => 'de1',
            'thematique_uid' => 'thematique1',
            'unite_uid' => 'unite1',
            'implantation_temoins_id' => 1,
            'annee_recolte_id' => 1,
            'declaration_protocole_id' => 1,
            'sous_thematiques' => [
                [
                    'uid' => '1',
                ],
                [],
            ],
            'cultures' => [
                [
                    'uid' => '1',
                ],
                [
                    'uid' => '1',
                ],
            ],
            'cibles' => [
                [
                    'id' => 1,
                ],
                [
                    'id' => 1,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "titre": "Protocole2",
        "donneur_ordre": "Barbapapa",
        "donneur_ordre_code": "ULAHUP",
        "donneur_ordre_contact": "Barbatruc",
        "numero_devis": "AZERTYUIOP789",
        "commentaires": "Un autre commentaire",
        "objectifs": "Passer au dev de la phase DC",
        "situation_a_favoriser": "La communication !",
        "secteur_geographique": "Sous l'océan",
        "orientation_semis": "Vers la mecque",
        "type_sol": "Tapis",
        "mode_appl_phyto": "Avion",
        "methodes_internes": "L'imagination me manque",
        "methode_ceb_reference": "Je renonce à tout... à l'amour, aux plaisirs, à la vie...",
        "guidelines_oepp_reference": "Beware, beware. I am the prince of drakness. Beware ! Beware !",
        "observations": "Comme commentaire était déjà utilisé...",
        "couvertures_possibles": "Y'a des jours comme ça, on ne sait plus qui on est ni où on va...",
        "couvertures_interdites": "Qui suis-je ? Où vais-je ? Dans quel état j'erre...",
        "tests_statistiques": "Le nombre moyen d'imbéciles qui vont lire les déscriptifs de la doc",
        "national_qualification": "Celui qui à lu le commentaire de paramètre précédent à été nationalement qualifié d'imbécile...",
        "type_qualification": "Imbécile est une insulte mais c'est gentil quand c'est écrit avec hamour (c'est de l'amour drôle)",
        "objectif_qualification": "Faire rire, pleurer, ... Mais surtout, m'occuper",
        "code_national": "Franchemant, qui aime écrire de la doc ?",
        "code_regional": "Sur 4h de dev, je passe 1h à code et 3h à faire la doc...",
        "code_entite": "Je suis gavé. Comme mort à l'intérieur",
        "surface_microparcelles": "Désenchanté, cette documentation m'a volé mes rêves",
        "volume_bouillie": "Un volume de bouillie ? Sérieusement ?",
        "nombre_blocs": 42,
        "agriculture_biologique": false,
        "utilisation_phyto": false,
        "contamination_artificielle": false,
        "brumisation": false,
        "prestation_service": false,
        "agriculture_biologique": false,
        "bpe": false,
        "partage_accepte": null,
        "date_partage": "2021-06-14 17:27:35.911688+02",
        "type": { ... },
        "statut": { ... },
        "dispositif_experimental": { ... },
        "thematique": { ... },
        "unite": { ... },
        "implantation_temoins": { ... },
        "annee_recolte": { ... },
        "declaration_protocole": { ... },
        "cibles": [ ... ]
    }
}

Request   

POST protocole

Body Parameters

titre  string optional  
Le titre du protocole.

donneur_ordre  string optional  
Le nom du donneur d'ordre du protocole.

donneur_ordre_code  string optional  
Le code du donneur d'ordre du protocole.

donneur_ordre_contact  string optional  
Le contact du donneur d'ordre du protocole.

numero_devis  string optional  
Le de devis du protocole.

commentaires  string optional  
Les commentaires du protocole.

objectifs  string optional  
L'objectifs du protocole.

situation_a_favoriser  string optional  
La situation à favoriser durant le protocole.

secteur_geographique  string optional  
Le sécteur géographique du protocole.

orientation_semis  string optional  
L'orientation des semis du protocole.

type_sol  string optional  
Le type de sol utilisé pour le protocole.

mode_appl_phyto  string optional  
Le mode d'application des produit phytosanitaire durant protocole.

methodes_internes  string optional  
Les méthodes internes du protocole.

methode_ceb_reference  string optional  
La méthode CEB de référence du protocole.

guidelines_oepp_reference  string optional  
Les guidelines OEPP de référence du protocole.

observations  string optional  
Les observations sur le protocole.

couvertures_possibles  string optional  
Les couvertures possibles du protocole.

couvertures_interdites  string optional  
Les couvertures interdites du protocole.

tests_statistiques  string optional  
Les tests statistiques prévus sur le protocole.

national_qualification  string optional  
La qualification nationale du protocole.

type_qualification  string optional  
Le type de qualification nationale du protocole.

objectif_qualification  string optional  
L'objectif de qualification nationale du protocole.

code_national  string optional  
Le code national du protocole.

code_regional  string optional  
Le code régional du protocole.

code_entite  string optional  
Le code entité du protocole.

surface_microparcelles  numeric optional  
Le surface de microparcelles du protocole.

volume_bouillie  numeric optional  
Le volume de bouillie du protocole.

nombre_blocs  integer optional  
Le nombre de blocs du protocole.

agriculture_biologique  boolean optional  
Le caractère de prestation de service du protocole.

utilisation_phyto  boolean optional  
L'utilisation de produits phytosanitaires au cours du protocole.

prestation_service  boolean optional  
Le caractère de prestation de service du protocole.

contamination_artificielle  boolean optional  
La simulation d'une contamination au cours du protocole.

brumisation  boolean optional  
La brumisation au cours du protocole.

bpe  boolean optional  
La caractère BPD du protocole.

type_uid  string  
L'identifiant unique du type du protocole.

dispositif_experimental_uid  string optional  
L'identifiant unique du dispositif experimental associé au protocole.

thematique_uid  string  
L'identifiant unique de la thematique du protocole.

unite_uid  string optional  
L'identifiant unique de l'unité utilisée dans le protocole.

implantation_temoins_id  integer optional  
L'identifiant de la valeur du référentiel implantationtemoins.

annee_recolte_id  integer optional  
L'identifiant de la valeur du référentiel anneerecolte.

declaration_protocole_id  integer optional  
L'identifiant de la valeur du référentiel declarationprotocole.

sous_thematiques  object[] optional  
Les sous thematiques du produit.

sous_thematiques[].uid  string optional  
Un identifiant unique de thematique existant.

cultures  object[] optional  
Les cultures du produit.

cultures[].uid  string optional  
Un identifiant unique de thematique existant.

cibles  object[] optional  
Les cibles du produit.

cibles[].id  integer optional  
L'identifiant de la valeur du référentiel cible.

Modifier

requires authentication

Modifie un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"titre":"Protocole2","donneur_ordre":"Barbapapa","donneur_ordre_code":"ULAHUP","donneur_ordre_contact":"Barbatruc","numero_devis":"AZERTYUIOP789","commentaires":"Un autre commentaire","objectifs":"Passer au dev de la phase D","situation_a_favoriser":"La communication !","secteur_geographique":"Sous l'oc\u00e9an","orientation_semis":"Vers la mecque","type_sol":"Tapis","mode_appl_phyto":"Avion","methodes_internes":"L'imagination me manque","methode_ceb_reference":"Je renonce \u00e0 tout... \u00e0 l'amour, aux plaisirs, \u00e0 la vie...","guidelines_oepp_reference":"Beware, beware. I am the prince of drakness. Beware ! Beware !","observations":"Comme commentaire \u00e9tait d\u00e9j\u00e0 utilis\u00e9...","couvertures_possibles":"Y'a des jours comme \u00e7a, on ne sait plus qui on est ni o\u00f9 on va...","couvertures_interdites":"Qui suis-je ? O\u00f9 vais-je ? Dans quel \u00e9tat j'erre...","tests_statistiques":"Le nombre moyen d'imb\u00e9ciles qui vont lire les d\u00e9scriptifs de la doc","national_qualification":"Celui qui \u00e0 lu le commentaire de param\u00e8tre pr\u00e9c\u00e9dent \u00e0 \u00e9t\u00e9 nationalement qualifi\u00e9 d'imb\u00e9cile...","type_qualification":"Imb\u00e9cile est une insulte mais c'est gentil quand c'est \u00e9crit avec hamour (c'est de l'amour dr\u00f4le, une blague orthographique quoi)","objectif_qualification":"Faire rire, pleurer, ... Mais surtout, m'occuper","code_national":"Franchemant, qui aime \u00e9crire de la doc ?","code_regional":"Sur 4h de dev, je passe 1h \u00e0 code et 3h \u00e0 faire la doc...","code_entite":"Je suis gav\u00e9. Comme mort \u00e0 l'int\u00e9rieur","surface_microparcelles":"D\u00e9senchant\u00e9, cette documentation m'a vol\u00e9 mes r\u00eaves","volume_bouillie":"Un volume de bouillie ? S\u00e9rieusement ?","nombre_blocs":42,"agriculture_biologique":true,"utilisation_phyto":false,"prestation_service":false,"contamination_artificielle":false,"brumisation":false,"bpe":false,"type_uid":"type1","dispositif_experimental_uid":"de1","thematique_uid":"thematique1","unite_uid":"unite1","implantation_temoins_id":1,"annee_recolte_id":1,"declaration_protocole_id":1,"sous_thematiques":[{"uid":"2"},[]],"cultures":[{"uid":"2"},{"uid":"2"}],"cibles":[{"id":1},{"id":1}]}'

const url = new URL(
    "https://api.oss.coop/protocole/2"
);

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

let body = {
    "titre": "Protocole2",
    "donneur_ordre": "Barbapapa",
    "donneur_ordre_code": "ULAHUP",
    "donneur_ordre_contact": "Barbatruc",
    "numero_devis": "AZERTYUIOP789",
    "commentaires": "Un autre commentaire",
    "objectifs": "Passer au dev de la phase D",
    "situation_a_favoriser": "La communication !",
    "secteur_geographique": "Sous l'oc\u00e9an",
    "orientation_semis": "Vers la mecque",
    "type_sol": "Tapis",
    "mode_appl_phyto": "Avion",
    "methodes_internes": "L'imagination me manque",
    "methode_ceb_reference": "Je renonce \u00e0 tout... \u00e0 l'amour, aux plaisirs, \u00e0 la vie...",
    "guidelines_oepp_reference": "Beware, beware. I am the prince of drakness. Beware ! Beware !",
    "observations": "Comme commentaire \u00e9tait d\u00e9j\u00e0 utilis\u00e9...",
    "couvertures_possibles": "Y'a des jours comme \u00e7a, on ne sait plus qui on est ni o\u00f9 on va...",
    "couvertures_interdites": "Qui suis-je ? O\u00f9 vais-je ? Dans quel \u00e9tat j'erre...",
    "tests_statistiques": "Le nombre moyen d'imb\u00e9ciles qui vont lire les d\u00e9scriptifs de la doc",
    "national_qualification": "Celui qui \u00e0 lu le commentaire de param\u00e8tre pr\u00e9c\u00e9dent \u00e0 \u00e9t\u00e9 nationalement qualifi\u00e9 d'imb\u00e9cile...",
    "type_qualification": "Imb\u00e9cile est une insulte mais c'est gentil quand c'est \u00e9crit avec hamour (c'est de l'amour dr\u00f4le, une blague orthographique quoi)",
    "objectif_qualification": "Faire rire, pleurer, ... Mais surtout, m'occuper",
    "code_national": "Franchemant, qui aime \u00e9crire de la doc ?",
    "code_regional": "Sur 4h de dev, je passe 1h \u00e0 code et 3h \u00e0 faire la doc...",
    "code_entite": "Je suis gav\u00e9. Comme mort \u00e0 l'int\u00e9rieur",
    "surface_microparcelles": "D\u00e9senchant\u00e9, cette documentation m'a vol\u00e9 mes r\u00eaves",
    "volume_bouillie": "Un volume de bouillie ? S\u00e9rieusement ?",
    "nombre_blocs": 42,
    "agriculture_biologique": true,
    "utilisation_phyto": false,
    "prestation_service": false,
    "contamination_artificielle": false,
    "brumisation": false,
    "bpe": false,
    "type_uid": "type1",
    "dispositif_experimental_uid": "de1",
    "thematique_uid": "thematique1",
    "unite_uid": "unite1",
    "implantation_temoins_id": 1,
    "annee_recolte_id": 1,
    "declaration_protocole_id": 1,
    "sous_thematiques": [
        {
            "uid": "2"
        },
        []
    ],
    "cultures": [
        {
            "uid": "2"
        },
        {
            "uid": "2"
        }
    ],
    "cibles": [
        {
            "id": 1
        },
        {
            "id": 1
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'titre' => 'Protocole2',
            'donneur_ordre' => 'Barbapapa',
            'donneur_ordre_code' => 'ULAHUP',
            'donneur_ordre_contact' => 'Barbatruc',
            'numero_devis' => 'AZERTYUIOP789',
            'commentaires' => 'Un autre commentaire',
            'objectifs' => 'Passer au dev de la phase D',
            'situation_a_favoriser' => 'La communication !',
            'secteur_geographique' => 'Sous l\'océan',
            'orientation_semis' => 'Vers la mecque',
            'type_sol' => 'Tapis',
            'mode_appl_phyto' => 'Avion',
            'methodes_internes' => 'L\'imagination me manque',
            'methode_ceb_reference' => 'Je renonce à tout... à l\'amour, aux plaisirs, à la vie...',
            'guidelines_oepp_reference' => 'Beware, beware. I am the prince of drakness. Beware ! Beware !',
            'observations' => 'Comme commentaire était déjà utilisé...',
            'couvertures_possibles' => 'Y\'a des jours comme ça, on ne sait plus qui on est ni où on va...',
            'couvertures_interdites' => 'Qui suis-je ? Où vais-je ? Dans quel état j\'erre...',
            'tests_statistiques' => 'Le nombre moyen d\'imbéciles qui vont lire les déscriptifs de la doc',
            'national_qualification' => 'Celui qui à lu le commentaire de paramètre précédent à été nationalement qualifié d\'imbécile...',
            'type_qualification' => 'Imbécile est une insulte mais c\'est gentil quand c\'est écrit avec hamour (c\'est de l\'amour drôle, une blague orthographique quoi)',
            'objectif_qualification' => 'Faire rire, pleurer, ... Mais surtout, m\'occuper',
            'code_national' => 'Franchemant, qui aime écrire de la doc ?',
            'code_regional' => 'Sur 4h de dev, je passe 1h à code et 3h à faire la doc...',
            'code_entite' => 'Je suis gavé. Comme mort à l\'intérieur',
            'surface_microparcelles' => 'Désenchanté, cette documentation m\'a volé mes rêves',
            'volume_bouillie' => 'Un volume de bouillie ? Sérieusement ?',
            'nombre_blocs' => 42,
            'agriculture_biologique' => true,
            'utilisation_phyto' => false,
            'prestation_service' => false,
            'contamination_artificielle' => false,
            'brumisation' => false,
            'bpe' => false,
            'type_uid' => 'type1',
            'dispositif_experimental_uid' => 'de1',
            'thematique_uid' => 'thematique1',
            'unite_uid' => 'unite1',
            'implantation_temoins_id' => 1,
            'annee_recolte_id' => 1,
            'declaration_protocole_id' => 1,
            'sous_thematiques' => [
                [
                    'uid' => '2',
                ],
                [],
            ],
            'cultures' => [
                [
                    'uid' => '2',
                ],
                [
                    'uid' => '2',
                ],
            ],
            'cibles' => [
                [
                    'id' => 1,
                ],
                [
                    'id' => 1,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "titre": "Protocole2",
        "donneur_ordre": "Barbapapa",
        "donneur_ordre_code": "ULAHUP",
        "donneur_ordre_contact": "Barbatruc",
        "numero_devis": "AZERTYUIOP789",
        "commentaires": "Un autre commentaire",
        "objectifs": "Passer au dev de la phase DC",
        "situation_a_favoriser": "La communication !",
        "secteur_geographique": "Sous l'océan",
        "orientation_semis": "Vers la mecque",
        "type_sol": "Tapis",
        "mode_appl_phyto": "Avion",
        "methodes_internes": "L'imagination me manque",
        "methode_ceb_reference": "Je renonce à tout... à l'amour, aux plaisirs, à la vie...",
        "guidelines_oepp_reference": "Beware, beware. I am the prince of drakness. Beware ! Beware !",
        "observations": "Comme commentaire était déjà utilisé...",
        "couvertures_possibles": "Y'a des jours comme ça, on ne sait plus qui on est ni où on va...",
        "couvertures_interdites": "Qui suis-je ? Où vais-je ? Dans quel état j'erre...",
        "tests_statistiques": "Le nombre moyen d'imbéciles qui vont lire les déscriptifs de la doc",
        "national_qualification": "Celui qui à lu le commentaire de paramètre précédent à été nationalement qualifié d'imbécile...",
        "type_qualification": "Imbécile est une insulte mais c'est gentil quand c'est écrit avec hamour (c'est de l'amour drôle)",
        "objectif_qualification": "Faire rire, pleurer, ... Mais surtout, m'occuper",
        "code_national": "Franchemant, qui aime écrire de la doc ?",
        "code_regional": "Sur 4h de dev, je passe 1h à code et 3h à faire la doc...",
        "code_entite": "Je suis gavé. Comme mort à l'intérieur",
        "surface_microparcelles": "Désenchanté, cette documentation m'a volé mes rêves",
        "volume_bouillie": "Un volume de bouillie ? Sérieusement ?",
        "nombre_blocs": 42,
        "agriculture_biologique": false,
        "utilisation_phyto": false,
        "contamination_artificielle": false,
        "brumisation": false,
        "prestation_service": false,
        "partage_accepte": true,
        "date_partage": "2021-06-14 17:27:35.911688+02",
        "agriculture_biologique": true,
        "bpe": false,
        "type": { ... },
        "statut": { ... },
        "dispositif_experimental": { ... },
        "thematique": { ... },
        "unite": { ... },
        "implantation_temoins": { ... },
        "annee_recolte": { ... },
        "declaration_protocole": { ... },
        "cibles": [ ... ]
    }
}

Request   

PUT protocole/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du protocole.

Body Parameters

titre  string optional  
Le titre du protocole.

donneur_ordre  string optional  
Le nom du donneur d'ordre du protocole.

donneur_ordre_code  string optional  
Le code du donneur d'ordre du protocole.

donneur_ordre_contact  string optional  
Le contact du donneur d'ordre du protocole.

numero_devis  string optional  
Le de devis du protocole.

commentaires  string optional  
Les commentaires du protocole.

objectifs  string optional  
L'objectifs du protocole.

situation_a_favoriser  string optional  
La situation à favoriser durant le protocole.

secteur_geographique  string optional  
Le sécteur géographique du protocole.

orientation_semis  string optional  
L'orientation des semis du protocole.

type_sol  string optional  
Le type de sol utilisé pour le protocole.

mode_appl_phyto  string optional  
Le mode d'application des produit phytosanitaire durant protocole.

methodes_internes  string optional  
Les méthodes internes du protocole.

methode_ceb_reference  string optional  
La méthode CEB de référence du protocole.

guidelines_oepp_reference  string optional  
Les guidelines OEPP de référence du protocole.

observations  string optional  
Les observations sur le protocole.

couvertures_possibles  string optional  
Les couvertures possibles du protocole.

couvertures_interdites  string optional  
Les couvertures interdites du protocole.

tests_statistiques  string optional  
Les tests statistiques prévus sur le protocole.

national_qualification  string optional  
La qualification nationale du protocole.

type_qualification  string optional  
Le type de qualification nationale du protocole.

objectif_qualification  string optional  
L'objectif de qualification nationale du protocole.

code_national  string optional  
Le code national du protocole.

code_regional  string optional  
Le code régional du protocole.

code_entite  string optional  
Le code entité du protocole.

surface_microparcelles  numeric optional  
Le surface de microparcelles du protocole.

volume_bouillie  numeric optional  
Le volume de bouillie du protocole.

nombre_blocs  integer optional  
Le nombre de blocs du protocole.

agriculture_biologique  boolean optional  
Le caractère de prestation de service du protocole.

utilisation_phyto  boolean optional  
L'utilisation de produits phytosanitaires au cours du protocole.

prestation_service  boolean optional  
Le caractère de prestation de service du protocole.

contamination_artificielle  boolean optional  
La simulation d'une contamination au cours du protocole.

brumisation  boolean optional  
La brumisation au cours du protocole.

bpe  boolean optional  
La caractère BPD du protocole.

type_uid  string optional  
L'identifiant unique du type du protocole.

dispositif_experimental_uid  string optional  
L'identifiant unique du dispositif experimental associé au protocole.

thematique_uid  string optional  
L'identifiant unique de la thematique du protocole.

unite_uid  string optional  
L'identifiant unique de l'unité utilisée dans le protocole.

implantation_temoins_id  integer optional  
L'identifiant de la valeur du référentiel implantationtemoins.

annee_recolte_id  integer optional  
L'identifiant de la valeur du référentiel anneerecolte.

declaration_protocole_id  integer optional  
L'identifiant de la valeur du référentiel declarationprotocole.

sous_thematiques  object[] optional  
Les sous thematiques du produit.

sous_thematiques[].uid  string optional  
Un identifiant unique de thematique existant.

cultures  object[] optional  
Les cultures du produit.

cultures[].uid  string optional  
Un identifiant unique de thematique existant.

cibles  object[] optional  
Les cibles du produit.

cibles[].id  integer optional  
L'identifiant de la valeur du référentiel cible.

Supprimer

requires authentication

Supprime un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du protocole.

Partager

requires authentication

Partage un protocole

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/partager" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"entite_id":1,"modalites":[{"id":"2"},[]]}'

const url = new URL(
    "https://api.oss.coop/protocole/2/partager"
);

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

let body = {
    "entite_id": 1,
    "modalites": [
        {
            "id": "2"
        },
        []
    ]
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/partager',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'entite_id' => 1,
            'modalites' => [
                [
                    'id' => '2',
                ],
                [],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/partager

URL Parameters

uid  integer  
L'identifiant du protocole.

Body Parameters

entite_id  integer  
L'identifiant de l'entité avec laquelle le partage est effectué.

modalites  object[]  
Les modalités à partager.

modalites[].id  string optional  
Un identifiant de modalité existant.

Dupliquer

requires authentication

Duplique un protocole

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/dupliquer" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"modalites":[{"id":"2"},[]]}'

const url = new URL(
    "https://api.oss.coop/protocole/2/dupliquer"
);

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

let body = {
    "modalites": [
        {
            "id": "2"
        },
        []
    ]
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/dupliquer',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'modalites' => [
                [
                    'id' => '2',
                ],
                [],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/dupliquer

URL Parameters

uid  integer  
L'identifiant du protocole.

Body Parameters

modalites  object[]  
Les modalités à partager.

modalites[].id  string optional  
Un identifiant de modalité existant.

Reconduit - Années

requires authentication

Liste des années disponnibles pour la recondution du protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/2/reconduire/annees" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/2/reconduire/annees"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/2/reconduire/annees',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

GET protocole/{uid:[0-9]+}/reconduire/annees

URL Parameters

uid  integer  
L'identifiant du protocole.

Reconduit

requires authentication

Reconduit un protocole sur une nouvelle année

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/reconduire" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"modalites":[{"id":"2"},[]]}'

const url = new URL(
    "https://api.oss.coop/protocole/2/reconduire"
);

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

let body = {
    "modalites": [
        {
            "id": "2"
        },
        []
    ]
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/reconduire',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'modalites' => [
                [
                    'id' => '2',
                ],
                [],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/reconduire

URL Parameters

uid  integer  
L'identifiant du protocole.

Body Parameters

modalites  object[]  
Les modalités à partager.

modalites[].id  string optional  
Un identifiant de modalité existant.

Accepter

requires authentication

Accepte un partage de protocole

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/accepter" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/2/accepter"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/accepter',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/accepter

URL Parameters

uid  integer  
L'identifiant du protocole.

Refuser

requires authentication

Refuse un partage de protocole

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/refuser" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/2/refuser"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/refuser',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/refuser

URL Parameters

uid  integer  
L'identifiant du protocole.

Ordonnancer

requires authentication

Ordonnance les modalités d'un protocole

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/ordonnancer" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/2/ordonnancer"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/ordonnancer',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/ordonnancer

URL Parameters

uid  integer  
L'identifiant du protocole.

Valider

requires authentication

Valide un protocole (non BPE uniquement)

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/valider" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/2/valider"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/valider',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/valider

URL Parameters

uid  integer  
L'identifiant du protocole.

Archiver

requires authentication

Archive un protocole

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/2/archiver" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/2/archiver"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/2/archiver',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{uid:[0-9]+}/archiver

URL Parameters

uid  integer  
L'identifiant du protocole.

Modalité d'observation - Lister

requires authentication

Liste des modalités d'observation d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/modalite_observation?sort=nom.ASC%2Cid.DESC&page=12&limit=3" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite_observation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "12",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/modalite_observation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '12',
            'limit'=> '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "periode_observation": "Du vendredi au lundi, quand tout le monde est bourré.",
            "modalites_observees": "Le prix (lol y'en a pas)",
            "type_notation": "Sur 20",
            "organes_observes": "Les mouches qui pètent",
            "adaptation_ceb": "Encore un acronyme à la c*"
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/modalite_observation

URL Parameters

puid  integer  
L'identifiant du protocole.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Modalité d'observation - Voir

requires authentication

Détails d'une modalité d'observation d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/modalite_observation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite_observation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/modalite_observation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "periode_observation": "Du vendredi au lundi, quand tout le monde est bourré.",
        "modalites_observees": "Le prix (lol y'en a pas)",
        "type_notation": "Sur 20",
        "organes_observes": "Les mouches qui pètent",
        "adaptation_ceb": "Encore un acronyme à la c*"
    }
}

Request   

GET protocole/{puid:[0-9]+}/modalite_observation/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la modalité d'observation.

Modalité d'observation - Ajouter

requires authentication

Ajoute une modalité d'observation d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/modalite_observation" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"periode_observation":"Jamais sinon c'est une particule et pas une onde.","modalites_observees":"Les semences ?","type_notation":"Sur 20","organes_observes":"Les c* (je sais elle \u00e9tait facile)","adaptation_ceb":"J'ai pas de vanne qui me vient l\u00e0 maintenant..."}'

const url = new URL(
    "https://api.oss.coop/protocole/1/modalite_observation"
);

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

let body = {
    "periode_observation": "Jamais sinon c'est une particule et pas une onde.",
    "modalites_observees": "Les semences ?",
    "type_notation": "Sur 20",
    "organes_observes": "Les c* (je sais elle \u00e9tait facile)",
    "adaptation_ceb": "J'ai pas de vanne qui me vient l\u00e0 maintenant..."
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/modalite_observation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'periode_observation' => 'Jamais sinon c\'est une particule et pas une onde.',
            'modalites_observees' => 'Les semences ?',
            'type_notation' => 'Sur 20',
            'organes_observes' => 'Les c* (je sais elle était facile)',
            'adaptation_ceb' => 'J\'ai pas de vanne qui me vient là maintenant...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "periode_observation": "Jamais sinon c'est une particule et pas une onde.",
        "modalites_observees": "Les semences ?",
        "type_notation": "Sur 20",
        "organes_observes": "Les c* (je sais elle était facile)",
        "adaptation_ceb": "J'ai pas de vanne qui me vient là maintenant..."
    }
}

Request   

POST protocole/{puid:[0-9]+}/modalite_observation

URL Parameters

puid  integer  
L'identifiant du protocole.

Body Parameters

periode_observation  string optional  
La période d'observation du protocole.

modalites_observees  string optional  
Les modalités du protocole à observer.

type_notation  string optional  
Le type de notation du protocole.

organes_observes  string optional  
Les organes du protocole à observer.

adaptation_ceb  string optional  
Les adaptations CEB du protocole.

Modalité d'observation - Modifier

requires authentication

Modifie une modalité d'observation d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/modalite_observation/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"periode_observation":"null","modalites_observees":"null","type_notation":"null","organes_observes":"null","adaptation_ceb":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/modalite_observation/2"
);

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

let body = {
    "periode_observation": "null",
    "modalites_observees": "null",
    "type_notation": "null",
    "organes_observes": "null",
    "adaptation_ceb": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/modalite_observation/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'periode_observation' => 'null',
            'modalites_observees' => 'null',
            'type_notation' => 'null',
            'organes_observes' => 'null',
            'adaptation_ceb' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "periode_observation": null,
        "modalites_observees": null,
        "type_notation": null,
        "organes_observes": null,
        "adaptation_ceb": null."
    }
}

Request   

PUT protocole/{puid:[0-9]+}/modalite_observation/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la modalité d'observation.

Body Parameters

periode_observation  string optional  
La période d'observation du protocole.

modalites_observees  string optional  
Les modalités du protocole à observer.

type_notation  string optional  
Le type de notation du protocole.

organes_observes  string optional  
Les organes du protocole à observer.

adaptation_ceb  string optional  
Les adaptations CEB du protocole.

Modalité d'observation - Supprimer

requires authentication

Supprime une modalité d'observation d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/modalite_observation/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite_observation/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/modalite_observation/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/modalite_observation/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la modalité d'observation.

Modalité - Lister

requires authentication

Liste des modalités d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/modalite?sort=nom.ASC%2Cid.DESC&page=4&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "4",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '4',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "numero": "AZERTY123",
            "destruction": false,
            "ordre": 1,
            "type": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/modalite

URL Parameters

puid  integer  
L'identifiant du protocole.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Modalité - Voir

requires authentication

Détails d'une modalité d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/modalite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/modalite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "numero": "AZERTY123",
        "destruction": false,
        "ordre": 1,
        "type": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/modalite/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la modalité.

Modalité - Ajouter

requires authentication

Ajoute une modalité d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/modalite" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"numero":"AZERTY124","destruction":"true","ordre":2,"type_uid":"type1"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/modalite"
);

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

let body = {
    "numero": "AZERTY124",
    "destruction": "true",
    "ordre": 2,
    "type_uid": "type1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'numero' => 'AZERTY124',
            'destruction' => 'true',
            'ordre' => 2,
            'type_uid' => 'type1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "numero": "AZERTY124",
        "destruction": true,
        "ordre": 2,
        "type": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/modalite

URL Parameters

puid  integer  
L'identifiant du protocole.

Body Parameters

numero  string optional  
Le numéro de modalité.

destruction  string optional  
La déstruction après récolte.

ordre  integer optional  
Le numéro d'ordre de la modalité.

type_uid  string optional  
L'identifiant unique du type de modalité.

Modalité - Modifier

requires authentication

Modifie une modalité d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/modalite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"numero":"null","destruction":"false","ordre":0,"type_uid":"type1"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/2"
);

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

let body = {
    "numero": "null",
    "destruction": "false",
    "ordre": 0,
    "type_uid": "type1"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/modalite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'numero' => 'null',
            'destruction' => 'false',
            'ordre' => 0,
            'type_uid' => 'type1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "numero": null,
        "destruction": false,
        "ordre": null,
        "type": { ... }
    }
}

Request   

PUT protocole/{puid:[0-9]+}/modalite/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la modalité.

Body Parameters

numero  string optional  
Le numéro de modalité.

destruction  string optional  
La déstruction après récolte.

ordre  integer  
Le numéro d'ordre de la modalité.

type_uid  string optional  
L'identifiant unique du type de modalité.

Modalité - Supprimer

requires authentication

Supprime une modalité d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/modalite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/modalite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/modalite/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la modalité.

Modalité - Dupliquer

requires authentication

Dupliquer une modalité d'un protocole

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/modalite/2/dupliquer" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/2/dupliquer"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/modalite/2/dupliquer',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH protocole/{puid:[0-9]+}/modalite/{uid:[0-9]+}/dupliquer

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la modalité.

Modalité - Semence - Lister

requires authentication

Liste des semences d'une modalité d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/modalite/1/semence?sort=nom.ASC%2Cid.DESC&page=19&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/1/semence"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "19",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/modalite/1/semence',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '19',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "variete": "variete 1",
            "traitementsemence": "Des pesticides qu'on préfère appeller des produits phytosanitaires car c'est plus politiquement correct et moins flippant",
            "densite": 14.2,
            "pmg": 66.6,
            "facteur": { ... },
            "unite": { ... },
            "produit": { ... },
            "fournisseur": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/modalite/{muid:[0-9]+}/semence

URL Parameters

puid  integer  
L'identifiant du protocole.

muid  integer  
L'identifiant de la modalité.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Modalité - Semence - Voir

requires authentication

Détails d'une semence d'une modalité d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/modalite/1/semence/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/1/semence/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/modalite/1/semence/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "variete": "variete 1",
        "traitementsemence": "Des pesticides qu'on préfère appeller des produits phytosanitaires car c'est plus politiquement correct et moins flippant",
        "densite": 14.2,
        "pmg": 66.6,
        "facteur": { ... },
        "unite": { ... },
        "produit": { ... },
        "fournisseur": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/modalite/{muid:[0-9]+}/semence/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

muid  integer  
L'identifiant de la modalité.

uid  integer  
L'identifiant de la semence.

Modalité - Semence - Ajouter

requires authentication

Ajoute des semences à une modalité d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/modalite/1/semence" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variete":"variete 2","traitementsemence":"Rien, nada, niet","densite":"14.2","pmg":"66.6","facteur_id":1,"unite_uid":1,"produit_id":1,"fournisseur_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/1/semence"
);

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

let body = {
    "variete": "variete 2",
    "traitementsemence": "Rien, nada, niet",
    "densite": "14.2",
    "pmg": "66.6",
    "facteur_id": 1,
    "unite_uid": 1,
    "produit_id": 1,
    "fournisseur_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/modalite/1/semence',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variete' => 'variete 2',
            'traitementsemence' => 'Rien, nada, niet',
            'densite' => '14.2',
            'pmg' => '66.6',
            'facteur_id' => 1,
            'unite_uid' => 1,
            'produit_id' => 1,
            'fournisseur_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "variete": "variete 2",
        "traitementsemence": "Rien, nada, niet",
        "densite": 14.2,
        "pmg": 66.6,
        "facteur": { ... },
        "unite": { ... },
        "produit": { ... },
        "fournisseur": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/modalite/{muid:[0-9]+}/semence

URL Parameters

puid  integer  
L'identifiant du protocole.

muid  integer  
L'identifiant de la modalité.

Body Parameters

variete  string optional  
La variete de la semence.

traitementsemence  string optional  
Les traitements appliqués sur la semence.

densite  numeric optional  
La densité de semence.

pmg  numeric optional  
J'imagine que c'est pas PGM XD.

facteur_id  integer  
L'identifiant du facteur associé à la semence.

unite_uid  integer  
L'identifiant unique de l'unité associée à la semence.

produit_id  integer  
L'identifiant du produit de type semence.

fournisseur_id  integer optional  
L'identifiant du fournisseur du produit.

Modalité - Semence - Modifier

requires authentication

Modifie des semence d'une modalité d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/modalite/1/semence" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variete":"null","traitementsemence":"null","densite":"null","pmg":"null","facteur_id":1,"unite_uid":1,"produit_id":1,"fournisseur_id":2}'

const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/1/semence"
);

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

let body = {
    "variete": "null",
    "traitementsemence": "null",
    "densite": "null",
    "pmg": "null",
    "facteur_id": 1,
    "unite_uid": 1,
    "produit_id": 1,
    "fournisseur_id": 2
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/modalite/1/semence',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variete' => 'null',
            'traitementsemence' => 'null',
            'densite' => 'null',
            'pmg' => 'null',
            'facteur_id' => 1,
            'unite_uid' => 1,
            'produit_id' => 1,
            'fournisseur_id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "variete": null,
        "traitementsemence": null,
        "densite": null,
        "pmg": null,
        "facteur": { ... },
        "unite": { ... },
        "produit": { ... },
        "fournisseur": { ... }
    }
}

Request   

PUT protocole/{puid:[0-9]+}/modalite/{muid:[0-9]+}/semence

URL Parameters

puid  integer  
L'identifiant du protocole.

muid  integer  
L'identifiant de la modalité.

Body Parameters

variete  string optional  
La variete de la semence.

traitementsemence  string optional  
Les traitements appliqués sur la semence.

densite  numeric optional  
La densité de semence.

pmg  numeric optional  
J'imagine que c'est pas PGM XD.

facteur_id  integer  
L'identifiant du facteur associé à la semence.

unite_uid  integer  
L'identifiant unique de l'unité associée à la semence.

produit_id  integer  
L'identifiant du produit de type semence.

fournisseur_id  integer optional  
L'identifiant du fournisseur du produit.

Modalité - Semence - Supprimer

requires authentication

Supprime des semence d'une modalité d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/modalite/1/semence" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/modalite/1/semence"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/modalite/1/semence',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/modalite/{muid:[0-9]+}/semence

URL Parameters

puid  integer  
L'identifiant du protocole.

muid  integer  
L'identifiant de la modalité.

Facteur - Lister

requires authentication

Liste des fateurs d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur?sort=nom.ASC%2Cid.DESC&page=18&limit=15" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "18",
    "limit": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '18',
            'limit'=> '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Mon super facteur",
            "numero": "AZERTY123",
            "destruction": false,
            "ordre": 1,
            "type": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/facteur

URL Parameters

puid  integer  
L'identifiant du protocole.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Facteur - Voir

requires authentication

Détails d'un fateur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Mon super facteur",
        "numero": "AZERTY123",
        "destruction": false,
        "ordre": 1,
        "type": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du fateur.

Facteur - Ajouter

requires authentication

Ajoute un fateur d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/facteur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Facteur 2","ordre":2,"type_uid":"type1"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur"
);

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

let body = {
    "designation": "Facteur 2",
    "ordre": 2,
    "type_uid": "type1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/facteur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Facteur 2',
            'ordre' => 2,
            'type_uid' => 'type1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Facteur 2",
        "numero": "AZERTY124",
        "destruction": true,
        "ordre": 2,
        "type": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/facteur

URL Parameters

puid  integer  
L'identifiant du protocole.

Body Parameters

designation  string optional  
La designation du fateur.

ordre  integer  
Le numéro d'ordre du fateur.

type_uid  string optional  
L'identifiant unique du type de fateur.

Facteur - Modifier

requires authentication

Modifie un fateur d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/facteur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"null","ordre":0,"type_uid":"type1"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/2"
);

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

let body = {
    "designation": "null",
    "ordre": 0,
    "type_uid": "type1"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/facteur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'null',
            'ordre' => 0,
            'type_uid' => 'type1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": null,
        "numero": null,
        "destruction": false,
        "ordre": null,
        "type": { ... }
    }
}

Request   

PUT protocole/{puid:[0-9]+}/facteur/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du fateur.

Body Parameters

designation  string optional  
La designation du fateur.

ordre  integer  
Le numéro d'ordre du fateur.

type_uid  string optional  
L'identifiant unique du type de fateur.

Facteur - Supprimer

requires authentication

Supprime un fateur d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/facteur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/facteur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/facteur/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du fateur.

Facteur - Variable - Lister

requires authentication

Liste des variables d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/variable?sort=nom.ASC%2Cid.DESC&page=5&limit=1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "variable 1",
            "type": { ... },
            "unite": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Facteur - Variable - Voir

requires authentication

Détails d'une variable d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "variable 1",
        "type": { ... },
        "unite": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

uid  integer  
L'identifiant de la variable.

Facteur - Variable - Ajouter

requires authentication

Ajoute une variable d'un facteur d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/facteur/1/variable" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"variable 2","unite_uid":"unite1","type_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable"
);

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

let body = {
    "designation": "variable 2",
    "unite_uid": "unite1",
    "type_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/facteur/1/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'variable 2',
            'unite_uid' => 'unite1',
            'type_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "variable 2",
        "type": { ... },
        "unite": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Body Parameters

designation  string optional  
La designation de la variable.

unite_uid  string optional  
Lidentifiant unique de l'unité de la variable.

type_id  integer  
Lidentifiant du type de la variable.

Facteur - Variable - Modifier

requires authentication

Modifie une variable d'un facteur d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/facteur/1/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"variable 3","unite_uid":"unite1","type_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1"
);

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

let body = {
    "designation": "variable 3",
    "unite_uid": "unite1",
    "type_id": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'variable 3',
            'unite_uid' => 'unite1',
            'type_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "variable 3",
        "type": { ... },
        "unite": { ... }
    }
}

Request   

PUT protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

uid  integer  
L'identifiant de la variable.

Body Parameters

designation  string optional  
La designation de la variable.

unite_uid  string optional  
Lidentifiant unique de l'unité de la variable.

type_id  integer  
Lidentifiant du type de la variable.

Facteur - Variable - Supprimer

requires authentication

Supprime une variable d'un facteur d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/facteur/1/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

uid  integer  
L'identifiant de la variable.

Facteur - Variable - Valeur - Lister

requires authentication

Liste des valeurs d'une variable d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur?sort=nom.ASC%2Cid.DESC&page=4&limit=1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "4",
    "limit": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '4',
            'limit'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "valeur": "valeur 1",
            "modalite": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{vuid:[0-9]+}/valeur

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

vuid  integer  
L'identifiant de la variable.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Facteur - Variable - Valeur - Voir

requires authentication

Détails d'une valeur d'une variable d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "valeur": "valeur 1",
        "modalite": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

vuid  integer  
L'identifiant de la variable.

uid  integer  
L'identifiant de la valeur.

Facteur - Variable - Valeur - Ajouter

requires authentication

Ajoute une valeur à une variable d'un facteur d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"valeur":"valeur 2","modalite_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur"
);

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

let body = {
    "valeur": "valeur 2",
    "modalite_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'valeur' => 'valeur 2',
            'modalite_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "valeur": "valeur 2",
        "modalite": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{vuid:[0-9]+}/valeur

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

vuid  integer  
L'identifiant de la variable.

Body Parameters

valeur  string  
La valeur de la variable.

modalite_id  integer  
L'identifiant de la modalité de la variable.

Facteur - Variable - Valeur - Modifier

requires authentication

Modifie une valeur d'une variable d'un facteur d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"valeur":"valeur 3","modalite_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1"
);

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

let body = {
    "valeur": "valeur 3",
    "modalite_id": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'valeur' => 'valeur 3',
            'modalite_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "valeur": "valeur 3",
        "modalite": { ... }
    }
}

Request   

PUT protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

vuid  integer  
L'identifiant de la variable.

uid  integer  
L'identifiant de la valeur.

Body Parameters

valeur  string  
La valeur de la variable.

modalite_id  integer  
L'identifiant de la modalité de la variable.

Facteur - Variable - Valeur - Supprimer

requires authentication

Supprime une valeur d'une variable d'un facteur d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/facteur/1/variable/1/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/variable/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

vuid  integer  
L'identifiant de la variable.

uid  integer  
L'identifiant de la valeur.

Facteur - Passage - Lister

requires authentication

Liste des passages d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/passage?sort=nom.ASC%2Cid.DESC&page=13&limit=6" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "13",
    "limit": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/passage',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '13',
            'limit'=> '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "ordre": 1,
            "stade": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Facteur - Passage - Voir

requires authentication

Détails d'un passage d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/passage/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/passage/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "ordre": 1,
        "stade": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

uid  integer  
L'identifiant du passage.

Facteur - Passage - Ajouter

requires authentication

Ajoute un passage d'un facteur d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/facteur/1/passage" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"ordre":2,"stade_uid":"1"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage"
);

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

let body = {
    "ordre": 2,
    "stade_uid": "1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/facteur/1/passage',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'ordre' => 2,
            'stade_uid' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "ordre": 2,
        "stade": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Body Parameters

ordre  integer  
Le numéro d'ordre du fateur.

stade_uid  string optional  
L'identifiant unique du stade du facteur.

Facteur - Passage - Modifier

requires authentication

Modifie un passage d'un facteur d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/facteur/1/passage" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"ordre":2,"stade_uid":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage"
);

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

let body = {
    "ordre": 2,
    "stade_uid": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/facteur/1/passage',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'ordre' => 2,
            'stade_uid' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "ordre": 2,
        "stade": null
    }
}

Request   

PUT protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Body Parameters

ordre  integer  
Le numéro d'ordre du fateur.

stade_uid  string optional  
L'identifiant unique du stade du facteur.

Facteur - Passage - Supprimer

requires authentication

Supprime un passage d'un facteur d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/facteur/1/passage" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/facteur/1/passage',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Facteur - Passage - Produit - Lister

requires authentication

Liste des produits d'un passage d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/passage/produit?sort=nom.ASC%2Cid.DESC&page=19&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "19",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/passage/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '19',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "dose": 66.6,
            "modalite": { ... },
            "produit": { ... },
            "unite": { ... },
            "fournisseur": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/produit

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Facteur - Passage - Produit - Voir

requires authentication

Détails d'un produit d'un passage d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/passage/produit/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/passage/produit/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "dose": 66.6,
        "modalite": { ... },
        "produit": { ... },
        "unite": { ... },
        "fournisseur": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/produit/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

uid  integer  
L'identifiant du produit.

Facteur - Passage - Produit - Ajouter

requires authentication

Ajoute un produit à un passage d'un facteur d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"dose":"42.2","modalite_id":1,"produit_id":1,"unite_uid":"1","fournisseur_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit"
);

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

let body = {
    "dose": "42.2",
    "modalite_id": 1,
    "produit_id": 1,
    "unite_uid": "1",
    "fournisseur_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/facteur/1/passage/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'dose' => '42.2',
            'modalite_id' => 1,
            'produit_id' => 1,
            'unite_uid' => '1',
            'fournisseur_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "dose": 42.2,
            "modalite": { ... },
            "produit": { ... },
            "unite": { ... },
            "fournisseur": { ... }
        }
    ]
}

Request   

POST protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/produit

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Body Parameters

dose  numeric optional  
La dose de produit.

modalite_id  integer  
L'identifiant de la modalité du produit.

produit_id  integer  
L'identifiant du produit.

unite_uid  string  
L'identifiant unique de l'unité du produit.

fournisseur_id  integer  
L'identifiant du fournisseur du produit.

Facteur - Passage - Produit - Modifier

requires authentication

Modifie un produit d'un passage d'un facteur d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"id":1,"dose":"null","modalite_id":1,"produit_id":1,"unite_uid":"1","fournisseur_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit"
);

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

let body = {
    "id": 1,
    "dose": "null",
    "modalite_id": 1,
    "produit_id": 1,
    "unite_uid": "1",
    "fournisseur_id": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/facteur/1/passage/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'id' => 1,
            'dose' => 'null',
            'modalite_id' => 1,
            'produit_id' => 1,
            'unite_uid' => '1',
            'fournisseur_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "dose": null,
            "modalite": { ... },
            "produit": { ... },
            "unite": { ... },
            "fournisseur": { ... }
        }
    ]
}

Request   

PUT protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/produit

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Body Parameters

id  integer  
L'identifiant du produit.

dose  numeric optional  
La dose de produit.

modalite_id  integer  
L'identifiant de la modalité du produit.

produit_id  integer  
L'identifiant du produit.

unite_uid  string  
L'identifiant unique de l'unité du produit.

fournisseur_id  integer  
L'identifiant du fournisseur du produit.

Facteur - Passage - Produit - Supprimer

requires authentication

Supprime un produit d'un passage d'un facteur d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/produit"
);

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

let body = {
    "id": 1
}

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/facteur/1/passage/produit',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/produit

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

Body Parameters

id  integer  
L'identifiant du produit.

Facteur - Passage - Travail du sol - Lister

requires authentication

Liste des "travail du sol" d'un passage d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol?sort=nom.ASC%2Cid.DESC&page=19&limit=16" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "19",
    "limit": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '19',
            'limit'=> '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "dose": 66.6,
            "modalite": { ... },
            "sol_travail": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/{psuid:[0-9]+}/travail_du_sol

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

psuid  integer  
L'identifiant du passage.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Facteur - Passage - Travail du sol - Voir

requires authentication

Détails d'un "travail du sol" d'un passage d'un facteur d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "dose": 66.6,
        "modalite": { ... },
        "sol_travail": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/{psuid:[0-9]+}/travail_du_sol/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

psuid  integer  
L'identifiant du passage.

uid  integer  
L'identifiant du "travail du sol".

Facteur - Passage - Travail du sol - Ajouter

requires authentication

Ajoute des "travail du sol" à un passage d'un facteur d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"modalite_id":1,"sol_travail_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol"
);

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

let body = {
    "modalite_id": 1,
    "sol_travail_id": 1
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'modalite_id' => 1,
            'sol_travail_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "dose": 42.2,
            "modalite": { ... },
            "sol_travail": { ... }
        }
    ]
}

Request   

POST protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/{psuid:[0-9]+}/travail_du_sol

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

psuid  integer  
L'identifiant du passage.

Body Parameters

modalite_id  integer  
L'identifiant de la modalité du "travail du sol".

sol_travail_id  integer  
L'identifiant du référentiel "travail du sol".

Facteur - Passage - Travail du sol - Modifier

requires authentication

Modifie les "travail du sol" d'un passage d'un facteur d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"modalite_id":1,"sol_travail_id":1}'

const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol"
);

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

let body = {
    "modalite_id": 1,
    "sol_travail_id": 1
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'modalite_id' => 1,
            'sol_travail_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "dose": null,
            "modalite": { ... },
            "sol_travail": { ... }
        }
    ]
}

Request   

PUT protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/{psuid:[0-9]+}/travail_du_sol

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

psuid  integer  
L'identifiant du passage.

Body Parameters

modalite_id  integer  
L'identifiant de la modalité du "travail du sol".

sol_travail_id  integer  
L'identifiant du référentiel "travail du sol".

Facteur - Passage - Travail du sol - Supprimer

requires authentication

Supprime des "travail du sol" d'un passage d'un facteur d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/facteur/1/passage/1/travail_du_sol',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/facteur/{fuid:[0-9]+}/passage/{psuid:[0-9]+}/travail_du_sol

URL Parameters

puid  integer  
L'identifiant du protocole.

fuid  integer  
L'identifiant du facteur.

psuid  integer  
L'identifiant du passage.

Version - Lister

requires authentication

Liste des versions d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/version?sort=nom.ASC%2Cid.DESC&page=16&limit=9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/version"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/version',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "version": 1,
            "date": "2021-09-09 12:29:03+02",
            "ressource":"{...}"
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/version

URL Parameters

puid  integer  
L'identifiant du protocole.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Version - Voir

requires authentication

Détails d'une version d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/version/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/version/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/version/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "version": 1,
        "date": "2021-09-09 12:29:03+02",
        "ressource":"{...}"
    }
}

Request   

GET protocole/{puid:[0-9]+}/version/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de la version.

Version - Validation - Lister

requires authentication

Liste des validations d'une version d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/version/1/validation?sort=nom.ASC%2Cid.DESC&page=6&limit=1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/version/1/validation"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/version/1/validation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "date": "2150-12-31 12:00:00+02",
            "trigramme": "Franchement, quelqu'un sait ce que c'est ?",
            "type": { ... },
            "remarques": "remarque"
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/version/{vuid:[0-9]+}/validation

URL Parameters

puid  integer  
L'identifiant du protocole.

vuid  integer  
L'identifiant de la version.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Version - Validation - Voir

requires authentication

Détails d'une validation d'une version d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/version/1/validation/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/version/1/validation/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/version/1/validation/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "date": "2150-12-31 12:00:00+02",
        "trigramme": "Franchement, quelqu'un sait ce que c'est ?",
        "type": { ... },
        "remarques": "remarque"
    }
}

Request   

GET protocole/{puid:[0-9]+}/version/{vuid:[0-9]+}/validation/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

vuid  integer  
L'identifiant de la version.

uid  integer  
L'identifiant de la validation.

Version - Validation - Ajouter

requires authentication

Ajoute une validation à une version d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/version/1/validation" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"trigramme":"Franchement, quelqu'un sait ce que c'est ?","type_uid":"validation1","remarques":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/version/1/validation"
);

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

let body = {
    "trigramme": "Franchement, quelqu'un sait ce que c'est ?",
    "type_uid": "validation1",
    "remarques": "null"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/version/1/validation',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'trigramme' => 'Franchement, quelqu\'un sait ce que c\'est ?',
            'type_uid' => 'validation1',
            'remarques' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "date": "2150-12-31 12:00:00+02",
        "trigramme": "Franchement, quelqu'un sait ce que c'est ?",
        "type": { ... },
        "remarques": null
    }
}

Request   

POST protocole/{puid:[0-9]+}/version/{vuid:[0-9]+}/validation

URL Parameters

puid  integer  
L'identifiant du protocole.

vuid  integer  
L'identifiant de la version.

Body Parameters

trigramme  string optional  
Le trigramme, j'en sais pas plus.

type_uid  string optional  
L'identifiant unique du type de la validation.

remarques  string optional  
Les remarques unique du type de la validation.

Fichier - Lister

requires authentication

Liste des fichiers d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/fichier" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/fichier"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "description": "valeur",
            "categorie": { ... },
            "media": { ... }
        }
    ]
}

Request   

GET protocole/{uid:[0-9]+}/fichier

URL Parameters

uid  integer  
L'identifiant du protocole.

Fichier - Modifier

requires authentication

Modifie les fichiers d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/fichier" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"fichiers":[{"id":"2"},{"id":"2"}]}'

const url = new URL(
    "https://api.oss.coop/protocole/1/fichier"
);

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

let body = {
    "fichiers": [
        {
            "id": "2"
        },
        {
            "id": "2"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/fichier',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'fichiers' => [
                [
                    'id' => '2',
                ],
                [
                    'id' => '2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "description": "valeur2",
            "categorie": { ... },
            "media": { ... }
        }
    ]
}

Request   

PUT protocole/{uid:[0-9]+}/fichier

URL Parameters

uid  integer  
L'identifiant du protocole.

Body Parameters

fichiers  object[]  
Les fichiers du protocole.

fichiers[].id  string  
Un identifiant de fichier existant.

Evenement - Lister

requires authentication

Liste des événements d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement?sort=nom.ASC%2Cid.DESC&page=14&limit=9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Evénement 1",
            "date_previsionnelle": "2150-12-31 12:00:00+02",
            "type": { ... },
            "stade": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/evenement

URL Parameters

puid  integer  
L'identifiant du protocole.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Lister Passages

requires authentication

Liste des événements implicites (passages) d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/passages?sort=nom.ASC%2Cid.DESC&page=4&limit=16" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/passages"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "4",
    "limit": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/passages',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '4',
            'limit'=> '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "ordre": 1,
            "stade": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/evenement/passages

URL Parameters

puid  integer  
L'identifiant du protocole.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Voir

requires authentication

Détails d'un événement d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Evénement 1",
        "date_previsionnelle": "2150-12-31 12:00:00+02",
        "type": { ... },
        "stade": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/evenement/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de l'événement.

Evenement - Ajouter

requires authentication

Ajoute un événement d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/evenement" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Ev\u00e9nement 2","observations":"Un autre \u00e9v\u00e9nement","date_previsionnelle":"2150-12-31 12:00:00+02","date_realisation":"2150-12-31 12:00:00+02","type_uid":"type1","passage_id":1,"stade_uid":"1"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement"
);

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

let body = {
    "designation": "Ev\u00e9nement 2",
    "observations": "Un autre \u00e9v\u00e9nement",
    "date_previsionnelle": "2150-12-31 12:00:00+02",
    "date_realisation": "2150-12-31 12:00:00+02",
    "type_uid": "type1",
    "passage_id": 1,
    "stade_uid": "1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/evenement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Evénement 2',
            'observations' => 'Un autre événement',
            'date_previsionnelle' => '2150-12-31 12:00:00+02',
            'date_realisation' => '2150-12-31 12:00:00+02',
            'type_uid' => 'type1',
            'passage_id' => 1,
            'stade_uid' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "observations": "Un autre événement",
        "date_previsionnelle": "2150-12-31 12:00:00+02",
        "type": { ... },
        "stade": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/evenement

URL Parameters

puid  integer  
L'identifiant du protocole.

Body Parameters

designation  string optional  
La designation de l'événement.

observations  string optional  
Les observations de l'événement.

date_previsionnelle  date optional  
La date prévisionnelle de l'événement.

date_realisation  date optional  
La date de réalisation de l'événement.

type_uid  string  
L'identifiant unique du type d'événement.

passage_id  integer optional  
L'identifiant de passage de l'événement.

stade_uid  string optional  
L'identifiant unique du stade de l'événement.

Evenement - Modifier

requires authentication

Modifie un événement d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/evenement/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"null","observations":"null","date_previsionnelle":"null","date_realisation":"null","type_uid":"type1","passage_id":0,"stade_uid":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/2"
);

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

let body = {
    "designation": "null",
    "observations": "null",
    "date_previsionnelle": "null",
    "date_realisation": "null",
    "type_uid": "type1",
    "passage_id": 0,
    "stade_uid": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/evenement/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'null',
            'observations' => 'null',
            'date_previsionnelle' => 'null',
            'date_realisation' => 'null',
            'type_uid' => 'type1',
            'passage_id' => 0,
            'stade_uid' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": null,
        "date_previsionnelle": null,
        "type": { ... },
        "stade": null
    }
}

Request   

PUT protocole/{puid:[0-9]+}/evenement/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de l'événement.

Body Parameters

designation  string optional  
La designation de l'événement.

observations  string optional  
Les observations de l'événement.

date_previsionnelle  date optional  
La date prévisionnelle de l'événement.

date_realisation  date optional  
La date de réalisation de l'événement.

type_uid  string  
L'identifiant unique du type d'événement.

passage_id  integer optional  
L'identifiant de passage de l'événement.

stade_uid  string optional  
L'identifiant unique du stade de l'événement.

Evenement - Supprimer

requires authentication

Supprime un événement d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/evenement/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/evenement/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/evenement/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant de l'événement.

Evenement - Variable - Lister

requires authentication

Liste des variables d'un événement d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/1/variable?sort=nom.ASC%2Cid.DESC&page=14&limit=11" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/1/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Variable",
            "ordre":1,
            "valeur_min": 0,
            "valeur_max": 12.5,
            "laboratoire": true,
            "variablepersonnalisee": false,
            "type": { ... },
            "variable": { ... },
            "unite": { ... },
            "saisie_niveau": { ... },
            "cible": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Variable - Voir

requires authentication

Détails d'une variable d'un événement d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/1/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/1/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Variable",
        "ordre":1,
        "valeur_min": 0,
        "valeur_max": 12.5,
        "laboratoire": true,
        "variablepersonnalisee": false,
        "type": { ... },
        "variable": { ... },
        "unite": { ... },
        "saisie_niveau": { ... },
        "cible": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la variable étudiée.

Evenement - Variable - Ajouter

requires authentication

Ajoute une variable à un événement d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/evenement/1/variable" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Variable2","ordre":2,"valeur_min":"0","valeur_max":"42","laboratoire":true,"variablepersonnalisee":true,"type_uid":"t1","variable_uid":"v1","unite_uid":"u1","saisie_niveau_uid":"sn1","cible_id":0}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable"
);

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

let body = {
    "designation": "Variable2",
    "ordre": 2,
    "valeur_min": "0",
    "valeur_max": "42",
    "laboratoire": true,
    "variablepersonnalisee": true,
    "type_uid": "t1",
    "variable_uid": "v1",
    "unite_uid": "u1",
    "saisie_niveau_uid": "sn1",
    "cible_id": 0
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/evenement/1/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Variable2',
            'ordre' => 2,
            'valeur_min' => '0',
            'valeur_max' => '42',
            'laboratoire' => true,
            'variablepersonnalisee' => true,
            'type_uid' => 't1',
            'variable_uid' => 'v1',
            'unite_uid' => 'u1',
            'saisie_niveau_uid' => 'sn1',
            'cible_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Variable2",
        "ordre": 2,
        "valeur_min": 0,
        "valeur_max": 42,
        "laboratoire": true,
        "variablepersonnalisee": true,
        "type": { ... },
        "variable": { ... },
        "unite": { ... },
        "saisie_niveau": { ... },
        "cible": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

Body Parameters

designation  string optional  
La designation de la variable étudiée.

ordre  integer optional  
L'ordre de la variable étudiée.

valeur_min  numeric optional  
La valeur mininmale de la variable étudiée.

valeur_max  numeric optional  
La valeur maxinmale de la variable étudiée.

laboratoire  boolean  
La provenance laboratoire de la variable étudiée.

variablepersonnalisee  boolean  
La personnalisation de la variable étudiée.

type_uid  string optional  
L'identifiant unique du type de la variable étudiée.

variable_uid  string optional  
L'identifiant unique de la variable associée à variable étudiée.

unite_uid  string optional  
L'identifiant unique de l'unité de la variable étudiée.

saisie_niveau_uid  string  
L'identifiant unique de niveau de saisie de la variable étudiée.

cible_id  integer optional  
L'identifiant de la valeur de référentiel cible.

Evenement - Variable - Modifier

requires authentication

Modifie une variable d'un événement d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/evenement/1/variable/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"null","ordre":0,"valeur_min":"null","valeur_max":"null","laboratoire":false,"variablepersonnalisee":false,"type_uid":"null","variable_uid":"null","unite_uid":"null","saisie_niveau_uid":"sn1","cible_id":0}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/2"
);

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

let body = {
    "designation": "null",
    "ordre": 0,
    "valeur_min": "null",
    "valeur_max": "null",
    "laboratoire": false,
    "variablepersonnalisee": false,
    "type_uid": "null",
    "variable_uid": "null",
    "unite_uid": "null",
    "saisie_niveau_uid": "sn1",
    "cible_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/evenement/1/variable/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'null',
            'ordre' => 0,
            'valeur_min' => 'null',
            'valeur_max' => 'null',
            'laboratoire' => false,
            'variablepersonnalisee' => false,
            'type_uid' => 'null',
            'variable_uid' => 'null',
            'unite_uid' => 'null',
            'saisie_niveau_uid' => 'sn1',
            'cible_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": null,
        "ordre": 3,
        "valeur_min": null,
        "valeur_max": null,
        "laboratoire": false,
        "variablepersonnalisee": false,
        "type": null,
        "variable": null,
        "unite": null,
        "saisie_niveau": { ... },
        "cible": null
    }
}

Request   

PUT protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la variable étudiée.

Body Parameters

designation  string optional  
La designation de la variable étudiée.

ordre  integer optional  
L'ordre de la variable étudiée.

valeur_min  numeric optional  
La valeur mininmale de la variable étudiée.

valeur_max  numeric optional  
La valeur maxinmale de la variable étudiée.

laboratoire  boolean  
La provenance laboratoire de la variable étudiée.

variablepersonnalisee  boolean  
La personnalisation de la variable étudiée.

type_uid  string optional  
L'identifiant unique du type de la variable étudiée.

variable_uid  string optional  
L'identifiant unique de la variable associée à variable étudiée.

unite_uid  string optional  
L'identifiant unique de l'unité de la variable étudiée.

saisie_niveau_uid  string  
L'identifiant unique de niveau de saisie de la variable étudiée.

cible_id  integer optional  
L'identifiant de la valeur de référentiel cible.

Evenement - Variable - Supprimer

requires authentication

Supprime une variable d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/evenement/1/variable/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/evenement/1/variable/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la variable étudiée.

Evenement - Variable - Organe - Lister

requires authentication

Liste des organes d'une variable d'un événement d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe?sort=nom.ASC%2Cid.DESC&page=16&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/1/variable/1/organe',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Variable",
            "ordre": 1,
            "nb_echantillons": 1
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{vuid:[0-9]+}/organe

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

vuid  integer  
L'identifiant de la variable étudiée.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Variable - Organe - Voir

requires authentication

Détails d'un organe d'une variable d'un événement d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Variable",
        "ordre": 1,
        "nb_echantillons": 1
    }
}

Request   

GET protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{vuid:[0-9]+}/organe/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de l'organe.

Evenement - Variable - Organe - Ajouter

requires authentication

Ajoute un organe à une variable à un événement d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Variable2","ordre":2,"nb_echantillons":2}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe"
);

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

let body = {
    "designation": "Variable2",
    "ordre": 2,
    "nb_echantillons": 2
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/evenement/1/variable/1/organe',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Variable2',
            'ordre' => 2,
            'nb_echantillons' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Variable2",
        "ordre": 2,
        "nb_echantillons": 2
    }
}

Request   

POST protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{vuid:[0-9]+}/organe

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

vuid  integer  
L'identifiant de la variable étudiée.

Body Parameters

designation  required optional  
La designation de la variable étudiée.

ordre  integer  
L'ordre de la variable étudiée.

nb_echantillons  integer  
Le nombre d'echantillons de la variable étudiée.

Evenement - Variable - Organe - Modifier

requires authentication

Modifie un organe d'une variable d'un événement d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Variable3","ordre":3,"nb_echantillons":3}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/2"
);

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

let body = {
    "designation": "Variable3",
    "ordre": 3,
    "nb_echantillons": 3
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Variable3',
            'ordre' => 3,
            'nb_echantillons' => 3,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Variable3",
        "ordre": 3,
        "nb_echantillons": 3
    }
}

Request   

PUT protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{vuid:[0-9]+}/organe/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de l'organe.

Body Parameters

designation  required optional  
La designation de la variable étudiée.

ordre  integer optional  
L'ordre de la variable étudiée.

nb_echantillons  integer  
Le nombre d'echantillons de la variable étudiée.

Evenement - Variable - Organe - Supprimer

requires authentication

Supprime un organe d'une variable d'un événement

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/evenement/1/variable/1/organe/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable/{vuid:[0-9]+}/organe/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

vuid  integer  
L'identifiant de la variable étudiée.

uid  integer  
L'identifiant de l'organe.

Evenement - Variable calculée - Lister

requires authentication

Liste des variables calculées d'un événement d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/1/variable_calculee?sort=nom.ASC%2Cid.DESC&page=16&limit=9" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "16",
    "limit": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '16',
            'limit'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "calcul": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable_calculee

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Evenement - Variable calculée - Voir

requires authentication

Détails d'une variable calculée d'un événement d'un protocole

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/1/evenement/1/variable_calculee/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/1/evenement/1/variable_calculee/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "calcul": { ... }
    }
}

Request   

GET protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable_calculee/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

uid  integer  
L'identifiant de la variable calculée.

Evenement - Variable calculée - Ajouter

requires authentication

Ajoute une variable calculée à un événement d'un protocole

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"calcul_id":0}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee"
);

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

let body = {
    "calcul_id": 0
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/evenement/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'calcul_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "calcul": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable_calculee

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

Body Parameters

calcul_id  integer  
L'identifiant de la variable associée à variable calculée.

Evenement - Variable calculée - Modifier

requires authentication

Modifie une variable calculée d'un événement d'un protocole

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"calcul_id":0}'

const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee"
);

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

let body = {
    "calcul_id": 0
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/evenement/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'calcul_id' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "calcul": { ... }
    }
}

Request   

PUT protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable_calculee

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

Body Parameters

calcul_id  integer  
L'identifiant de la variable associée à variable calculée.

Evenement - Variable calculée - Supprimer

requires authentication

Supprime une variable calculée d'un événement d'un protocole

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/evenement/1/variable_calculee"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/evenement/1/variable_calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/evenement/{evuid:[0-9]+}/variable_calculee

URL Parameters

puid  integer  
L'identifiant du protocole.

evuid  integer  
L'identifiant de l'événement.

Regroupement d'Essais - Lister

requires authentication

Liste des regroupements d'essais

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai?sort=nom.ASC%2Cid.DESC&page=17&limit=14" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "17",
    "limit": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '17',
            'limit'=> '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "valeur",
            "essais": "[essai1,essai2]",
            "filtres": "[filtre1,filtre2]",
            "modalites": "[modalite1,modalite2]",
            "variables": "[variable1,variable2]",
            "creation": "2021-06-14 17:27:35.911688+02",
            "modification": "2021-06-14 17:27:35.911688+02",
            "generation": "2021-06-14 17:27:35.911688+02",
            "media": { ... },
            "etat": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/regroupement_essai

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Regroupement d'Essais - Ajouter

requires authentication

Ajoute un regroupement d'essais

Example request:

curl -X POST \
    "https://api.oss.coop/protocole/1/regroupement_essai" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"valeur","filtres":"[filtre1,filtre2]"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai"
);

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

let body = {
    "nom": "valeur",
    "filtres": "[filtre1,filtre2]"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/protocole/1/regroupement_essai',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'valeur',
            'filtres' => '[filtre1,filtre2]',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "valeur",
        "essais": "[essai1,essai2]",
        "filtres": "[filtre1,filtre2]",
        "modalites": "[modalite1,modalite2]",
        "variables": "[variable1,variable2]",
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": null,
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

POST protocole/{puid:[0-9]+}/regroupement_essai

URL Parameters

puid  integer  
L'identifiant du protocole.

Body Parameters

nom  string optional  
Le nom du regroupement d'essais.

filtres  string optional  
Les filtres du regroupement d'essais.

Regroupement d'Essais - Modifier

requires authentication

Modifie un regroupement d'essais

Example request:

curl -X PUT \
    "https://api.oss.coop/protocole/1/regroupement_essai/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"null","filtres":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2"
);

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

let body = {
    "nom": "null",
    "filtres": "null"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/protocole/1/regroupement_essai/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'null',
            'filtres' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "null",
        "essais": "null",
        "filtres": "null",
        "modalites": "null",
        "variables": "null",
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": "2021-06-14 17:27:35.911688+02",
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

PUT protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

nom  string optional  
Le nom du regroupement d'essais.

filtres  string optional  
Les filtres du regroupement d'essais.

Regroupement d'Essais - Supprimer

requires authentication

Supprime un regroupement d'essais

Example request:

curl -X DELETE \
    "https://api.oss.coop/protocole/1/regroupement_essai/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/protocole/1/regroupement_essai/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

protocole/{puid:[0-9]+}/regroupement_essai/annee_regroupable

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai/annee_regroupable" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai/annee_regroupable"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai/annee_regroupable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Request   

GET protocole/{puid:[0-9]+}/regroupement_essai/annee_regroupable

Regroupement d'Essais - Essais - Lister

requires authentication

Liste des essais regroupables

Example request:

curl -X GET \
    -G "https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai/{rid:[0-9]+}/essai_regroupable?sort=nom.ASC%2Cid.DESC&page=8&limit=18" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai/{rid:[0-9]+}/essai_regroupable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "8",
    "limit": "18",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/protocole/{puid:[0-9]+}/regroupement_essai/{rid:[0-9]+}/essai_regroupable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '8',
            'limit'=> '18',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "essai",
            "numero": "azerty123",
            "surface_implantation_largeur": "123.456",
            "surface_implantation_longueur": "123.456",
            "surface_application_largeur": "123.456",
            "surface_application_longueur": "123.456",
            "surface_recoltee_largeur": "123.456",
            "surface_recoltee_longueur": "123.456",
            "plate_forme": false,
            "protocole": { ... },
            "parcelle": { ... },
            "modalite": { ... },
            "technicien": { ... }
        }
    ]
}

Request   

GET protocole/{puid:[0-9]+}/regroupement_essai/{rid:[0-9]+}/essai_regroupable

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Regroupement d'Essais - Statistiques

requires authentication

Génere les statistiques d'un regroupement d'essais

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/regroupement_essai/2/statistiques" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Rapport 3"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2/statistiques"
);

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

let body = {
    "designation": "Rapport 3"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/regroupement_essai/2/statistiques',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Rapport 3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Rapport 3",
        "details_erreur": null,
        "date_creation": "2150-12-31 12:00:00+02",
        "date_generation_debut": null,
        "date_generation_fin": null,
        "finalise": false,
        "erreur": false,
        "media": null
    }
}

Request   

PATCH protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}/statistiques

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

designation  string optional  
La designation du rapport.

Regroupement d'Essais - Essais

requires authentication

Modifie un regroupement d'essais

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/regroupement_essai/2/essai" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"essais":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2/essai"
);

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

let body = {
    "essais": "null"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/regroupement_essai/2/essai',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'essais' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "null",
        "essais": [ ... ],
        "filtres": "null",
        "modalites": [ ... ],
        "variables": [ ... ],
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": "2021-06-14 17:27:35.911688+02",
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

PATCH protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}/essai

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

essais  array  
Les essais du regroupement d'essais.

Regroupement d'Essais - Modalites

requires authentication

Modifie un regroupement d'essais

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/regroupement_essai/2/modalite" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"modalites":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2/modalite"
);

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

let body = {
    "modalites": "null"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/regroupement_essai/2/modalite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'modalites' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "null",
        "essais": [ ... ],
        "filtres": "null",
        "modalites": [ ... ],
        "variables": [ ... ],
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": "2021-06-14 17:27:35.911688+02",
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

PATCH protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}/modalite

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

modalites  array  
Les modalités du regroupement d'essais.

Regroupement d'Essais - Variables

requires authentication

Modifie un regroupement d'essais

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/regroupement_essai/2/variable" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variables":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2/variable"
);

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

let body = {
    "variables": "null"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/regroupement_essai/2/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variables' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "null",
        "essais": [ ... ],
        "filtres": "null",
        "modalites": [ ... ],
        "variables": [ ... ],
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": "2021-06-14 17:27:35.911688+02",
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

PATCH protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}/variable

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

variables  array  
Les modalités du regroupement d'essais.

Regroupement d'Essais - annees

requires authentication

Modifie un regroupement d'essais

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/regroupement_essai/2/annee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"annees":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2/annee"
);

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

let body = {
    "annees": "null"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/regroupement_essai/2/annee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'annees' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "null",
        "essais": [ ... ],
        "filtres": "null",
        "modalites": [ ... ],
        "variables": [ ... ],
        "repetitions": [ ... ],
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": "2021-06-14 17:27:35.911688+02",
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

PATCH protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}/annee

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

annees  array  
Les annees du regroupement d'essais.

Regroupement d'Essais - Repetitions

requires authentication

Modifie un regroupement d'essais

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/regroupement_essai/2/repetition" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"repetitions":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2/repetition"
);

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

let body = {
    "repetitions": "null"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/regroupement_essai/2/repetition',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'repetitions' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "null",
        "essais": [ ... ],
        "filtres": "null",
        "modalites": [ ... ],
        "variables": [ ... ],
        "repetitions": [ ... ],
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": "2021-06-14 17:27:35.911688+02",
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

PATCH protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}/repetition

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

repetitions  array  
Les modalités du regroupement d'essais.

Regroupement d'Essais - Variables calculées

requires authentication

Modifie un regroupement d'essais

Example request:

curl -X PATCH \
    "https://api.oss.coop/protocole/1/regroupement_essai/2/variable-calculee" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"variables":"null"}'

const url = new URL(
    "https://api.oss.coop/protocole/1/regroupement_essai/2/variable-calculee"
);

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

let body = {
    "variables": "null"
}

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/protocole/1/regroupement_essai/2/variable-calculee',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'variables' => 'null',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "null",
        "essais": [ ... ],
        "filtres": "null",
        "modalites": [ ... ],
        "variables": [ ... ],
        "creation": "2021-06-14 17:27:35.911688+02",
        "modification": "2021-06-14 17:27:35.911688+02",
        "generation": null,
        "media": null,
        "etat": { ... }
    }
}

Request   

PATCH protocole/{puid:[0-9]+}/regroupement_essai/{uid:[0-9]+}/variable-calculee

URL Parameters

puid  integer  
L'identifiant du protocole.

uid  integer  
L'identifiant du regroupement d'essais.

Body Parameters

variables  array  
Les modalités du regroupement d'essais.

Zone - Lister

requires authentication

Liste des zones d'un modele d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/etiquette/modele/1/zone?sort=nom.ASC%2Cid.DESC&page=2&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/etiquette/modele/1/zone"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "2",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/etiquette/modele/1/zone',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '2',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "couleur": "#00FFFF",
            "taille_texte": "12.5",
            "gras": false,
            "italic": false,
            "gabarit_zone": { ... }
        }
    ]
}

Request   

GET etiquette/modele/{muid:[0-9]+}/zone

URL Parameters

muid  integer  
L'identifiant du modele d'étiquettes.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Zone - Voir

requires authentication

Détails d'une zone d'un modele d'étiquettes

Example request:

curl -X GET \
    -G "https://api.oss.coop/etiquette/modele/1/zone/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/etiquette/modele/1/zone/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/etiquette/modele/1/zone/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "couleur": "#00FFFF",
        "taille_texte": "12.5",
        "gras": false,
        "italic": false,
        "gabarit_zone": { ... }
    }
}

Request   

GET etiquette/modele/{muid:[0-9]+}/zone/{uid:[0-9]+}

URL Parameters

muid  integer  
L'identifiant du modele d'étiquettes.

uid  integer  
L'identifiant de la zone.

Zone - Ajouter

requires authentication

Ajoute une zone d'un modele d'étiquettes

Example request:

curl -X POST \
    "https://api.oss.coop/etiquette/modele/1/zone" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"couleur":"#F00","taille_texte":"16.5","gras":"true","italic":"true","gabarit_zone_uid":"gabarit1"}'

const url = new URL(
    "https://api.oss.coop/etiquette/modele/1/zone"
);

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

let body = {
    "couleur": "#F00",
    "taille_texte": "16.5",
    "gras": "true",
    "italic": "true",
    "gabarit_zone_uid": "gabarit1"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/etiquette/modele/1/zone',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'couleur' => '#F00',
            'taille_texte' => '16.5',
            'gras' => 'true',
            'italic' => 'true',
            'gabarit_zone_uid' => 'gabarit1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "couleur": "#F00",
        "taille_texte": "16.5",
        "gras": true,
        "italic": true,
        "gabarit_zone": { ... }
    }
}

Request   

POST etiquette/modele/{muid:[0-9]+}/zone

URL Parameters

muid  integer  
L'identifiant du modele d'étiquettes.

Body Parameters

couleur  string  
La couleur du texte de la zone.

taille_texte  numeric optional  
La taille du texte de la zone.

gras  booelan  
La mise en gras du texte de la zone.

italic  booelan  
La mise en gras du texte de la zone.

gabarit_zone_uid  string  
L'identifiant unique du gabarit de la zone.

Zone - Modifier

requires authentication

Modifie une zone d'un modele d'étiquettes

Example request:

curl -X PUT \
    "https://api.oss.coop/etiquette/modele/1/zone/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"couleur":"#F00","taille_texte":"12.5","gras":"false","italique":"false","gabarit_zone_id":"gabarit1","type_valeuretiquette_uid":"valeur1"}'

const url = new URL(
    "https://api.oss.coop/etiquette/modele/1/zone/2"
);

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

let body = {
    "couleur": "#F00",
    "taille_texte": "12.5",
    "gras": "false",
    "italique": "false",
    "gabarit_zone_id": "gabarit1",
    "type_valeuretiquette_uid": "valeur1"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/etiquette/modele/1/zone/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'couleur' => '#F00',
            'taille_texte' => '12.5',
            'gras' => 'false',
            'italique' => 'false',
            'gabarit_zone_id' => 'gabarit1',
            'type_valeuretiquette_uid' => 'valeur1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "couleur": "#F00",
        "taille_texte": "12.5",
        "gras": false,
        "italic": false,
        "gabarit_zone": { ... }
        "type_valeur": { ... }
    }
}

Request   

PUT etiquette/modele/{muid:[0-9]+}/zone/{uid:[0-9]+}

URL Parameters

muid  integer  
L'identifiant du modele d'étiquettes.

uid  integer  
L'identifiant de la zone.

Body Parameters

couleur  string  
La couleur du texte de la zone.

taille_texte  numeric optional  
La taille du texte de la zone.

gras  booelan  
La mise en gras du texte de la zone.

italique  booelan  
La mise en gras du texte de la zone.

gabarit_zone_id  string  
L'identifiant unique du gabarit de la zone.

type_valeuretiquette_uid  string  
L'identifiant unique du type de valeur d'étiquette.

Zone - Supprimer

requires authentication

Supprime une zone d'un modele d'étiquettes

Example request:

curl -X DELETE \
    "https://api.oss.coop/etiquette/modele/1/zone/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/etiquette/modele/1/zone/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/etiquette/modele/1/zone/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE etiquette/modele/{muid:[0-9]+}/zone/{uid:[0-9]+}

URL Parameters

muid  integer  
L'identifiant du modele d'étiquettes.

uid  integer  
L'identifiant de la zone.

Rapports

Generate

Génération d'un rapport fixe

requires authentication

Example request:

curl -X POST \
    "https://api.oss.coop/rapport/9/generate" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/rapport/9/generate"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/rapport/9/generate',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
  "meta" : { ... },
  "data" : { ... }
}

Request   

POST rapport/{rid}/generate

URL Parameters

rid  integer  
l'identifiant de la ressource

Server status

Retourne le statut du serveur statistiques

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/server/stats/status" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/server/stats/status"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/server/stats/status',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
  "meta" : { ... },
  "data" : { ... }
}

Request   

GET server/stats/status

Regroupement Exports

Generate

Génération d'un rapport fixe

requires authentication

Example request:

curl -X POST \
    "https://api.oss.coop/regroupement/3/generate" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/regroupement/3/generate"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/regroupement/3/generate',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
  "meta" : { ... },
  "data" : { ... }
}

Request   

POST regroupement/{rid}/generate

URL Parameters

rid  integer  
l'identifiant de la ressource

Tableau de bord

Essais

Liste des essais du tableau de bord

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/tableau-de-bord/essai?sort=nom.ASC%2Cid.DESC&page=14&limit=11" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tableau-de-bord/essai"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/tableau-de-bord/essai',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "essai",
            "numero": "azerty123",
            "surface_implantation_largeur": "123.456",
            "surface_implantation_longueur": "123.456",
            "surface_application_largeur": "123.456",
            "surface_application_longueur": "123.456",
            "surface_recoltee_largeur": "123.456",
            "surface_recoltee_longueur": "123.456",
            "plate_forme": false,
            "protocole": { ... },
            "parcelle": { ... },
            "modalite": { ... },
            "technicien": { ... }
        }
    ]
}

Request   

GET tableau-de-bord/essai

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Essais - Carte

Liste des essais et essais issus du partage du tableau de bord pour la carte

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/tableau-de-bord/map?sort=nom.ASC%2Cid.DESC&page=5&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tableau-de-bord/map"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "5",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/tableau-de-bord/map',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '5',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "essai",
            "numero": "azerty123",
            "surface_implantation_largeur": "123.456",
            "surface_implantation_longueur": "123.456",
            "surface_application_largeur": "123.456",
            "surface_application_longueur": "123.456",
            "surface_recoltee_largeur": "123.456",
            "surface_recoltee_longueur": "123.456",
            "plate_forme": false,
            "protocole": { ... },
            "parcelle": { ... },
            "modalite": { ... },
            "technicien": { ... }
        }
    ]
}

Request   

GET tableau-de-bord/map

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Essais - Protocole

Liste des essais issus d'un protocole du tableau de bord

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/tableau-de-bord/protocole/1?sort=nom.ASC%2Cid.DESC&page=9&limit=19" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tableau-de-bord/protocole/1"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/tableau-de-bord/protocole/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "nom": "essai",
            "numero": "azerty123",
            "surface_implantation_largeur": "123.456",
            "surface_implantation_longueur": "123.456",
            "surface_application_largeur": "123.456",
            "surface_application_longueur": "123.456",
            "surface_recoltee_largeur": "123.456",
            "surface_recoltee_longueur": "123.456",
            "plate_forme": false,
            "protocole": { ... },
            "parcelle": { ... },
            "modalite": { ... },
            "technicien": { ... }
        }
    ]
}

Request   

GET tableau-de-bord/protocole/{puid:[0-9]+}

URL Parameters

puid  integer  
L'identifiant du protocole.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Essais - Evenement

Liste des événements du tableau de bord

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/tableau-de-bord/essai/evenement?sort=nom.ASC%2Cid.DESC&page=18&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tableau-de-bord/essai/evenement"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "18",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/tableau-de-bord/essai/evenement',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '18',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Evénement 1",
            "observations": "Un événement",
            "date_previsionnelle": "2150-12-31 12:00:00+02",
            "date_realisation": "2150-12-31 12:00:00+02",
            "type": { ... },
            "passage": { ... },
            "stade": { ... }
        }
    ]
}

Request   

GET tableau-de-bord/essai/evenement

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Chiffres

Chiffres sur les essais du tableau de bord

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/tableau-de-bord/essai/chiffres[/{year:[0-9\,]+}]?sort=nom.ASC%2Cid.DESC&page=4&limit=20" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tableau-de-bord/essai/chiffres[/{year:[0-9\,]+}]"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "4",
    "limit": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/tableau-de-bord/essai/chiffres[/{year:[0-9\,]+}]',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '4',
            'limit'=> '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


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

Request   

GET tableau-de-bord/essai/chiffres[/{year:[0-9\,]+}]

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Taches Asynchrones

Lister

requires authentication

Liste des taches asynchrones

Example request:

curl -X GET \
    -G "https://api.oss.coop/tache-asynchrone?sort=nom.ASC%2Cid.DESC&page=9&limit=8" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tache-asynchrone"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "9",
    "limit": "8",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/tache-asynchrone',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '9',
            'limit'=> '8',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "creation": "2150-12-31 12:00:00+02",
            "reception": null,
            "adresse": null,
            "codepostal": null,
            "ville": null,
            "informationscomplementaires": null,
            "nom": null,
            "contact": null,
            "tel": null,
            "pays": null,
            "statut": { ... }
        }
    ]
}

Request   

GET tache-asynchrone

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'une tache asynchrone

Example request:

curl -X GET \
    -G "https://api.oss.coop/tache-asynchrone/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tache-asynchrone/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/tache-asynchrone/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "creation": "2150-12-31 12:00:00+02",
        "reception": null,
        "adresse": null,
        "codepostal": null,
        "ville": null,
        "informationscomplementaires": null,
        "nom": null,
        "contact": null,
        "tel": null,
        "pays": null,
        "statut": { ... }
    }
}

Request   

GET tache-asynchrone/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la tache asynchrone.

Ajouter

requires authentication

Ajoute une tache asynchrone

Example request:

curl -X POST \
    "https://api.oss.coop/tache-asynchrone" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"type":"export_excel_essai_all_notations","parameters":"{\"essai_id\":1}"}'

const url = new URL(
    "https://api.oss.coop/tache-asynchrone"
);

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

let body = {
    "type": "export_excel_essai_all_notations",
    "parameters": "{\"essai_id\":1}"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/tache-asynchrone',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'type' => 'export_excel_essai_all_notations',
            'parameters' => '{"essai_id":1}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "creation": "2150-12-31 12:00:00+02",
        "reception": null,
        "adresse": "2 Rue de Dublin",
        "codepostal": "67300",
        "ville": "Schiltigheim",
        "informationscomplementaires": "Informations complementaires,"
        "nom": "Mathieu",
        "contact": "mhaller@diatem.net",
        "tel": "0123456789",
        "pays": { ... },
        "statut": { ... }
    }
}

Request   

POST tache-asynchrone

Body Parameters

type  string optional  
Le type de la tache asynchrone.

parameters  string optional  
Les parametres de la tache asynchrone.

Annuler

requires authentication

Annule une commande

Example request:

curl -X PATCH \
    "https://api.oss.coop/tache-asynchrone/2/annuler" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tache-asynchrone/2/annuler"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/tache-asynchrone/2/annuler',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH tache-asynchrone/{uid:[0-9]+}/annuler

URL Parameters

uid  integer  
L'identifiant de la commande.

Relancer

requires authentication

Relance une commande

Example request:

curl -X PATCH \
    "https://api.oss.coop/tache-asynchrone/2/relancer" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tache-asynchrone/2/relancer"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.oss.coop/tache-asynchrone/2/relancer',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

PATCH tache-asynchrone/{uid:[0-9]+}/relancer

URL Parameters

uid  integer  
L'identifiant de la commande.

Supprimer

requires authentication

Supprime une tache asynchrone

Example request:

curl -X DELETE \
    "https://api.oss.coop/tache-asynchrone/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/tache-asynchrone/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/tache-asynchrone/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE tache-asynchrone/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la tache asynchrone.

Taches

Tâches

Télécharger un document

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/taches/type/aut/ressource/quo/11/qui?position_geographique=1&modalite_bloc=&numero_ligne=1&numero_colonne=&numero_modalite=1&numero_bloc=&libelle_modalite=&type_modalite=1&couleurs=&modalites_off=veritatis&all=1&all_modalities=" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/taches/type/aut/ressource/quo/11/qui"
);

let params = {
    "position_geographique": "1",
    "modalite_bloc": "",
    "numero_ligne": "1",
    "numero_colonne": "",
    "numero_modalite": "1",
    "numero_bloc": "",
    "libelle_modalite": "",
    "type_modalite": "1",
    "couleurs": "",
    "modalites_off": "veritatis",
    "all": "1",
    "all_modalities": "",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/taches/type/aut/ressource/quo/11/qui',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'position_geographique'=> '1',
            'modalite_bloc'=> '',
            'numero_ligne'=> '1',
            'numero_colonne'=> '',
            'numero_modalite'=> '1',
            'numero_bloc'=> '',
            'libelle_modalite'=> '',
            'type_modalite'=> '1',
            'couleurs'=> '',
            'modalites_off'=> 'veritatis',
            'all'=> '1',
            'all_modalities'=> '',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
  Le document
}

Request   

GET taches/type/{type:[a-z]+}/ressource/{ressource:[a-zA-Z-]+}/{rid:[0-9]+}[/{childRessource:[a-zA-Z-]+}]

URL Parameters

type  string  
le type du document à télécharger (pdf ou xls)

ressource  string  
la ressource à appeller pour remplir le doc (protocole , essai, evenement, notation ...)

rid  integer  
l'identifiant de la ressource

childRessource  string optional  
la sous-ressource à charger (modalites, parcelle-fiche, parcelle, plan, bilan, calendrier, fiche-pesee, conditions-traitement, conditions-recolte, donnees-consolidees...)

Query Parameters

position_geographique  boolean optional  

modalite_bloc  boolean optional  

numero_ligne  boolean optional  

numero_colonne  boolean optional  

numero_modalite  boolean optional  

numero_bloc  boolean optional  

libelle_modalite  boolean optional  

type_modalite  boolean optional  

couleurs  boolean optional  

modalites_off  string optional  

all  boolean optional  

all_modalities  boolean optional  

Etiquettes parcelles

Télécharger une planche d'étiquettes parcelles

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/taches/type/officiis/ressource/essai/11/etiquettes/12/parcelles?niveausaisie_uid=omnis&tuple=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/taches/type/officiis/ressource/essai/11/etiquettes/12/parcelles"
);

let params = {
    "niveausaisie_uid": "omnis",
    "tuple": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/taches/type/officiis/ressource/essai/11/etiquettes/12/parcelles',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'niveausaisie_uid'=> 'omnis',
            'tuple'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
  Le document
}

Request   

GET taches/type/{type:[a-z]+}/ressource/essai/{eid:[0-9]+}/etiquettes/{mid:[0-9]+}/parcelles

URL Parameters

type  string  
le type du document à télécharger (pdf)

eid  integer  
l'identifiant de l'essai

mid  integer  
l'identifiant du modèle d'étiquette

Query Parameters

niveausaisie_uid  string optional  
Uid du niveau de saisie

tuple  integer optional  
Chiffre indiquant tous les tuple etiquettes à imprimer

Etiquettes produits

Télécharger une planche d'étiquettes produits

requires authentication

Example request:

curl -X GET \
    -G "https://api.oss.coop/taches/type/eum/ressource/evenement/12/etiquettes/10/produits" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/taches/type/eum/ressource/evenement/12/etiquettes/10/produits"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/taches/type/eum/ressource/evenement/12/etiquettes/10/produits',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
  Le document
}

Request   

GET taches/type/{type:[a-z]+}/ressource/evenement/{eid:[0-9]+}/etiquettes/{mid:[0-9]+}/produits

URL Parameters

type  string  
le type du document à télécharger (pdf)

eid  integer  
l'identifiant de l'essai

mid  integer  
l'identifiant du modèle d'étiquette

Unités

Lister

requires authentication

Liste des unités

Example request:

curl -X GET \
    -G "https://api.oss.coop/unite?sort=nom.ASC%2Cid.DESC&page=14&limit=13" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/unite"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "14",
    "limit": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/unite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '14',
            'limit'=> '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "valeur": "valeur"
        }
    ]
}

Request   

GET unite

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'une unité

Example request:

curl -X GET \
    -G "https://api.oss.coop/unite/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/unite/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/unite/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "id_unique_universel",
        "valeur": "valeur"
    }
}

Request   

GET unite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'unité.

Ajouter

requires authentication

Ajoute une unité

Example request:

curl -X POST \
    "https://api.oss.coop/unite" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel2","valeur":"valeur2"}'

const url = new URL(
    "https://api.oss.coop/unite"
);

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

let body = {
    "uid": "id_unique_universel2",
    "valeur": "valeur2"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/unite',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel2',
            'valeur' => 'valeur2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel2",
        "valeur": "valeur2"
    }
}

Request   

POST unite

Body Parameters

uid  string  
L'identifiant unique de l'unité.

valeur  string  
La valeur de l'unité.

Modifier

requires authentication

Modifie une unité

Example request:

curl -X PUT \
    "https://api.oss.coop/unite/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"id_unique_universel3","valeur":"valeur3"}'

const url = new URL(
    "https://api.oss.coop/unite/2"
);

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

let body = {
    "uid": "id_unique_universel3",
    "valeur": "valeur3"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/unite/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'id_unique_universel3',
            'valeur' => 'valeur3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "id_unique_universel3",
        "valeur": "valeur3"
    }
}

Request   

PUT unite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'unité.

Body Parameters

uid  string  
L'identifiant unique de l'unité.

valeur  string  
La valeur de l'unité.

Supprimer

requires authentication

Supprime une unité

Example request:

curl -X DELETE \
    "https://api.oss.coop/unite/14" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/unite/14"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/unite/14',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE unite/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'unité.

Utilisateurs

Lister

requires authentication

Liste des utilisateurs

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilisateur?sort=nom.ASC%2Cid.DESC&page=6&limit=4" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilisateur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "6",
    "limit": "4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilisateur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '6',
            'limit'=> '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "entite": { ... },
            "profils": [ ... ],
            "avatar": { ... },
            "nom": "Louis",
            "prenom": "JAEGER",
            "nom_complet": "Louis JAEGER",
            "email": "ljaeger@diatem.net",
            "identifiant": "ljaeger",
            "telportable": "012345789",
            "couleur": 2
        }
    ]
}

Request   

GET utilisateur

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Voir

requires authentication

Détails d'un utliisateur

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilisateur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilisateur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilisateur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "entite": { ... },
        "profils": [ ... ],
        "avatar": { ... },
        "nom": "Louis",
        "prenom": "JAEGER",
        "nom_complet": "Louis JAEGER",
        "email": "ljaeger@diatem.net",
        "identifiant": "ljaeger",
        "telportable": "012345789",
        "couleur": 2
    }
}

Request   

GET utilisateur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'utilisateur.

Ajouter

requires authentication

Ajoute un utliisateur

Example request:

curl -X POST \
    "https://api.oss.coop/utilisateur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Jean-Luc","prenom":"Fritz","email":"jlfritz@diatem.net","actif":true,"telportable":"quo","entite_id":1,"avatar_id":5}'

const url = new URL(
    "https://api.oss.coop/utilisateur"
);

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

let body = {
    "nom": "Jean-Luc",
    "prenom": "Fritz",
    "email": "jlfritz@diatem.net",
    "actif": true,
    "telportable": "quo",
    "entite_id": 1,
    "avatar_id": 5
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/utilisateur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Jean-Luc',
            'prenom' => 'Fritz',
            'email' => 'jlfritz@diatem.net',
            'actif' => true,
            'telportable' => 'quo',
            'entite_id' => 1,
            'avatar_id' => 5,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "entite": { ... },
        "profils": [ ... ],
        "avatar": { ... },
        "avatar": null,
        "nom": "Jean-Luc",
        "prenom": "Fritz",
        "nom_complet": "Jean-Luc Fritz",
        "email": "jlfritz@diatem.net",
        "identifiant": "jlfritz",
        "telportable": null,
        "couleur": 3
    }
}

Request   

POST utilisateur

Body Parameters

nom  string optional  
Le nom de l'utilisateur. Défaut à null.

prenom  string optional  
Le prénom de l'utilisateur. Défaut à null.

email  string  
L'email de l'utilisateur.

actif  boolean optional  
Si l'utilisateur est actif. Défaut à true

telportable  string optional  
Le téléphone portable de l'utilisateur. Défaut à null

entite_id  integer  
L'identifiant d'entité de l'utilisateur. Si le créateur n'a les droits que sur son entité, la valeur est forcée.

avatar_id  integer optional  
L'identifiant unique du média associé à l'utilisateur. Défaut à null

Modifier

requires authentication

Modifie un utliisateur

Example request:

curl -X PUT \
    "https://api.oss.coop/utilisateur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"nom":"Luc-Jean","prenom":"Ztirf","email":"ljztirf@diatem.net","actif":true,"telportable":"0123456789","entite_id":1,"avatar_id":2}'

const url = new URL(
    "https://api.oss.coop/utilisateur/2"
);

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

let body = {
    "nom": "Luc-Jean",
    "prenom": "Ztirf",
    "email": "ljztirf@diatem.net",
    "actif": true,
    "telportable": "0123456789",
    "entite_id": 1,
    "avatar_id": 2
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/utilisateur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'nom' => 'Luc-Jean',
            'prenom' => 'Ztirf',
            'email' => 'ljztirf@diatem.net',
            'actif' => true,
            'telportable' => '0123456789',
            'entite_id' => 1,
            'avatar_id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "entite": { ... },
        "profils": [ ... ],
        "avatar": { ... },
        "nom": "Luc-Jean",
        "prenom": "Ztirf",
        "nom_complet": "Luc-Jean Ztirf",
        "email": "ljztirf@diatem.net",
        "identifiant": "ljztirf",
        "telportable": "0123456789",
        "couleur": 3
    }
}

Request   

PUT utilisateur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'utilisateur.

Body Parameters

nom  string optional  
Le nom de l'utilisateur. Défaut à null.

prenom  string optional  
Le prénom de l'utilisateur. Défaut à null.

email  string  
L'email de l'utilisateur.

actif  boolean optional  
Si l'utilisateur est actif. Défaut à true

telportable  string optional  
Le téléphone portable de l'utilisateur. Défaut à null.

entite_id  integer  
L'identifiant d'entité de l'utilisateur. Si le créateur n'a les droits que sur son entité, la valeur est forcée.

avatar_id  integer optional  
L'identifiant unique du média associé à l'utilisateur. Défaut à null.

Supprimer

requires authentication

Supprime un utliisateur

Example request:

curl -X DELETE \
    "https://api.oss.coop/utilisateur/10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilisateur/10"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/utilisateur/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE utilisateur/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de l'utilisateur.

Mot de passe

requires authentication

Envoie un mail à l'utilisateur cible contenant un lien de renouvellement de mot de passe.

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilisateur/1/mdp" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilisateur/1/mdp"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilisateur/1/mdp',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": "Un email de renouvellement de mot de passe à été envoyé."
}

Request   

GET utilisateur/{uid:[0-9]+}/mdp

URL Parameters

uid  integer  
L'identifiant de l'utilisateur.

Profil - Lister

requires authentication

Liste des profils d'un utilisateur

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilisateur/1/profil" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilisateur/1/profil"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilisateur/1/profil',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "id_unique_universel",
            "designation": "valeur"
        }
    ]
}

Request   

GET utilisateur/{uid:[0-9]+}/profil

URL Parameters

uid  integer  
L'identifiant de l'utilisateur.

Profil - Modifier

requires authentication

Modifie les profils d'un utliisateur

Example request:

curl -X PUT \
    "https://api.oss.coop/utilisateur/1/profil" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"profils":[{"uid":"id_unique_universel2"},{"uid":"id_unique_universel2"}]}'

const url = new URL(
    "https://api.oss.coop/utilisateur/1/profil"
);

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

let body = {
    "profils": [
        {
            "uid": "id_unique_universel2"
        },
        {
            "uid": "id_unique_universel2"
        }
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/utilisateur/1/profil',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'profils' => [
                [
                    'uid' => 'id_unique_universel2',
                ],
                [
                    'uid' => 'id_unique_universel2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "uid": "id_unique_universel2",
            "designation": "valeur2"
        }
    ]
}

Request   

PUT utilisateur/{uid:[0-9]+}/profil

URL Parameters

uid  integer  
L'identifiant de l'utilisateur.

Body Parameters

profils  object[]  
Les profils de l'utilisateur.

profils[].uid  string  
Un identifiant de profil unique existant.

Utilitaires

Média - Lister

requires authentication

Liste des médias

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilitaire/media?sort=nom.ASC%2Cid.DESC&page=11&limit=6" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilitaire/media"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "11",
    "limit": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilitaire/media',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '11',
            'limit'=> '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 2,
            "nom": "nom utilisateur",
            "jeton": "jeton_de_stockage",
            "extension": "png",
            "taille": 87172,
            "utilisateur": { ... },
            "type": {
                "id": 1,
                "mimetype": "image/jpeg,image/png",
                "nom": "Avatar",
                "uid": "avatar",
                "taille_min": null,
                "taille_max": 1024,
                "largeur_min": 256,
                "largeur_max": null,
                "hauteur_min": 256,
                "hauteur_max": null
            }
        }
    ]
}

Request   

GET utilitaire/media

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Média - Voir

requires authentication

Détails d'un média

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilitaire/media/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilitaire/media/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilitaire/media/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "destinataire": "ljaeger@diatem.net",
        "expediteur": "ljaeger@test.com",
        "objet": "Renouvellement de mot de passe",
        "contenu": "<!DOCTYPE html>\n<html></html>",
        "date_creation": "2021-06-14 17:27:35.911688+02",
        "date_envoi": null
    }
}

Request   

GET utilitaire/media/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du média.

Média - Supprimer

requires authentication

Supprime un média

Example request:

curl -X DELETE \
    "https://api.oss.coop/utilitaire/media/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilitaire/media/2"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/utilitaire/media/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE utilitaire/media/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du média.

Média - Téléverser

requires authentication

Ajoute un media et son entrée en BDD

Example request:

curl -X POST \
    "https://api.oss.coop/utilitaire/media/televerser" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: multipart/form-data" \
    -F "morceau=@/tmp/phpy2RcM2" 
const url = new URL(
    "https://api.oss.coop/utilitaire/media/televerser"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('morceau', document.querySelector('input[name="morceau"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/utilitaire/media/televerser',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'multipart' => [
            [
                'name' => 'morceau',
                'contents' => fopen('/tmp/phpy2RcM2', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": 'en cours de téléversement'
}

Example response (201):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "nom": "nom utilisateur2",
        "jeton": "jeton_de_stockage2",
        "extension": "jpg",
        "taille": 87172,
        "utilisateur": { ... },
        "type": {
            "id": 1,
            "mimetype": "image/jpeg,image/png",
            "nom": "Avatar",
            "uid": "avatar",
            "taille_min": null,
            "taille_max": 1024,
            "largeur_min": 256,
            "largeur_max": null,
            "hauteur_min": 256,
            "hauteur_max": null
        }
    }
}

Request   

POST utilitaire/media/televerser

Body Parameters

meta  object optional  

meta.nom  string optional  
Le nom du fichier.

meta.taille  integer optional  
La taille en Kb du ficher. Doit être inférieur à la taille maximale définie pour le type de fichier sélectionné.

meta.extension  string optional  
L'extension du fichier. Doit être disponnible dans la liste des extensions associées au mimetypes autorisés pour le type de fichier sélectionné. Voir la liste sur http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types.

meta.longueur  integer optional  
La longueur correspond au nombre de morceaux que le fichier contient. Elle doit être égale au résultat de la division de la taille totale du fichier en Kb par la taille d'un morceau en Kb arrondi à l'entier supérieur.

meta.type_uid  string optional  
L'identifiant unique du type de media téléversé. Sert pour définir les contraintes précédentes.

morceau  file optional  
Un morceau du fichier à reconstituer.

Mail - Lister

requires authentication

Liste des mails

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilitaire/mail?sort=nom.ASC%2Cid.DESC&page=12&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilitaire/mail"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "12",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilitaire/mail',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '12',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "destinataire": "ljaeger@diatem.net",
            "expediteur": "ljaeger@test.com",
            "objet": "Renouvellement de mot de passe",
            "contenu": "<!DOCTYPE html>\n<html></html>",
            "date_creation": "2021-06-14 17:27:35.911688+02",
            "date_envoi": null
        }
    ]
}

Request   

GET utilitaire/mail

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Mail - Voir

requires authentication

Détails d'un mail

Example request:

curl -X GET \
    -G "https://api.oss.coop/utilitaire/mail/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilitaire/mail/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/utilitaire/mail/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "destinataire": "ljaeger@diatem.net",
        "expediteur": "ljaeger@test.com",
        "objet": "Renouvellement de mot de passe",
        "contenu": "<!DOCTYPE html>\n<html></html>",
        "date_creation": "2021-06-14 17:27:35.911688+02",
        "date_envoi": null
    }
}

Request   

GET utilitaire/mail/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant du mail.

error

requires authentication

Envoie un mail d'erreur

Example request:

curl -X POST \
    "https://api.oss.coop/utilitaire/mail/erreur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/utilitaire/mail/erreur"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/utilitaire/mail/erreur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

{}

Request   

POST utilitaire/mail/erreur

Variables

Référentiel - Variable - Lister

requires authentication

Liste des variables d'un référentiel

Example request:

curl -X GET \
    -G "https://api.oss.coop/variable?sort=nom.ASC%2Cid.DESC&page=10&limit=12" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/variable"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "10",
    "limit": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '10',
            'limit'=> '12',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "uid": "v1",
            "designation": "Azertyuiop",
            "valeur_min": "0",
            "valeur_max": "12.5",
            "laboratoire": false,
            "type": { ... },
            "unite": { ... },
            "themes": [ { ... } ],
            "variables_calculees": [ { ... } ]
        }
    ]
}

Request   

GET variable

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Référentiel - Variable - Voir

requires authentication

Détails d'une variable d'un référentiel

Example request:

curl -X GET \
    -G "https://api.oss.coop/variable/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/variable/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/variable/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "uid": "v1",
        "designation": "Azertyuiop",
        "valeur_min": "0",
        "valeur_max": "12.5",
        "laboratoire": false,
        "type": { ... },
        "unite": { ... },
        "themes": [ { ... } ],
        "variables_calculees": [ { ... } ]
    }
}

Request   

GET variable/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la variable.

Référentiel - Variable - Ajouter

requires authentication

Ajoute une variable à un référentiel

Example request:

curl -X POST \
    "https://api.oss.coop/variable" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"v2","designation":"Poiuytreza","valeur_min":"0","valeur_max":"12.5","laboratoire":false,"type_uid":"t1","unite_uid":"u1","themes":[{"uid":"t1"},{"uid":"t1"}],"variables_calculees":[{"uid":"vc1"},{"uid":"vc1"}]}'

const url = new URL(
    "https://api.oss.coop/variable"
);

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

let body = {
    "uid": "v2",
    "designation": "Poiuytreza",
    "valeur_min": "0",
    "valeur_max": "12.5",
    "laboratoire": false,
    "type_uid": "t1",
    "unite_uid": "u1",
    "themes": [
        {
            "uid": "t1"
        },
        {
            "uid": "t1"
        }
    ],
    "variables_calculees": [
        {
            "uid": "vc1"
        },
        {
            "uid": "vc1"
        }
    ]
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/variable',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'v2',
            'designation' => 'Poiuytreza',
            'valeur_min' => '0',
            'valeur_max' => '12.5',
            'laboratoire' => false,
            'type_uid' => 't1',
            'unite_uid' => 'u1',
            'themes' => [
                [
                    'uid' => 't1',
                ],
                [
                    'uid' => 't1',
                ],
            ],
            'variables_calculees' => [
                [
                    'uid' => 'vc1',
                ],
                [
                    'uid' => 'vc1',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (201):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "v2",
        "designation": "Poiuytreza",
        "valeur_min": "0",
        "valeur_max": "12.5",
        "laboratoire": false,
        "type": { ... },
        "unite": { ... },
        "themes": [ { ... } ],
        "variables_calculees": [ { ... } ]
    }
}

Request   

POST variable

Body Parameters

uid  string  
L'identifiant unique de la variable.

designation  string  
La designation de la variable.

valeur_min  numeric optional  
La valeur mininmale de la variable.

valeur_max  numeric optional  
La valeur maxinmale de la variable.

laboratoire  boolean  
La provenance laboratoire de la variable.

type_uid  string  
L'identifiant unique du type de la variable.

unite_uid  string optional  
L'identifiant unique du unite de la variable.

themes  object[] optional  
Les thèmes de la variable.

themes[].uid  string optional  
Un identifiant unique de thème existant.

variables_calculees  object[] optional  
Les variables calculées de la variable.

variables_calculees[].uid  string optional  
Un identifiant unique de variables calculées existant.

Référentiel - Variable - Modifier

requires authentication

Modifie une variable d'un référentiel

Example request:

curl -X PUT \
    "https://api.oss.coop/variable/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"uid":"v3","designation":"Nouvelle valeur","valeur_min":"null","valeur_max":"null","laboratoire":true,"type_uid":"t1","unite_uid":"null","themes":[{"uid":"t1"},{"uid":"t1"}],"variables_calculees":[{"uid":"vc1"},[]]}'

const url = new URL(
    "https://api.oss.coop/variable/2"
);

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

let body = {
    "uid": "v3",
    "designation": "Nouvelle valeur",
    "valeur_min": "null",
    "valeur_max": "null",
    "laboratoire": true,
    "type_uid": "t1",
    "unite_uid": "null",
    "themes": [
        {
            "uid": "t1"
        },
        {
            "uid": "t1"
        }
    ],
    "variables_calculees": [
        {
            "uid": "vc1"
        },
        []
    ]
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/variable/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'uid' => 'v3',
            'designation' => 'Nouvelle valeur',
            'valeur_min' => 'null',
            'valeur_max' => 'null',
            'laboratoire' => true,
            'type_uid' => 't1',
            'unite_uid' => 'null',
            'themes' => [
                [
                    'uid' => 't1',
                ],
                [
                    'uid' => 't1',
                ],
            ],
            'variables_calculees' => [
                [
                    'uid' => 'vc1',
                ],
                [],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "uid": "v3",
        "designation": "Nouvelle valeur",
        "valeur_min": null,
        "valeur_max": null,
        "laboratoire": true,
        "type": { ... },
        "unite": null,
        "themes": [],
        "variables_calculees": []
    }
}

Request   

PUT variable/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la variable.

Body Parameters

uid  string  
L'identifiant unique de la variable.

designation  string  
La designation de la variable.

valeur_min  numeric optional  
La valeur mininmale de la variable.

valeur_max  numeric optional  
La valeur maxinmale de la variable.

laboratoire  boolean  
La provenance laboratoire de la variable.

type_uid  string  
L'identifiant unique du type de la variable.

unite_uid  string optional  
L'identifiant unique du unite de la variable.

themes  object[] optional  
Les thèmes de la variable.

themes[].uid  string optional  
Un identifiant unique de thème existant.

variables_calculees  object[] optional  
Les variables calculées de la variable.

variables_calculees[].uid  string optional  
Un identifiant unique de variables calculées existant.

Référentiel - Variable - Supprimer

requires authentication

Supprime une variable d'un référentiel

Example request:

curl -X DELETE \
    "https://api.oss.coop/variable/11" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/variable/11"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/variable/11',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE variable/{uid:[0-9]+}

URL Parameters

uid  integer  
L'identifiant de la variable.

Valeur - Lister

requires authentication

Liste des valeurs d'une variable

Example request:

curl -X GET \
    -G "https://api.oss.coop/variable/1/valeur?sort=nom.ASC%2Cid.DESC&page=2&limit=17" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/variable/1/valeur"
);

let params = {
    "sort": "nom.ASC,id.DESC",
    "page": "2",
    "limit": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/variable/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'query' => [
            'sort'=> 'nom.ASC,id.DESC',
            'page'=> '2',
            'limit'=> '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": [
        {
            "id": 1,
            "designation": "Azertyuiop"
        }
    ]
}

Request   

GET variable/{vuid:[0-9]+}/valeur

URL Parameters

vuid  integer  
L'identifiant de la variable.

Query Parameters

sort  string optional  
Le champs d'ordonancement avec le sens d'ordonancement (optionel, défaut à ASC) et séparés par des virgules. Format champ[.ASC|.DESC][,autre[.ASC|.DESC]]. Defaut à 'id'.

page  integer optional  
Le numéro de page. Defaut à 1.

limit  integer optional  
Le nombre de résultats par page, pas de limite si à 0. Defaut à 12.

Valeur - Voir

requires authentication

Détails d'une valeur d'une variable

Example request:

curl -X GET \
    -G "https://api.oss.coop/variable/1/valeur/1" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/variable/1/valeur/1"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.oss.coop/variable/1/valeur/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 1,
        "designation": "Azertyuiop"
    }
}

Request   

GET variable/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

vuid  integer  
L'identifiant de la variable.

uid  integer  
L'identifiant de la valeur.

Valeur - Ajouter

requires authentication

Ajoute une valeur à une variable

Example request:

curl -X POST \
    "https://api.oss.coop/variable/1/valeur" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Poiuytreza"}'

const url = new URL(
    "https://api.oss.coop/variable/1/valeur"
);

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

let body = {
    "designation": "Poiuytreza"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.oss.coop/variable/1/valeur',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Poiuytreza',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (201):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Poiuytreza"
    }
}

Request   

POST variable/{vuid:[0-9]+}/valeur

URL Parameters

vuid  integer  
L'identifiant de la variable.

Body Parameters

designation  string  
La designation de la valeur.

Valeur - Modifier

requires authentication

Modifie une valeur d'une variable

Example request:

curl -X PUT \
    "https://api.oss.coop/variable/1/valeur/2" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{"designation":"Nouvelle valeur"}'

const url = new URL(
    "https://api.oss.coop/variable/1/valeur/2"
);

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

let body = {
    "designation": "Nouvelle valeur"
}

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.oss.coop/variable/1/valeur/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
        'json' => [
            'designation' => 'Nouvelle valeur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": {
        "id": 2,
        "designation": "Nouvelle valeur"
    }
}

Request   

PUT variable/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

vuid  integer  
L'identifiant de la variable.

uid  integer  
L'identifiant de la valeur.

Body Parameters

designation  string  
La designation de la valeur.

Valeur - Supprimer

requires authentication

Supprime une valeur d'une variable

Example request:

curl -X DELETE \
    "https://api.oss.coop/variable/1/valeur/10" \
    -H "Authorization: Bearer {ACCESS_TOKEN}"
const url = new URL(
    "https://api.oss.coop/variable/1/valeur/10"
);

let headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.oss.coop/variable/1/valeur/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "meta": { ... },
    "data": true
}

Request   

DELETE variable/{vuid:[0-9]+}/valeur/{uid:[0-9]+}

URL Parameters

vuid  integer  
L'identifiant de la variable.

uid  integer  
L'identifiant de la valeur.

bash javascript php