Documentation de l'API
Détails des requêtes de l'APIGET /api/v1/company/:id/events
Retourne la liste des manifestations de la compagnie spécifiée par le paramètre :id
.
URL
https://annuaire.cncej.org/api/v1/company/:id/events.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Non |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/events.json
Exemple de réponse
{ "company": { "id": 4, "title": "Compagnie Nationale des Experts Comptables de Justice", "events_count": 1, "events": [ { "event_id": 335, "event_type": 3, "event_type_text": "Colloque", "title": "L'expert-comptable de justice et les préjudices de concurrence", "date_start": "2021-10-14T09:30:00.000+02:00", "date_end": "2021-10-14T17:30:00.000+02:00", "speakers": "", "location": "", "comment": "congrès national CNECJ de Marseille", "file": "URL", "file2": "URL", "registrations": false } ] } }
GET /api/v1/company/:company_id/events/:id
Retourne les données de l'évènement spécifié par le paramètre :id
de la compagnie spécifiée par le paramètre :company_id
.
URL
https://annuaire.cncej.org/api/v1/company/:company_id/events/:id.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Non |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
company_id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 | |
id | integer | Requis | L'identifiant numérique de l'évènement désiré | 5 |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/events/5.json
Exemple de réponse
{ "id": 335, "event_type": 3, "event_type_text": "Colloque", "title": "L'expert-comptable de justice et les préjudices de concurrence", "date_start": "2021-10-14T09:30:00.000+02:00", "date_end": "2021-10-14T17:30:00.000+02:00", "speakers": "", "location": "", "hours": 8, "comment": "congrès national CNECJ de Marseille", "file": "URL", "file2": "URL", "registrations": false }
GET /api/v1/company/:company_id/year_receipts/:id
Redirige vers le reçu de cotisation (PDF) spécifié par le paramètre :id
et délivrée par la compagnie spécifiée par le paramètre :company_id
.
URL
https://annuaire.cncej.org/api/v1/company/:company_id/year_receipts/:id.pdf
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Oui |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
company_id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 | |
id | integer | Requis | L'identifiant numérique du reçu de cotisation désiré | 9 | |
token | string | Requis | Le jeton de session de l'utilisateur | 8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ== |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/year_receipts/9.pdf?token=8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ==
GET /api/v1/company/:id/year_receipts
Retourne les reçus de cotisation de l'utilisateur délivrées par la compagnie spécifiée par le paramètre :id
.
URL
https://annuaire.cncej.org/api/v1/company/:id/year_receipts.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Oui |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 | |
token | string | Requis | Le jeton de session de l'utilisateur | 8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ== |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/year_receipts.json?token=8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ==
Exemple de réponse
{ "company_id": 1, "company_title": "CNCEJ", "company_acronym": "CNCEJ", "member_id": 1234, "years": [ { "year_id": 10, "year": 2021, "amount": 135.0 }, { "year_id": 11, "year": 2022, "amount": 150.5 } ] }
GET /api/v1/company/:company_id/receipts/:id
Redirige vers le reçu (PDF) spécifié par le paramètre :id
et délivrée par la compagnie spécifiée par le paramètre :company_id
.
URL
https://annuaire.cncej.org/api/v1/company/:company_id/receipts/:id.pdf
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Oui |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
company_id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 | |
id | integer | Requis | L'identifiant numérique du reçu désiré | 9 | |
token | string | Requis | Le jeton de session de l'utilisateur | 8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ== |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/receipts/9.pdf?token=8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ==
GET /api/v1/company/:id/receipts
Retourne les reçus de l'utilisateur délivrées par la compagnie spécifiée par le paramètre :id
.
URL
https://annuaire.cncej.org/api/v1/company/:id/receipts.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Oui |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 | |
token | string | Requis | Le jeton de session de l'utilisateur | 8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ== |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/receipts.json?token=8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ==
Exemple de réponse
{ "company_id": 1, "company_title": "CNCEJ", "company_acronym": "CNCEJ", "member_id": 1234, "receipts": [ { "attendance_id": 9589, "event_id": 143, "event_type": 3, "event_type_text": "Colloque", "event_date": "2020-02-06T14:00:00.000+01:00", "event_title": "COLLOQUE EXPERTISE ET MEDIATION" }, { "attendance_id": 9590, "event_id": 144, "event_type": 3, "event_type_text": "Colloque", "event_date": "2020-02-06T14:00:00.000+01:00", "event_title": "COLLOQUE MEDIATION ET EXPERTISE" } ] }
GET /api/v1/company/:company_id/attendances/:id
Redirige vers l'attestation de présence (PDF) spécifiée par le paramètre :id
et délivrée par la compagnie spécifiée par le paramètre :company_id
.
URL
https://annuaire.cncej.org/api/v1/company/:company_id/attendances/:id.pdf
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Oui |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
company_id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 | |
id | integer | Requis | L'identifiant numérique de l'attestation de présence désirée | 9 | |
token | string | Requis | Le jeton de session de l'utilisateur | 8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ== |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/attendances/9.pdf?token=8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ==
GET /api/v1/company/:id/attendances
Retourne les attestations de présence de l'utilisateur délivrées par la compagnie spécifiée par le paramètre :id
.
URL
https://annuaire.cncej.org/api/v1/company/:id/attendances.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Oui |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 | |
token | string | Requis | Le jeton de session de l'utilisateur | 8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ== |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/attendances.json?token=8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ==
Exemple de réponse
{ "company_id": 1, "company_title": "CNCEJ", "company_acronym": "CNCEJ", "member_id": 1234, "attendances": [ { "attendance_id": 9589, "event_id": 143, "event_type": 3, "event_type_text": "Colloque", "event_date": "2020-02-06T14:00:00.000+01:00", "event_title": "COLLOQUE EXPERTISE ET MEDIATION" }, { "attendance_id": 9590, "event_id": 144, "event_type": 3, "event_type_text": "Colloque", "event_date": "2020-02-06T14:00:00.000+01:00", "event_title": "COLLOQUE MEDIATION ET EXPERTISE" } ] }
POST /api/v1/auth
Authentifie l'utilisateur et retourne un jeton de session.
URL
https://annuaire.cncej.org/api/v1/auth.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Non |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
user_email | string | Requis | L'adresse email de l'utilisateur | ne-pas-repondre@cncej.org | |
user_password | string | Requis | Le mot de passe de l'utilisateur | MotDePasse |
Exemple de requête
POST https://annuaire.cncej.org/api/v1/auth.json?user_email=ne-pas-repondre@cncej.org&user_password=MotDePasse
Exemple de réponse
{ "user_id": 1234, "member_id": 5678, "token": "8n1tZN/d5EogIfIpGTIFAX6nzWNM2h/1j3l3c7HYOD--Z1NAlPo92FbK9tkb--hUjKo9y6f5th7huUUh7UsmAxQ==", "full_name": "Jean DUPONT", "email": "ne-pas-repondre@cncej.org", "is_cncej_member": true, "is_another_president": false, "is_ucecaap_member": true, "is_ucecaap_president": false, "is_ucecap_member": false, "is_ucecap_president": false, "is_cnecj_member": false, "is_cnecj_president": false, "tab_ids": [ 8765, 7267 ], "company_ids": [ 9, 10 ], "is_president": false, "is_chamber": false, "is_directorate": false, "is_admin": false }
GET /api/v1/company/:id/members
Retourne une liste de 20 membres appartenants à la compagnie spécifiée par le paramètre :id
.
URL
https://annuaire.cncej.org/api/v1/company/:id/members.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Non |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
id | integer | Requis | L'identifiant numérique de la compagnie désirée | 79 | |
page | integer | Optionnel | Le numéro de la page désirée. 20 résultats sont retournés par page | 1 | 2 |
search | string | Optionnel | Le ou les mots clés permettant de filtrer la requête | DUPONT |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/79/members.json?page=2&search=DUPONT
Exemple de réponse
{ "company": { "id": 79, "title": "Association des médecins experts près la Cour d'appel d'Aix-en-Provence", "members_count": 2, "members": [ { "id": 4, "civility": "M.", "last_name": "DUPONT", "first_name": "Jacques", "email": "jacques.dupont@annuaire-cncej.org", "picture": "/assets/blank-id-picture-6e3d5bc7657fdf664a0cca41b7738c184d1240434388e050eaeff7847dcc0b81.png", "tab_type": "Expert", "address1": "8, rue Pierre Motte", "address2": null, "address3": null, "postal_code": "97180", "city": "SAINTE-ANNE", "tel1": "1234567890", "tel2": "1234567890", "mobile": "1234567890", "fax": "1234567890", "categories": [ { "id": 12748, "code": "A.10.01", "title": "Équipements et procédés" }, { "id": 12812, "code": "B.05", "title": "PROPRIÉTÉ ARTISTIQUE" }, { "id": 12927, "code": "E.03.01", "title": "Air" }, { "id": 13007, "code": "F.01.27", "title": "Rhumatologie" } ], "tribunal": null, "status": "Actif", "year_inscription": 2009, "year_reinscription": 2012, "adm_categories": [ ], "adm_tribunal": null, "adm_status": null, "adm_year_inscription": null, "adm_year_reinscription": null, "cassation_categories": [ ], "cassation_status": null, "cassation_year_inscription": null, "cassation_year_reinscription": null, "national_categories": [ ] }, { "id": 5, "civility": "Mme", "last_name": "DURAND", "first_name": "Alice", "email": "alice.durand@annuaire-cncej.org", "picture": "/assets/blank-id-picture-6e3d5bc7657fdf664a0cca41b7738c184d1240434388e050eaeff7847dcc0b81.png", "tab_type": "Expert", "address1": "25, Place Charles de Gaulle", "address2": null, "address3": null, "postal_code": "33140", "city": "VILLENAVE-D'ORNON", "tel1": "1234567890", "tel2": "1234567890", "mobile": "1234567890", "fax": "1234567890", "categories": [ { "id": 12734, "code": "A.06.02", "title": "Produits des biotechnologies" }, { "id": 12765, "code": "A.13.01", "title": "Estimation et gestion" } ], "tribunal": null, "status": "Actif", "year_inscription": 1976, "year_reinscription": 2014, "adm_categories": [ ], "adm_tribunal": null, "adm_status": null, "adm_year_inscription": null, "adm_year_reinscription": null, "cassation_categories": [ ], "cassation_status": null, "cassation_year_inscription": null, "cassation_year_reinscription": null, "national_categories": [ ] } ] } }
GET /api/v1/member/:id
Retourne les données de la fiche du membre spécifié par le paramètre :id
.
URL
https://annuaire.cncej.org/api/v1/member/:id.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Non |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
id | integer | Requis | L'identifiant numérique du membre désiré | 4 |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/member/4.json
Exemple de réponse
{ "id": 4, "civility": "M.", "last_name": "DUPONT", "id_name": "DUPONT", "first_name": "Jacques", "email": "jacques.dupont@annuaire-cncej.com", "birthdate": 1970, "picture": "/assets/blank-id-picture-6e3d5bc7657fdf664a0cca41b7738c184d1240434388e050eaeff7847dcc0b81.png", "linkedin": "", "viadeo": "", "skype": "", "twitter": "", "tabs": [ { "company_id": 78, "company_title": "Compagnie nationale des experts judiciaires en estimations immobilières, loyers et fonds de commerce", "tab_type": "Expert", "address1": "45, boulevard Aristide Briand", "address2": "", "address3": "", "postal_code": "71200", "city": "LE CREUSOT", "email": "jacques.dupont@annuaire-cncej.org", "tel1": "987654321", "tel2": "987654321", "mobile": "987654321", "fax": "987654321", "categories": [ ], "tribunal": null, "status": null, "year_inscription": null, "year_reinscription": null, "adm_categories": [ { "id": 15373, "code": "A.08.06", "title": "Pépinières" }, { "id": 15386, "code": "A.12", "title": "SYLVICULTURE" }, { "id": 15387, "code": "A.12.01", "title": "Estimation et gestion" } ], "adm_tribunal": null, "adm_status": "Actif", "adm_year_inscription": 1974, "adm_year_reinscription": 2013, "cassation_categories": [ ], "cassation_status": null, "cassation_year_inscription": null, "cassation_year_reinscription": null, "national_categories": [ ], "sectors": "Secteurs d'activité", "actual_situation": "Situation actuelle", "language": "Langues", "decorations": "Décorations", "specialities": "Spécialités fines\r\n", "profession": "Profession\r\n", "other_activities": "Autres activités", "degrees": "Diplômes" }, { "company_id": 79, "company_title": "Association des médecins experts près la Cour d'appel d'Aix-en-Provence", "tab_type": "Expert", "address1": "8, rue Pierre Motte", "address2": "", "address3": "", "postal_code": "97180", "city": "SAINTE-ANNE", "email": "jacques.dupont@annuaire-cncej.org", "tel1": "1234567890", "tel2": "1234567890", "mobile": "1234567890", "fax": "1234567890", "categories": [ { "id": 12748, "code": "A.10.01", "title": "Équipements et procédés" }, { "id": 12812, "code": "B.05", "title": "PROPRIÉTÉ ARTISTIQUE" }, { "id": 12927, "code": "E.03.01", "title": "Air" }, { "id": 13007, "code": "F.01.27", "title": "Rhumatologie" } ], "tribunal": null, "status": "Actif", "year_inscription": 2009, "year_reinscription": 2012, "adm_categories": [ ], "adm_tribunal": null, "adm_status": null, "adm_year_inscription": null, "adm_year_reinscription": null, "cassation_categories": [ ], "cassation_status": null, "cassation_year_inscription": null, "cassation_year_reinscription": null, "national_categories": [ ], "sectors": "Secteurs d'activité", "actual_situation": "Situation actuelle", "language": "Langues", "decorations": "Décorations", "specialities": "Spécialités fines\r\n", "profession": "Profession\r\n", "other_activities": "Autres activités", "degrees": "Diplômes" } ] }
GET /api/v1/company/:id/functions
Retourne le conseil d'administration de la compagnie spécifiée par le paramètre :id
.
URL
https://annuaire.cncej.org/api/v1/company/:id/functions.json
Informations
Format de la réponse | JSON |
Nécessite authentification ? | Non |
Paramètres
Nom | Type | Requis | Description | Valeur par défault | Exemple |
---|---|---|---|---|---|
id | integer | Requis | L'identifiant numérique de la compagnie désirée | 4 |
Exemple de requête
GET https://annuaire.cncej.org/api/v1/company/4/functions.json
Exemple de réponse
{ "company": { "id": 79, "title": "Association des médecins experts près la Cour d'appel d'Aix-en-Provence", "functions": [ { "member_id": 4, "member": "Jacques DUPONT", "function": "Président" }, { "member_id": 5, "member": "Alice DURAND", "function": "Vice-Président" } ] } }