AZKO-CMS API

Informations générales

API	AZKO-CMS API
Version	1.0
Auteur	AZKO.FR (Benj F.)
URL	https://api.azko.fr
API authentication	basic	Toutes les requêtes doivent comporter les identifiants d'API qui vous ont été communiqués par nos services : [YOUR_API_KEY] + [YOUR_API_SECRET] envoyés dans un header Authorization:Basic (legacy) ou AppId pour l'authentification via SSO SEPTEO Exemples (via SSO SEPTEO) : HTTP > AppId: [base64([YOUR_API_KEY]:[YOUR_API_SECRET])] PHP > curl_setopt($ch, CURLOPT_HTTPHEADER, array( 'AppId: ' . base64_encode('[YOUR_API_KEY]:[YOUR_API_SECRET]') )); CURL > curl --request POST --url https://api.azko.fr/... --header 'AppId: [base64([YOUR_API_KEY]:[YOUR_API_SECRET])]' --header 'content-type: application/json' --data '{"...":"..."}' Exemples (legacy) : HTTP > Authorization:Basic [base64([YOUR_API_KEY]:[YOUR_API_SECRET])] PHP > curl_setopt($ch, CURLOPT_USERPWD, "[YOUR_API_KEY]:[YOUR_API_SECRET]") CURL > curl --request POST --url https://api.azko.fr/... --header 'Authorization:Basic [base64([YOUR_API_KEY]:[YOUR_API_SECRET])]' --header 'content-type: application/json' --data '{"...":"..."}'
USER authentication	string	Toutes les requêtes (sauf /errors et /auth) doivent également comporter un "USER-TOKEN" ou un "JSON WEB TOKEN". Pour obtenir ce TOKEN ou ce JWT, 3 méthodes au choix : JWT SSO SEPTEO: Depuis le SSO "login.septeo.fr". Envoyer ensuite ce JWT dans un header "Authorization: Bearer [...]". Exemple : HEADER : Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.[...] TOKEN (Legacy) : Depuis le endpoint "/auth" (ou communiqué par nos services). Envoyer ensuite ce TOKEN en paramètre ou en contenu de la requête. Exemples : URL : ?token=... JSON : {"token":"..."} JWT MySepteo (Legacy) : Depuis le endpoint "/auth/mySepteo". Envoyer ensuite ce JWT dans un header "Application-Authorization: Bearer [...]". Exemple : HEADER : Application-Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.[...]
Retour si succès	json	{ "output": { "success": 1, "response": "..." } }
Retour si erreur	json	{ "output": { "success": 0, "error": { "num": "...", "msg": " ... " } } }

Détail des webservices

Endpoints : Tout déplier / replier
Détails : Tout déplier / replier

/errors (1)

GET /errors

/errors GET

Liste des erreurs pouvant être retournées par l'API
Détails

Api-Return	json	{ "output": { "success": 1, "response": [ { "error": "...", "msg": "..." }, { "...": "..." } ] } }
Return (response)	array	Liste d'erreurs

/auth (6)

POST /auth

POST /auth/mySepteo

POST /auth/checkToken

POST /auth/passPerdu

POST /auth/requestAccount

POST /auth/logOff

/auth POST

Authentification de l'utilisateur via login/pass (complémentaire avec l'API Authentication)
Retourne le TOKEN nécessaire pour les autres requêtes
Détails

Request body	json	login + pass
Example	json	{ "login": "...", "pass": "..." }
Api-Return	json	{ "output": { "success": 1, "response": "b50c585806c731555255e36..." } }
Return (response)	string	Token de connexion à utiliser pour les requêtes suivantes (validité permanente, sauf réinitialisation)

/auth/mySepteo POST

Authentification de l'utilisateur via login/pass (complémentaire avec l'API Authentication)
Retourne un JSON WEB TOKEN nécessaire pour les autres requêtes
Détails

Request body	json	login + pass
Example	json	{ "login": "...", "pass": "..." }
Api-Return	json	{ "output": { "success": 1, "response": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2M..." } }
Return (response)	string	JWT de connexion à utiliser pour les requêtes suivantes (validité permanente, sauf réinitialisation)

/auth/checkToken POST

Vérifie si le token est valide
Détails

Param	string	token
Api-Return	json	{ "output": { "success": 1, "response": true } }
Return (response)	bool	True si le token existe et est valide

/auth/passPerdu POST

Envoi un mail de confirmation de réinitialisation de mot de passe à l'utilisateur
Détails

Param	string	login
Api-Return	json	{ "output": { "success": 1, "response": true } }
Return (response)	bool	True si le compte existe et que la demande a bien été envoyée

/auth/requestAccount POST

Envoi un mail de demande d'identifiants aux services AZKO
TODO Méthode en cours de développement !
Détails

Param	string	login
Api-Return	json	{ "output": { "success": 1, "response": true } }
Return (response)	bool	True si la demande a bien été envoyée aux services AZKO

/auth/logOff POST

Déconnexion = supprime le token
Détails

Api-Return	json	{ "output": { "success": 1, "response": true } }
Return (response)	bool	True si le token a bien été supprimé

/users (3)

GET /users[/:id][/:id]...

GET /users/current

POST /users/:id

/users[/:id][/:id]... GET

Retourne un ou des user(s)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

User_DB[]

Liste d'utilisateurs

User_DB

Propriété	Type	Type SQL / Infos
user_id	int	int(11)
user_nom	string	varchar(255)
user_prenom	string	varchar(255)
user_mail	string	varchar(255)
user_login	string	varchar(255)
user_pass	string	varchar(255)
user_token	string	varchar(255) - token pour le lien sécurisé de validation d'adresse e-mail
user_fonction_id	int	int(11) - ID de fonction pour MySepteo
user_org_id	int	int(11)
user_mysepteo_contact_id	string	varchar(255)
user_statut_id	int	int(11)
user_statut_activation	int	int(11) - 0 = deleted, 1 = ok, 2 = attend confirmation mail
user_actif	int	int(11) - bool
user_crea_date	string	datetime
user_crea_user_id	int	int(11)
user_crea_ip	string	varchar(15)
user_modif_date	string	datetime
user_modif_user_id	int	int(11)
user_modif_ip	string	varchar(15)
user_lastconnect_date	string	datetime
user_lastconnect_ip	string	varchar(15)
user_lastaction_date	string	datetime
user_lastaction_ip	string	varchar(15)
user_forcelogout	int	int(1) - bool
user_azkopilot_multi_device	int	int(1) - bool

/users/current GET

Retourne l'utilisateur courant
Détails

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

User_DB[]

Liste d'utilisateurs

User_DB

Propriété	Type	Type SQL / Infos
user_id	int	int(11)
user_nom	string	varchar(255)
user_prenom	string	varchar(255)
user_mail	string	varchar(255)
user_login	string	varchar(255)
user_pass	string	varchar(255)
user_token	string	varchar(255) - token pour le lien sécurisé de validation d'adresse e-mail
user_fonction_id	int	int(11) - ID de fonction pour MySepteo
user_org_id	int	int(11)
user_mysepteo_contact_id	string	varchar(255)
user_statut_id	int	int(11)
user_statut_activation	int	int(11) - 0 = deleted, 1 = ok, 2 = attend confirmation mail
user_actif	int	int(11) - bool
user_crea_date	string	datetime
user_crea_user_id	int	int(11)
user_crea_ip	string	varchar(15)
user_modif_date	string	datetime
user_modif_user_id	int	int(11)
user_modif_ip	string	varchar(15)
user_lastconnect_date	string	datetime
user_lastconnect_ip	string	varchar(15)
user_lastaction_date	string	datetime
user_lastaction_ip	string	varchar(15)
user_forcelogout	int	int(1) - bool
user_azkopilot_multi_device	int	int(1) - bool

/users/:id POST

Modification user (ne modifie que Nom, Prénom, et Mot de passe (optionnel))
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

{
    "user_id": 1,
    "user_nom": "DUPONT",
    "user_prenom": "Paul",
    "user_mdp": "[ANCIEN MOT DE PASSE]",
    "user_newmdp": "[NOUVEAU MOT DE PASSE]",
    "user_confirmmdp": "[NOUVEAU MOT DE PASSE]"
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

User_DB

utilisateur

User_DB

Propriété	Type	Type SQL / Infos
user_id	int	int(11)
user_nom	string	varchar(255)
user_prenom	string	varchar(255)
user_mail	string	varchar(255)
user_login	string	varchar(255)
user_pass	string	varchar(255)
user_token	string	varchar(255) - token pour le lien sécurisé de validation d'adresse e-mail
user_fonction_id	int	int(11) - ID de fonction pour MySepteo
user_org_id	int	int(11)
user_mysepteo_contact_id	string	varchar(255)
user_statut_id	int	int(11)
user_statut_activation	int	int(11) - 0 = deleted, 1 = ok, 2 = attend confirmation mail
user_actif	int	int(11) - bool
user_crea_date	string	datetime
user_crea_user_id	int	int(11)
user_crea_ip	string	varchar(15)
user_modif_date	string	datetime
user_modif_user_id	int	int(11)
user_modif_ip	string	varchar(15)
user_lastconnect_date	string	datetime
user_lastconnect_ip	string	varchar(15)
user_lastaction_date	string	datetime
user_lastaction_ip	string	varchar(15)
user_forcelogout	int	int(1) - bool
user_azkopilot_multi_device	int	int(1) - bool

/organisations (4)

GET /organisations[/:id][/:id]...

GET /organisations/current

GET /organisations/search

PUT /organisations/:id

/organisations[/:id][/:id]... GET

Retourne une ou des organisation(s)
Détails

Api-Return	json	{ "output": { "success": 1, "response": [ { "...": "..." } ] } }

/organisations/current GET

Retourne l'organisation courante
Détails

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

Organisation_DB[]

Liste d'organisations

Organisation_DB

Propriété	Type	Type SQL / Infos
org_id	int	int(11)
org_nom	string	varchar(255)
org_date_resiliation	string\|null	datetime
org_maintenance_souscrite	int	int(1) bool
org_siret	string	varchar(255)
org_tva_intra	string	varchar(255)
org_crpcen	string	varchar(10)
org_mysepteo_dossier_id	string	varchar(255)
org_mysepteo_groupe_id	string	varchar(255)
org_immo_notaires_last_update	string\|null	datetime
org_immo_notaires_mode	int	int(1)
org_noty_last_update	string\|null	datetime
org_noty_last_page	int	int(1)
org_noty_mode	int	int(1)
org_unca_barreau_id	int	int(11)
org_immonot_last_update	string\|null	datetime
org_article_motif_refus_crons_last_update	string\|null	datetime
org_article_pj_archived_crons_last_update	string\|null	datetime
org_type_id	int	int(11)
org_pays_id	int	int(11)
org_adresse_1	string	varchar(255)
org_adresse_2	string	varchar(255)
org_cp	string	varchar(45)
org_ville	string	varchar(255)
org_lat	string	varchar(255)
org_lng	string	varchar(255)
org_barreau	string	varchar(255)
org_tel	string	varchar(45)
org_fax	string	varchar(45)
org_db_pass	string	varchar(255)
org_modules_ids	string	varchar(255) - IDs de modules séparés par des virgules
org_repleg_mail	string	varchar(255)
org_repleg_nom	string	varchar(255)
org_repleg_prenom	string	varchar(255)
org_repleg_mobile	string	varchar(255)
org_referent_nom	string	varchar(255)
org_referent_prenom	string	varchar(255)
org_referent_mail	string	varchar(255)
org_referent_mobile	string	varchar(255)
org_curation_validation	!	Utiliser les paramètres de SITES !
org_curation_mail	!	Utiliser les paramètres de SITES !
org_syspay_mode	int	int(1) - 0 = SANDBOX, 1 = LIVE
org_syspay_id	int	int(11) - 0 par défaut
org_syspay_user	string	text JSON - '' par défaut
org_syspay_onboarding_url	string	varchar(255) - '' par défaut
org_syspay_login	string	varchar(255) - '' par défaut
org_syspay_passphrase	string	varchar(255) - '' par défaut
org_clickup_prod_list_id	string	varchar(255)
org_clickup_smo_list_id	string	varchar(255)
org_commentaires	string	TEXT - JSON
org_cache	string	TEXT - JSON
org_crea_token	string	varchar(255)
org_crea_status	int	int(11) - BITFIELD
org_type_infra	int	int(11)
org_unca_csr_req	string	TEXT
org_unca_private_key	string	TEXT
org_unca_crt	string	TEXT
org_unca_crt_and_key	string	TEXT
org_unca_date_fin_v	string\|null	datetime
org_crea_date	string	datetime
org_crea_user_id	int	int(11)
org_modif_date	string	datetime
org_modif_user_id	int	int(11)
_produits_infos

/organisations/search GET

Retourne une organisation en se basant sur son nom strict ou id groupe MySepteo
Détails

Param

string

type Type de la recherche (org_nom,org_mysepteo_dossier_id ou org_mysepteo_groupe_id).

Param

string

search Valeur recherchée.

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

Organisation_DB[]

Organisation_DB

Propriété	Type	Type SQL / Infos
org_id	int	int(11)
org_nom	string	varchar(255)
org_date_resiliation	string\|null	datetime
org_maintenance_souscrite	int	int(1) bool
org_siret	string	varchar(255)
org_tva_intra	string	varchar(255)
org_crpcen	string	varchar(10)
org_mysepteo_dossier_id	string	varchar(255)
org_mysepteo_groupe_id	string	varchar(255)
org_immo_notaires_last_update	string\|null	datetime
org_immo_notaires_mode	int	int(1)
org_noty_last_update	string\|null	datetime
org_noty_last_page	int	int(1)
org_noty_mode	int	int(1)
org_unca_barreau_id	int	int(11)
org_immonot_last_update	string\|null	datetime
org_article_motif_refus_crons_last_update	string\|null	datetime
org_article_pj_archived_crons_last_update	string\|null	datetime
org_type_id	int	int(11)
org_pays_id	int	int(11)
org_adresse_1	string	varchar(255)
org_adresse_2	string	varchar(255)
org_cp	string	varchar(45)
org_ville	string	varchar(255)
org_lat	string	varchar(255)
org_lng	string	varchar(255)
org_barreau	string	varchar(255)
org_tel	string	varchar(45)
org_fax	string	varchar(45)
org_db_pass	string	varchar(255)
org_modules_ids	string	varchar(255) - IDs de modules séparés par des virgules
org_repleg_mail	string	varchar(255)
org_repleg_nom	string	varchar(255)
org_repleg_prenom	string	varchar(255)
org_repleg_mobile	string	varchar(255)
org_referent_nom	string	varchar(255)
org_referent_prenom	string	varchar(255)
org_referent_mail	string	varchar(255)
org_referent_mobile	string	varchar(255)
org_curation_validation	!	Utiliser les paramètres de SITES !
org_curation_mail	!	Utiliser les paramètres de SITES !
org_syspay_mode	int	int(1) - 0 = SANDBOX, 1 = LIVE
org_syspay_id	int	int(11) - 0 par défaut
org_syspay_user	string	text JSON - '' par défaut
org_syspay_onboarding_url	string	varchar(255) - '' par défaut
org_syspay_login	string	varchar(255) - '' par défaut
org_syspay_passphrase	string	varchar(255) - '' par défaut
org_clickup_prod_list_id	string	varchar(255)
org_clickup_smo_list_id	string	varchar(255)
org_commentaires	string	TEXT - JSON
org_cache	string	TEXT - JSON
org_crea_token	string	varchar(255)
org_crea_status	int	int(11) - BITFIELD
org_type_infra	int	int(11)
org_unca_csr_req	string	TEXT
org_unca_private_key	string	TEXT
org_unca_crt	string	TEXT
org_unca_crt_and_key	string	TEXT
org_unca_date_fin_v	string\|null	datetime
org_crea_date	string	datetime
org_crea_user_id	int	int(11)
org_modif_date	string	datetime
org_modif_user_id	int	int(11)
_produits_infos

/organisations/:id PUT

Modification organisation
Détails

Param

json

{
    "org_id": 1,
    "org_nom": "AZKO",
    "...": "..."
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

Organisation_DB

Organisation

Organisation_DB

Propriété	Type	Type SQL / Infos
org_id	int	int(11)
org_nom	string	varchar(255)
org_date_resiliation	string\|null	datetime
org_maintenance_souscrite	int	int(1) bool
org_siret	string	varchar(255)
org_tva_intra	string	varchar(255)
org_crpcen	string	varchar(10)
org_mysepteo_dossier_id	string	varchar(255)
org_mysepteo_groupe_id	string	varchar(255)
org_immo_notaires_last_update	string\|null	datetime
org_immo_notaires_mode	int	int(1)
org_noty_last_update	string\|null	datetime
org_noty_last_page	int	int(1)
org_noty_mode	int	int(1)
org_unca_barreau_id	int	int(11)
org_immonot_last_update	string\|null	datetime
org_article_motif_refus_crons_last_update	string\|null	datetime
org_article_pj_archived_crons_last_update	string\|null	datetime
org_type_id	int	int(11)
org_pays_id	int	int(11)
org_adresse_1	string	varchar(255)
org_adresse_2	string	varchar(255)
org_cp	string	varchar(45)
org_ville	string	varchar(255)
org_lat	string	varchar(255)
org_lng	string	varchar(255)
org_barreau	string	varchar(255)
org_tel	string	varchar(45)
org_fax	string	varchar(45)
org_db_pass	string	varchar(255)
org_modules_ids	string	varchar(255) - IDs de modules séparés par des virgules
org_repleg_mail	string	varchar(255)
org_repleg_nom	string	varchar(255)
org_repleg_prenom	string	varchar(255)
org_repleg_mobile	string	varchar(255)
org_referent_nom	string	varchar(255)
org_referent_prenom	string	varchar(255)
org_referent_mail	string	varchar(255)
org_referent_mobile	string	varchar(255)
org_curation_validation	!	Utiliser les paramètres de SITES !
org_curation_mail	!	Utiliser les paramètres de SITES !
org_syspay_mode	int	int(1) - 0 = SANDBOX, 1 = LIVE
org_syspay_id	int	int(11) - 0 par défaut
org_syspay_user	string	text JSON - '' par défaut
org_syspay_onboarding_url	string	varchar(255) - '' par défaut
org_syspay_login	string	varchar(255) - '' par défaut
org_syspay_passphrase	string	varchar(255) - '' par défaut
org_clickup_prod_list_id	string	varchar(255)
org_clickup_smo_list_id	string	varchar(255)
org_commentaires	string	TEXT - JSON
org_cache	string	TEXT - JSON
org_crea_token	string	varchar(255)
org_crea_status	int	int(11) - BITFIELD
org_type_infra	int	int(11)
org_unca_csr_req	string	TEXT
org_unca_private_key	string	TEXT
org_unca_crt	string	TEXT
org_unca_crt_and_key	string	TEXT
org_unca_date_fin_v	string\|null	datetime
org_crea_date	string	datetime
org_crea_user_id	int	int(11)
org_modif_date	string	datetime
org_modif_user_id	int	int(11)
_produits_infos

/sites (4)

GET /sites[/:id][/:id]...

GET /sites/facebookAccounts

GET /sites/twitterAccounts

GET /sites/domainNames

/sites[/:id][/:id]... GET

Retourne un ou des site(s)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

Site_DB[]

Liste de sites

Site_DB

Propriété	Type	Type SQL / Infos
site_id	int	int(11)
site_type_id	int	int(11)
site_private	int	int(1) bool - uniquement pour les BLOGS
site_private_ep_ids	string	varchar(255)
site_private_public_length	int	int(11)
site_nom	string	varchar(255)
site_baseline	string	varchar(255)
site_desc	string	varchar(255)
site_script	string	text
site_cssfilename	string	varchar(255)
site_maquette	int	int(1) bool - indique si le site est un site maquette ou pas
site_sysmail_sendername	string	varchar(255)
site_sysmail_sendermail	string	varchar(255)
site_sysmail_subject	string	varchar(255)
site_sysmail_title_color	string	varchar(255)
site_sysmail_logo	string	varchar(45) - nom de fichier image (pour en-tête de mail)
site_default_destmail	string	varchar(255)
site_default_blackliste_mail	string	varchar(255)
site_skin_id	int	int(11)
site_class_body	string	varchar(255)
site_org_id	int	int(11)
site_gplusauthor	string	varchar(255)
site_gpluspublisher	string	varchar(255)
site_facebook_url	string	varchar(255)
site_linkedin_url	string	varchar(255)
site_youtube_url	string	varchar(255)
site_instagram_url	string	varchar(255)
site_meetlaw_url	string	varchar(255)
site_googletagmanager_id	string	varchar(45)
site_code_analytics	string	varchar(45)
site_code_ga4	string	varchar(45)
site_code_webmastertools	string	varchar(45)
site_code_bingvalidate	string	varchar(45) ex : 7B1A9CEF6875C10141F0349B037CE025
site_adwordsaccount_id	string	varchar(255) ex : 969717267
site_piwik_id	int	int(11)
site_fbpixel_id	string	varchar(255)
site_linkedin_id	string	varchar(255)
site_plezi_id	string	varchar(255)
site_twitter_user	string	varchar(255)
site_nbtweets_footer	int	int(11)
site_lgs	string	varchar(255) fr
site_main_lg	string	varchar(2) fr
site_favicon	string	varchar(45) - nom de fichier image (pour favicon)
site_ogimage	string	varchar(45) - nom de fichier image (pour open graph)
site_default_artimage	string	varchar(45) - nom de fichier image (pour les articles sans images)
site_logo	string	varchar(45) - nom de fichier image (pour le logo du site)
site_logo_alt	string	varchar(255) - alt de l'image (pour le logo du site)
site_logo_title	string	varchar(255) - title de l'image (pour le logo du site)
site_meta_title	string	varchar(255) - par défaut
site_meta_desc	string	varchar(255) - par défaut
site_meta_keywords	string	varchar(255) - par défaut
site_curation_validation	int	int(1) - bool (est-ce que le client souhaite valider les articles issus de la curation)
site_curation_validation_cats	string	text - json, liste des id de catégories soumises à validation
site_curation_mails	string	text - destinataires des mails de validation, séparés par des virgules
site_curation_types_articles	int	bitfield - flags indiquant les types d'articles acceptés pour la curation (voir liste des types dans BlogArticle_DB)
site_params	string	text (JSON)
site_crea_date	string	datetime
site_crea_user_id	int	int(11)
site_modif_date	string	datetime
site_modif_user_id	int	int(11)
site_lg	string	varchar(2) fr (indique la langue actuellement sélectionnée)
site_actif	int	int(1) bool
site_robots_index	int	int(1) bool
site_robots_follow	int	int(1) bool
site_btn_switchlg	int	int(1) bool - Affiche le bouton de langue ?
site_robots_indexdate	string	datetime date de mise en INDEX
site_bootstrap_version_id	int	int(11)
site_menu_type_id	int	int(11)
site_atelier_type_id	int	int(11)
site_annuaire_type_id	int	int(11)
site_actualite_type_id	int	int(11)
site_annonceimmo_type_id	int	int(11)
site_default_configs	string	text (JSON)
_cats	array	BlogCategorie_DB

/sites/facebookAccounts GET

Retourne les comptes facebook associés aux sites
Détails

/sites/twitterAccounts GET

Retourne les comptes twitter associés aux sites de l'ORGANISATION COURANTE
Détails

/sites/domainNames GET

Retourne les noms de domaine associés aux sites de l'ORGANISATION COURANTE
Détails

/blogcategories (1)

GET /blogcategories[/:id][/:id]...

/blogcategories[/:id][/:id]... GET

Retourne une ou des catégorie(s) de blog
Détails

Param

int

orgid (default = 0)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

BlogCategorie_DB[]

Liste de catégories

BlogCategorie_DB

Propriété	Type	Type SQL / Infos
cat_id	int	int(11) unsigned
cat_nom	string	varchar(255)
cat_groupe_id	int\|null	int(11) unsigned NULL
cat_parent_id	int	int(11) unsigned
cat_curation	int	int(1) unsigned, bool
cat_petite_annonce_type
cat_actif	int	int(1) unsigned, bool
oGroupe	BlogGroupe_DB\|null

/blogit (6)

POST /blogit/getFormLogin

POST /blogit/getForm

POST /blogit/searchImages

POST /blogit/presend

POST /blogit/send

POST /blogit/sendToQueue

/blogit/getFormLogin POST

Retourne le formulaire d'identitfication de BLOG'IT
Détails

Api-Return	json	{ "output": { "success": 1, "response": "..." } }
Return (response)	string	HTML (le formulaire)

/blogit/getForm POST

Retourne le formulaire d'envoi d'article de BLOG'IT
Détails

Param	string	selectedDescription
Param	string	title
Param	string	url
Param	string	baseUrl
Param	string	contentType ("text/html")
Param	string	plaintext
Param	string	locale
Param	string	website
Param	object	metadata - Ex: {"description", "keywords", "author", "content-type", "og:image", "..."}
Param	string	author
Param	string	description
Param	object[]	imgs - Ex: [{"url": (string), "type": "article", "width": (int), "height": (int), "naturalwidth": (int), "naturalheight": (int), "description": (string)}, ...]
Api-Return	json	{ "output": { "success": 1, "response": "..." } }
Return (response)	string	HTML (le formulaire)

/blogit/searchImages POST

Retourne la liste d'images recherchées dans la librairie BLOG'IT
Détails

Api-Return	json	{ "output": { "success": 1, "response": "..." } }
Return (response)	string	HTML (la liste d'images)

/blogit/presend POST

Simule l'envoi d'un article via le formulaire de BLOG'IT
Détails

Param	multipart	Objet JS FormData() = (formulaire avec envoi de fichier(s))
Api-Return	json	{ "output": { "success": 1, "response": "..." } }
Return (response)	string	HTML (tableau récap de ce qui a été envoyé/enregistré)

/blogit/send POST

Envoi un article via le formulaire de BLOG'IT
Détails

Param	multipart	Objet JS FormData() = (formulaire avec envoi de fichier(s))
Api-Return	json	{ "output": { "success": 1, "response": "..." } }
Return (response)	string	HTML (tableau récap de ce qui a été envoyé/enregistré)

/blogit/sendToQueue POST

Envoi un article en file d'attente via le formulaire de BLOG'IT
Détails

Param	multipart	Objet JS FormData() = (formulaire avec envoi de fichier(s))
Api-Return	json	{ "output": { "success": 1, "response": "..." } }
Return (response)	string	HTML (tableau récap de ce qui a été envoyé/enregistré)

/articles (3)

GET /articles[/:id][/:id]...

GET /articles/publicationsResume

POST /articles[/:id]

/articles[/:id][/:id]... GET

Retourne un ou des article(s)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

int

siteid (default = 0)

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Param

bool

onlyactifs (default = true)

Param

bool

onlypublished (default = true)

Param

bool

onlywaitingvalidation (default = false) - si passé à true, onlyactifs, onlypublished et onlyrefusvalidation sont forcés à false

Param

bool

onlycuration (default = false) - Permet de ne récupérer que les articles de curation

Param

bool

onlyrefusvalidation (default = false) - si passé à true, onlyactifs et onlypublished sont forcés à false. onlywaitingvalidation doit être à false pour que la valeur true de onlyrefusvalidation soit prise en compte

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

BlogArticle_DB[]|object

Liste d'articles, ou résumé

BlogArticle_DB

Propriété	Type	Type SQL / Infos
art_id	int	int(11) unsigned
art_token	string	varchar(255) - Pour sécuriser le lien de validation de l'article
art_preview_token	string	varchar(255)
art_preview_token_date	string	datetime
art_titre	string	varchar(255)
art_texte	string	text
art_temps_lecture	int	int(11) unsigned 0 -> temps de lecture en minutes
art_url_perso	string	text
art_meta_title	string	text
art_meta_desc	string	text
art_meta_keywords	string	text
art_url_canonical	string	varchar(2000)
art_image	string	varchar(255)
art_lien_ext	string	varchar(255)
art_guid	string	varchar(255)
art_mentions_auteur	string	varchar(255)
art_focus	int	int(1) unsigned 0
art_disp_rss	int	int(1) unsigned 0
art_params	string	text JSON
art_actif	int	int(1) unsigned 0
art_validation_client	int	int(1) default null - NULL=En attente validation, 0=Refusé, 1=Validé, 2=Pas de validation en attente
art_validation_client_date	string	datetime - default null - Date de la validation/refus, en fonction de art_validation_client
art_motif_refus	string	varchar(255) - Si refus lors de la validation client, indication du motif
art_captcha	string	varchar(10) - Utile pour les articles soumis à validation (petites annonces)
art_pub_date	string	datetime
art_pubfin_date	string	datetime - date de fin de publication, optionnel
art_debut_date	string	datetime - date de début si c'est un événement, optionnel
art_fin_date	string	datetime - date de fin si c'est un événement, optionnel
art_rss_pub_date	string	datetime - si c'est un article issu de la curation, indique la date de publication telle que récupérée dans le flux
art_pj_archived_crons_last_update	string	datetime - date du dernier passage du CRON d'archivage/désarchivage des PJs/Images
art_crea_date	string	datetime
art_crea_user_id	int	int(11) unsigned 0
art_modif_date	string	datetime
art_modif_user_id	int	int(11) unsigned 0
aSitesIds	array	Liste des IDs des sites auxquels est rattaché cet article
aCatsIds	array	Liste des IDs des catégories auxquelles est rattaché cet article
aEpUsersIds	array	Liste des IDs d'EP-USERS auxquels est rattaché cet article

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/articles/publicationsResume GET

Retourne des stats de publication des articles
Détails

/articles[/:id] POST

Enregistre (créé ou modifie) un article
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

BlogArticle_DB + file(base64) + catsids + sitesids

Example

json

{
    "art_id": null,
    "art_titre": "Mon titre",
    "art_texte": "Mon texte...",
    "art_image": "data:image/jpeg;base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de l'image",
    "art_lien_ext": "[URL_SOURCE ou VIDE]",
    "art_mentions_auteur": "",
    "art_focus": 0,
    "art_disp_rss": 1,
    "art_actif": 0,
    "art_validation_client": null,
    "art_pub_date": "2017-03-23 13:15:21",
    "art_pubfin_date": null,
    "art_debut_date": null,
    "art_fin_date": null,
    "aSitesIds": [
        671
    ],
    "aCatsIds": [
        45
    ]
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

BlogArticle_DB|false

Article créé/modifié ou false

BlogArticle_DB

Propriété	Type	Type SQL / Infos
art_id	int	int(11) unsigned
art_token	string	varchar(255) - Pour sécuriser le lien de validation de l'article
art_preview_token	string	varchar(255)
art_preview_token_date	string	datetime
art_titre	string	varchar(255)
art_texte	string	text
art_temps_lecture	int	int(11) unsigned 0 -> temps de lecture en minutes
art_url_perso	string	text
art_meta_title	string	text
art_meta_desc	string	text
art_meta_keywords	string	text
art_url_canonical	string	varchar(2000)
art_image	string	varchar(255)
art_lien_ext	string	varchar(255)
art_guid	string	varchar(255)
art_mentions_auteur	string	varchar(255)
art_focus	int	int(1) unsigned 0
art_disp_rss	int	int(1) unsigned 0
art_params	string	text JSON
art_actif	int	int(1) unsigned 0
art_validation_client	int	int(1) default null - NULL=En attente validation, 0=Refusé, 1=Validé, 2=Pas de validation en attente
art_validation_client_date	string	datetime - default null - Date de la validation/refus, en fonction de art_validation_client
art_motif_refus	string	varchar(255) - Si refus lors de la validation client, indication du motif
art_captcha	string	varchar(10) - Utile pour les articles soumis à validation (petites annonces)
art_pub_date	string	datetime
art_pubfin_date	string	datetime - date de fin de publication, optionnel
art_debut_date	string	datetime - date de début si c'est un événement, optionnel
art_fin_date	string	datetime - date de fin si c'est un événement, optionnel
art_rss_pub_date	string	datetime - si c'est un article issu de la curation, indique la date de publication telle que récupérée dans le flux
art_pj_archived_crons_last_update	string	datetime - date du dernier passage du CRON d'archivage/désarchivage des PJs/Images
art_crea_date	string	datetime
art_crea_user_id	int	int(11) unsigned 0
art_modif_date	string	datetime
art_modif_user_id	int	int(11) unsigned 0
aSitesIds	array	Liste des IDs des sites auxquels est rattaché cet article
aCatsIds	array	Liste des IDs des catégories auxquelles est rattaché cet article
aEpUsersIds	array	Liste des IDs d'EP-USERS auxquels est rattaché cet article

/ateliers (1)

GET /ateliers[/:id][/:id]...

/ateliers[/:id][/:id]... GET

Retourne un ou des ateliers(s)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

bool

onlyactifs (default = true)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

Atelier_Evnmt_DB[]|object

Liste d'ateliers

Atelier_Evnmt_DB

Propriété	Type	Type SQL / Infos
atev_id	int	int(11)
atev_lieu_id	int	int(11)
atev_titre	string	varchar(250)
atev_date_debut	string	date
atev_date_fin	string	date
atev_horaires	string	text
atev_places	int	int(11) Nb total de places
atev_placesdispo	int	int(11) à supprimer !!! - remplacer par getPlacesDispo() qui calcule en fonction des inscrits...
atev_complet	int	tinyint(1)
atev_tarif_ht	float	decimal(10,2)
atev_tarif_ht_membrelabs	float	decimal(10,2)
atev_taux_tva	float	decimal(2,2)
atev_tarif_txt	string	text
atev_commentaires	string	text
atev_document	string	varchar(255)
atev_params	string	text
atev_disp_inscription	int	tinyint(1)
atev_actif	int	tinyint(1)
atev_crea_date	string	datetime
atev_crea_user_id	int	int(11)
atev_modif_date	string	datetime
atev_modif_user_id	int	int(11)
atev_duplicated	int	int(1) bool

/contacts (3)

GET /contacts[/:id][/:id]...

POST /contacts

PUT /contacts/statuts/:id

/contacts[/:id][/:id]... GET

Retourne une ou des demande(s) de contact
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

int

siteid (default = 0)

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

DemandeContact_DB[]

Liste de demandes

DemandeContact_DB

Propriété	Type	Type SQL / Infos
dc_id	int	int(11) unsigned
dc_site_id	int	int(11) unsigned
dc_page_id	int	int(11) unsigned
dc_content_id	int	int(11) unsigned
dc_annonce_id	int	int(11) unsigned
dc_organisation	string	varchar(255)
dc_nom	string	varchar(255)
dc_prenom	string	varchar(255)
dc_mail	string	varchar(255)
dc_tel	string	varchar(255)
dc_prefixe_objet	string	varchar(255)
dc_objet	string	varchar(255)
dc_message	string	text
dc_champsperso	string	text JSON
dc_ref	string	varchar(255)
dc_consentement	string	text
dc_date	string	datetime
dc_date_anonymised	string	datetime
dc_anonymised_files_to_delete	string	text JSON - Fichiers à supprimer au bout de 96H après anonymisation
dc_ip	string	varchar(50)
dc_captcha	string	varchar(10)
dc_sent_to_admin	int	int(1) bool - indique si la demande de contact a été envoyée à l'admin - default = null pour rétrocompatibilité
dc_sent_to_user	int	int(1) bool - indique si la confirmation de demande de contact a été envoyée à l'utilisateur - default = null pour rétrocompatibilité
dc_is_spam	int	int(1) bool - indique si la demande de contact provient d'une adresse blacklistée - default = null pour rétrocompatibilité
dc_restricted_files_token	string	varchar(255) - le token utilisé pour les fichiers à accès restreint inclus dans un lien de confirmation de demande de contact - default = ''
dc_params	string	text JSON
dc_traitement	int	int(11)
dc_lu_user	string	text JSON

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/contacts POST

Créé une demande de contact (modification interdite)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

DemandeContact_DB

Example

json

{
    "dc_id": null,
    "dc_site_id": "...",
    "dc_page_id": "...",
    "dc_content_id": "...",
    "dc_nom": "DOE",
    "dc_prenom": "John",
    "dc_champsperso": [
        {
            "label": "Nom",
            "value": "DOE"
        },
        {
            "label": "Prenom",
            "value": "John"
        }
    ],
    "...": "..."
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

DemandeContact_DB

Demande de contact

DemandeContact_DB

Propriété	Type	Type SQL / Infos
dc_id	int	int(11) unsigned
dc_site_id	int	int(11) unsigned
dc_page_id	int	int(11) unsigned
dc_content_id	int	int(11) unsigned
dc_annonce_id	int	int(11) unsigned
dc_organisation	string	varchar(255)
dc_nom	string	varchar(255)
dc_prenom	string	varchar(255)
dc_mail	string	varchar(255)
dc_tel	string	varchar(255)
dc_prefixe_objet	string	varchar(255)
dc_objet	string	varchar(255)
dc_message	string	text
dc_champsperso	string	text JSON
dc_ref	string	varchar(255)
dc_consentement	string	text
dc_date	string	datetime
dc_date_anonymised	string	datetime
dc_anonymised_files_to_delete	string	text JSON - Fichiers à supprimer au bout de 96H après anonymisation
dc_ip	string	varchar(50)
dc_captcha	string	varchar(10)
dc_sent_to_admin	int	int(1) bool - indique si la demande de contact a été envoyée à l'admin - default = null pour rétrocompatibilité
dc_sent_to_user	int	int(1) bool - indique si la confirmation de demande de contact a été envoyée à l'utilisateur - default = null pour rétrocompatibilité
dc_is_spam	int	int(1) bool - indique si la demande de contact provient d'une adresse blacklistée - default = null pour rétrocompatibilité
dc_restricted_files_token	string	varchar(255) - le token utilisé pour les fichiers à accès restreint inclus dans un lien de confirmation de demande de contact - default = ''
dc_params	string	text JSON
dc_traitement	int	int(11)
dc_lu_user	string	text JSON

/contacts/statuts/:id PUT

Modifie le statut du traitement de la demande de contact ou le lu/non lu de la demande
Détails

Request body

json

{
    "statutTraitementId": 2,
    "userReadIds": {
        "1": true,
        "20": false
    }
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

DemandeContact_DB

Demande de contact

DemandeContact_DB

Propriété	Type	Type SQL / Infos
dc_id	int	int(11) unsigned
dc_site_id	int	int(11) unsigned
dc_page_id	int	int(11) unsigned
dc_content_id	int	int(11) unsigned
dc_annonce_id	int	int(11) unsigned
dc_organisation	string	varchar(255)
dc_nom	string	varchar(255)
dc_prenom	string	varchar(255)
dc_mail	string	varchar(255)
dc_tel	string	varchar(255)
dc_prefixe_objet	string	varchar(255)
dc_objet	string	varchar(255)
dc_message	string	text
dc_champsperso	string	text JSON
dc_ref	string	varchar(255)
dc_consentement	string	text
dc_date	string	datetime
dc_date_anonymised	string	datetime
dc_anonymised_files_to_delete	string	text JSON - Fichiers à supprimer au bout de 96H après anonymisation
dc_ip	string	varchar(50)
dc_captcha	string	varchar(10)
dc_sent_to_admin	int	int(1) bool - indique si la demande de contact a été envoyée à l'admin - default = null pour rétrocompatibilité
dc_sent_to_user	int	int(1) bool - indique si la confirmation de demande de contact a été envoyée à l'utilisateur - default = null pour rétrocompatibilité
dc_is_spam	int	int(1) bool - indique si la demande de contact provient d'une adresse blacklistée - default = null pour rétrocompatibilité
dc_restricted_files_token	string	varchar(255) - le token utilisé pour les fichiers à accès restreint inclus dans un lien de confirmation de demande de contact - default = ''
dc_params	string	text JSON
dc_traitement	int	int(11)
dc_lu_user	string	text JSON

/encaissements (1)

GET /encaissements

/encaissements GET

Retourne un ou des encaissements(s)
Détails

Param	int	workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.
Param	int	siteid (default = 0)
Param	int	pagenum (default = 1)
Param	int	nbparpage (default = 30)
Api-Return	json	{ "output": { "success": 1, "response": [ { "...": "..." } ] } }
Return (response)	Encaissements[]	Liste d'encaissements
Multipage	headers	multipage_page multipage_count multipage_prev multipage_next

/boutiques (1)

GET /boutiques/commandes[/:id][/:id]...

/boutiques/commandes[/:id][/:id]... GET

Retourne les commandes boutiques
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

int

siteid (default = 0)

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

BoutCommande_DB[]

Liste Commandes boutiques

BoutCommande_DB

Propriété	Type	Type SQL / Infos
cmd_id	int	int(11)
cmd_site_id	int	int(11)
cmd_epuser_id	int	int(11)
cmd_session_id	string	varchar(50)
cmd_type	int	int(1) 0 = panier, 1 = commande
cmd_statut_paiement	string	varchar(50) OPEN, SUCCESS, FAILED, CANCELLED, AUTHORIZED, VOIDED, WAITING, ERROR
cmd_paiement_info	string	text JSON
cmd_paiement_date	string	datetime NULL
cmd_statut_traitement	string	varchar(50) NEW (à traiter), PROCESSING (en cours), DELIVERING (en cours d'expédition), CANCELLED (annulée), CLOSED (traitée)
cmd_numero	int	int(11)
cmd_params	string	text JSON
cmd_crea_user_id	int	int(11)
cmd_crea_date	string	datetime NULL
cmd_modif_user_id	int	int(11)
cmd_modif_date	string	datetime NULL
epuser_id	int	int(11)
epuser_site_id	int	int(11)
epuser_page_id	int	int(11)
epuser_anfiche_id	int	int(11) Spécifique LAB'S
epuser_nom	string	varchar(255)
epuser_prenom	string	varchar(255)
epuser_mail	string	varchar(255)
epuser_login	string	varchar(255)
epuser_pass	string	varchar(255)
epuser_token	string	varchar(255)
epuser_statut_activation	int	int(1) 0 = deleted, 1 = ok, 2 = attend confirmation mail
epuser_actif	int	int(1)
epuser_crea_date	string	datetime
epuser_crea_user_id	int	int(11)
epuser_crea_ip	string	varchar(15)
epuser_modif_date	string	datetime
epuser_modif_user_id	int	int(11)
epuser_modif_ip	string	varchar(15)
epuser_lastconnect_date	string	datetime
epuser_lastconnect_ip	string	varchar(15)
epuser_lastaction_date	string	datetime
epuser_lastaction_ip	string	varchar(15)

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/paiementsLibres (2)

GET /paiementsLibres[/:id][/:id]...

GET /paiementsLibres/token[/:id][/:id]

/paiementsLibres[/:id][/:id]... GET

Retourne un ou des paiements libres(s)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Param

string

ref - référence interne (default = '') => PL_xxxxxxxx

Param

string

refclient - référence client (default = '')

Param

string

startdatetransaction (default = '') => format yyyy-mm-dd
champ: pl_date -> renseigné lors du retour de PAYBOX

Param

string

enddatetransaction (default = '') => format yyyy-mm-dd
champ: pl_date -> renseigné lors du retour de PAYBOX

Param

string

startdatepaiement (default = '') => format yyyy-mm-dd
champ: pl_crea_date

Param

string

enddatepaiement (default = '') => format yyyy-mm-dd
champ: pl_crea_date

Param

boolean|null

istermine (default = '')
true : terminés uniquement
false : non-terminés uniquement
si vide : tous (terminée ET non terminés)

Param

boolean|null

isregle (default = '')
true : terminés uniquement
false : non-réglés uniquement
si vide : tous (réglés ET non réglés)

Param

int

siteid (default = 0) : ID du site concerné, nécessaire pour récupérer les données des pages associées

Example

string

&startdatetransaction=2023-04-20&enddatetransaction=2023-04-24 => Recherche entre 2 dates (incluses)

Example

string

istermine=true => Recherche tous les paiements terminés uniquement (ayant eu un retour de PAYBOX, Payé ou Refusé)

Example

string

ref=PL_xxxxxxx => Recherche une référence interne spécifique

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

PaiementLibre_DB[]

Liste de paiements libres

PaiementLibre_DB

Propriété	Type	Type SQL / Infos
pl_id	int	int(11)
pl_solution	int	int(11) 1 = SYSPAY, 2 = PAYBOX
pl_statut	string	varchar(50) Code Paybox du statut du paiement. Si vide = non effectué. Sinon correspond au statut renvoyé par Paybox. '00000' indique un paiement réussi et toute autre valeur un échec (voir http://www1.paybox.com/espace-integrateur-documentation/dictionnaire-des-donnees/codes-reponses/#reseau-cb pour plus de détails).
pl_statut_desc	string	varchar(50) Statut du paiement.
pl_montant	float	decimal(10,2)
pl_mail	string	varchar(255)
pl_ref	string	varchar(255) Référence unique de paiement
pl_refclient	string	varchar(255) Référence saisie par le client
pl_statut_remontee_secib	int	int(1) Statut de la remontée du règlement dans SECIB - 1 = OK, 0 = KO, NULL = non appliquable
pl_nom	string	varchar(255)
pl_prenom	string	varchar(255)
pl_adresse	string	varchar(50)
pl_code_postal	string	varchar(16)
pl_ville	string	varchar(50)
pl_pays	string	varchar(50)
pl_champspersos	string	text JSON = {"fields":[...], "destinatairesconfirmation":[...], "useassubject":[...]}
pl_info	string	text JSON
pl_page_id	int	int(11)
pl_content_id	int	int(11)
pl_date	string	datetime
pl_consentement	string	text JSON
pl_captcha	string	varchar(10)
pl_is_abo	int	int(1) Est-ce qu'on est dans le cadre d'un PAIEMENT PAR ABONNEMENT
pl_ref_abo	string	varchar(255) Référence de l'abonnement (pour le paiement en N fois)
pl_debut_cb	string	varchar(16) Début des numéros de la CB
pl_fin_cb	string	varchar(16) Fin des numéros de la CB
pl_date_fin_cb	string	datetime Date d'expiration de la CB
pl_montant_echeance	float	decimal(10,2)
pl_paiement_initial_date	string	datetime
pl_paiement_deuxieme_prelevement_date	string	datetime
pl_nb_echeance	int	int(11)
pl_freq_prelevement	int	int(11)
pl_ordre_prelevement	int	int(11)
pl_montant_total_abo	float	decimal(10,2)
pl_is_paiement_initial_abo	int	int(1)
pl_is_paiement_moins_90_jours	int	int(1)
pl_crea_user_id	int	int(11)
pl_crea_date	string	datetime
pl_modif_user_id	int	int(11)
pl_modif_date	string	datetime
pl_params	string	text JSON
sPageTitle	string	Titre de la page de paiement associée au dit paiement \| Utilisé par l'API

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/paiementsLibres/token[/:id][/:id] GET

Calcule et retourne un token de protection à partir d'un ou plusieurs champs d'un formulaire de paiement libre, à injecter dans l'url de formulaire de paiement
Le ou les champs envoyés seront considérés comme non modifiables dans le formulaire de paiement (et une erreur sera retournée si les données ne sont pas conformes).
Détails

Param	int	workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.
Param	string	ref - La référence souhaitée (référence du client, de la facture à régler, du dossier...) (default = '')
Param	int	montant - Montant du paiement, (default = '')
Example	string	&ref=azerty&montant=800 => Génère un token pour verrouiller les champs 'ref' et 'montant' à respectivement "azerty" et "800" (euros)
Example	string	&montant=102.75 => Génère un token pour verrouiller le seul champ 'montant' à "102.75" (euros) [Note : "102,75" fonctionne également]
Api-Return	json	{ "output": { "success": 1, "response": [ { "...": "..." } ] } }
Return (response)	array	Liste token + chaîne uri

/annuaire (11)

GET /annuaire/dictionnaires

GET /annuaire/domainesArbo

GET /annuaire/domainesLightListePlate

GET /annuaire/membres[/:id][/:id]...

POST /annuaire/membres

PUT /annuaire/membres/:id

DELETE /annuaire/membres/:id

GET /annuaire/structures[/:id][/:id]...

POST /annuaire/structures

PUT /annuaire/structures/:id

DELETE /annuaire/structures/:id

/annuaire/dictionnaires GET

Retourne les dictionnaires (Listes des différentes valeurs possibles pour les champs Spécialités, Domaines de compétences, Langues, Moyens de paiement, Applis, Devises...)
Format "id":"libellé"
Détails

Param	int	workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.
Param	bool	meetlaw (default = false) Filtre les domaines de compétence, retourne uniquement ceux spécifiques pour MEETLAW
Api-Return	json	{ "output": { "success": 1, "response": { "specialites": { "1": "Droit bancaire et boursier", "...": "..." }, "domainescomp": { "101": "Assurance des particuliers", "...": "..." }, "barreaux": { "...": "..." }, "coursappel": { "...": "..." }, "departements": { "1": { "code": "01", "nom": "Ain", "region_id": 22, "cour_appel_id": 16 }, "...": "..." }, "regions": { "...": "..." }, "typesmembres": { "...": "..." }, "langues": { "1": "Anglais", "...": "..." }, "moyenspaiement": { "1": "CB", "...": "..." }, "applis": { "...": "..." }, "devises": { "1": "Euro", "...": "..." } } } }
Return (response)	array	Liste de dictionnaires

/annuaire/domainesArbo GET

Retourne les Domaines de compétences sous forme d'arbo
Format "id":{domaine}
Détails

/annuaire/domainesLightListePlate GET

Retourne les Domaines de compétences sous forme d'arbo en liste plate
Format "id":{domaine}
Détails

/annuaire/membres[/:id][/:id]... GET

Retourne une ou des fiches "membre"
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Param

string

lg (default = 'fr')

Param

string

search - Recherche texte sur les champs suivants :

nom
prenom
adresse
adresse2
cp
ville
pays
poste
accroche
description courte
commentaires
biographie
aide juridictionnelle

Param

string

emailsearch - Recherche sur le champ 'email' uniquement (default = '')

Param

string

order - Permet d'ordonner les retours selon les clés suivantes :

prenom_asc (par prénom en ordre alphabétique)
prenom_desc (par prénom en ordre alphabétique inverse)
nom_asc (par nom en ordre alphabétique)
nom_desc (par nom en ordre alphabétique inverse)
id_asc (par id croissant) - (Valeur par défaut)
id_desc (par id décroissant)

Return (response)

AnnuaireFiche_DB[]

Liste de fiches

AnnuaireFiche_DB

Propriété	Type	Type SQL / Infos
anfiche_id	int	int(11)
anfiche_unca_guid	string	varchar(255)
anfiche_type	int	int(11) - 1 = avocat associé, 2 = avocat collaborateur, etc
anfiche_service	string	varchar(255) Service associé au type
anfiche_civilite	int\|string	int(11) - 1 = Monsieur, 2 = Madame, 3 = Maître (ou varchar(10) : Monsieur, Madame, Maître (déprécié))
anfiche_sexe	int	int(1)
anfiche_nom	string	varchar(100)
anfiche_prenom	string	varchar(100)
anfiche_photo	string	varchar(255)
anfiche_extra_photo_fiche	string	varchar(255)
anfiche_date_naissance	string	date
anfiche_date_serment	string	date
anfiche_num_case	string	varchar(50)
anfiche_adresse	string	text
anfiche_adresse2	string	text
anfiche_cp	string	varchar(10)
anfiche_ville	string	varchar(255)
anfiche_pays	string	varchar(100)
anfiche_tel	string	varchar(20)
anfiche_mobile	string	varchar(20)
anfiche_fax	string	varchar(20)
anfiche_mail	string	varchar(200)
anfiche_site	string	varchar(200)
anfiche_ggmap	string	varchar(200)
anfiche_dep_id	int	int(11)
anfiche_barreau_id	int	int(11)
anfiche_cour_appel_id	int	int(11)
anfiche_url	string	varchar(255)
anfiche_url_twitter	string	varchar(255)
anfiche_url_facebook	string	varchar(255)
anfiche_url_linkedin	string	varchar(255)
anfiche_url_instagram	string	varchar(255)
anfiche_url_youtube	string	varchar(255)
anfiche_url_meetlaw	string	varchar(255)
anfiche_annuaire	int	tinyint(1)
anfiche_ordre	int	int(11)
anfiche_bureau	int	tinyint(1)
anfiche_ordre_bureau	int	int(11)
anfiche_conseil_admin	int	tinyint(1)
anfiche_ordre_ca	int	int(11)
anfiche_ordre_commdev	int	int(11)
anfiche_commission_dev	int	tinyint(1)
anfiche_vu_annuaire	int	tinyint(1)
anfiche_date_seminaire	int	int(11)
anfiche_old_url	string	text
anfiche_rdv_url	string	varchar
anfiche_rdv_agenda_id	int	nt(11)
anfiche_etat_option_visio	int	int(11) - BITFIELD
anfiche_statut_validation	int	int(11)
anfiche_params	string	text JSON
anfiche_script	string	text
anfiche_crea_date	string	datetime
anfiche_crea_user_id	int	int(11)
anfiche_modif_date	string	datetime
anfiche_modif_user_id	int	int(11)
anfiche_duplicated	int	int(1) bool
anfiche_lg	string	varchar(2) - internationalisation
anfiche_actif	int	int(11) - internationalisé
anfiche_focus	int	int(11) - internationalisé
anfiche_poste	string	varchar(255) - internationalisé
anfiche_societe	string	varchar(100) - internationalisé
anfiche_formejuridique	string	varchar(50) - internationalisé
anfiche_accroche	string	text - internationalisé
anfiche_description_courte	string	text - internationalisé
anfiche_commentaires	string	text - internationalisé
anfiche_biographie	string	text - internationalisé
anfiche_aide_juridictionnelle	string	text - internationalisé
anfiche_fonction	string	varchar(255) - internationalisé
anfiche_meta_title	string	varchar(200) - internationalisé
anfiche_meta_desc	string	text - internationalisé
anfiche_meta_keywords	string	text - internationalisé
aStructuresIds	array	Réservé pour l'API - Liste des IDs de structures
aSpecialitesIds	array	Réservé pour l'API - Liste des IDs de spéciélités
aDomCmpIds	array	Réservé pour l'API - Liste des IDs de domaines de compétences
aDomCmpFavIds	array	Réservé pour l'API - Liste des IDs de domaines de compétences FAVORIS
aLanguesIds	array	Réservé pour l'API - Liste des IDs de langues
aMoyensPaiementIds	array	Réservé pour l'API - Liste des IDs de moyens de paiement
aApplisIds	array	Réservé pour l'API - Liste des IDs d'applications/solutions
aDevisesIds	array	Réservé pour l'API - Liste des IDs de devises

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/annuaire/membres POST

Enregistre (créé) une nouvelle fiche "membre" (sans préciser d'id)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

AnnuaireFiche_DB + files(base64 ou URL absolues ou URL inchangées)

Example

json

{
    "anfiche_id": null,
    "anfiche_type": 1,
    "anfiche_civilite": 1,
    "anfiche_sexe": 1,
    "anfiche_nom": "GILLES",
    "anfiche_prenom": "Olivier",
    "anfiche_photo": "data:image/[webp|jpeg|gif|png];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de l'image",
    "...": "...",
    "aStructuresIds": [
        "2"
    ],
    "aSpecialitesIds": [
        "1"
    ],
    "aDomCmpIds": [
        "101"
    ],
    "aLanguesIds": [
        "1"
    ],
    "aMoyensPaiementIds": [
        "1"
    ]
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

AnnuaireFiche_DB

Fiche créée

AnnuaireFiche_DB

Propriété	Type	Type SQL / Infos
anfiche_id	int	int(11)
anfiche_unca_guid	string	varchar(255)
anfiche_type	int	int(11) - 1 = avocat associé, 2 = avocat collaborateur, etc
anfiche_service	string	varchar(255) Service associé au type
anfiche_civilite	int\|string	int(11) - 1 = Monsieur, 2 = Madame, 3 = Maître (ou varchar(10) : Monsieur, Madame, Maître (déprécié))
anfiche_sexe	int	int(1)
anfiche_nom	string	varchar(100)
anfiche_prenom	string	varchar(100)
anfiche_photo	string	varchar(255)
anfiche_extra_photo_fiche	string	varchar(255)
anfiche_date_naissance	string	date
anfiche_date_serment	string	date
anfiche_num_case	string	varchar(50)
anfiche_adresse	string	text
anfiche_adresse2	string	text
anfiche_cp	string	varchar(10)
anfiche_ville	string	varchar(255)
anfiche_pays	string	varchar(100)
anfiche_tel	string	varchar(20)
anfiche_mobile	string	varchar(20)
anfiche_fax	string	varchar(20)
anfiche_mail	string	varchar(200)
anfiche_site	string	varchar(200)
anfiche_ggmap	string	varchar(200)
anfiche_dep_id	int	int(11)
anfiche_barreau_id	int	int(11)
anfiche_cour_appel_id	int	int(11)
anfiche_url	string	varchar(255)
anfiche_url_twitter	string	varchar(255)
anfiche_url_facebook	string	varchar(255)
anfiche_url_linkedin	string	varchar(255)
anfiche_url_instagram	string	varchar(255)
anfiche_url_youtube	string	varchar(255)
anfiche_url_meetlaw	string	varchar(255)
anfiche_annuaire	int	tinyint(1)
anfiche_ordre	int	int(11)
anfiche_bureau	int	tinyint(1)
anfiche_ordre_bureau	int	int(11)
anfiche_conseil_admin	int	tinyint(1)
anfiche_ordre_ca	int	int(11)
anfiche_ordre_commdev	int	int(11)
anfiche_commission_dev	int	tinyint(1)
anfiche_vu_annuaire	int	tinyint(1)
anfiche_date_seminaire	int	int(11)
anfiche_old_url	string	text
anfiche_rdv_url	string	varchar
anfiche_rdv_agenda_id	int	nt(11)
anfiche_etat_option_visio	int	int(11) - BITFIELD
anfiche_statut_validation	int	int(11)
anfiche_params	string	text JSON
anfiche_script	string	text
anfiche_crea_date	string	datetime
anfiche_crea_user_id	int	int(11)
anfiche_modif_date	string	datetime
anfiche_modif_user_id	int	int(11)
anfiche_duplicated	int	int(1) bool
anfiche_lg	string	varchar(2) - internationalisation
anfiche_actif	int	int(11) - internationalisé
anfiche_focus	int	int(11) - internationalisé
anfiche_poste	string	varchar(255) - internationalisé
anfiche_societe	string	varchar(100) - internationalisé
anfiche_formejuridique	string	varchar(50) - internationalisé
anfiche_accroche	string	text - internationalisé
anfiche_description_courte	string	text - internationalisé
anfiche_commentaires	string	text - internationalisé
anfiche_biographie	string	text - internationalisé
anfiche_aide_juridictionnelle	string	text - internationalisé
anfiche_fonction	string	varchar(255) - internationalisé
anfiche_meta_title	string	varchar(200) - internationalisé
anfiche_meta_desc	string	text - internationalisé
anfiche_meta_keywords	string	text - internationalisé
aStructuresIds	array	Réservé pour l'API - Liste des IDs de structures
aSpecialitesIds	array	Réservé pour l'API - Liste des IDs de spéciélités
aDomCmpIds	array	Réservé pour l'API - Liste des IDs de domaines de compétences
aDomCmpFavIds	array	Réservé pour l'API - Liste des IDs de domaines de compétences FAVORIS
aLanguesIds	array	Réservé pour l'API - Liste des IDs de langues
aMoyensPaiementIds	array	Réservé pour l'API - Liste des IDs de moyens de paiement
aApplisIds	array	Réservé pour l'API - Liste des IDs d'applications/solutions
aDevisesIds	array	Réservé pour l'API - Liste des IDs de devises

/annuaire/membres/:id PUT

Enregistre (crée ou modifie) une fiche "membre" (en précisant obligatoirement l'id)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

AnnuaireFiche_DB + files(base64 ou URL absolues ou URL inchangées) + catsids

Example

json

{
    "anfiche_id": 1,
    "anfiche_type": 1,
    "anfiche_civilite": 1,
    "anfiche_sexe": 1,
    "anfiche_nom": "GILLES",
    "anfiche_prenom": "Olivier",
    "anfiche_photo": "data:image/[webp|jpeg|gif|png];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de l'image",
    "...": "...",
    "aStructuresIds": [
        "2"
    ],
    "aSpecialitesIds": [
        "1"
    ],
    "aDomCmpIds": [
        "101"
    ],
    "aLanguesIds": [
        "1"
    ],
    "aMoyensPaiementIds": [
        "1"
    ]
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

AnnuaireFiche_DB

Fiche créée ou modifiée

AnnuaireFiche_DB

Propriété	Type	Type SQL / Infos
anfiche_id	int	int(11)
anfiche_unca_guid	string	varchar(255)
anfiche_type	int	int(11) - 1 = avocat associé, 2 = avocat collaborateur, etc
anfiche_service	string	varchar(255) Service associé au type
anfiche_civilite	int\|string	int(11) - 1 = Monsieur, 2 = Madame, 3 = Maître (ou varchar(10) : Monsieur, Madame, Maître (déprécié))
anfiche_sexe	int	int(1)
anfiche_nom	string	varchar(100)
anfiche_prenom	string	varchar(100)
anfiche_photo	string	varchar(255)
anfiche_extra_photo_fiche	string	varchar(255)
anfiche_date_naissance	string	date
anfiche_date_serment	string	date
anfiche_num_case	string	varchar(50)
anfiche_adresse	string	text
anfiche_adresse2	string	text
anfiche_cp	string	varchar(10)
anfiche_ville	string	varchar(255)
anfiche_pays	string	varchar(100)
anfiche_tel	string	varchar(20)
anfiche_mobile	string	varchar(20)
anfiche_fax	string	varchar(20)
anfiche_mail	string	varchar(200)
anfiche_site	string	varchar(200)
anfiche_ggmap	string	varchar(200)
anfiche_dep_id	int	int(11)
anfiche_barreau_id	int	int(11)
anfiche_cour_appel_id	int	int(11)
anfiche_url	string	varchar(255)
anfiche_url_twitter	string	varchar(255)
anfiche_url_facebook	string	varchar(255)
anfiche_url_linkedin	string	varchar(255)
anfiche_url_instagram	string	varchar(255)
anfiche_url_youtube	string	varchar(255)
anfiche_url_meetlaw	string	varchar(255)
anfiche_annuaire	int	tinyint(1)
anfiche_ordre	int	int(11)
anfiche_bureau	int	tinyint(1)
anfiche_ordre_bureau	int	int(11)
anfiche_conseil_admin	int	tinyint(1)
anfiche_ordre_ca	int	int(11)
anfiche_ordre_commdev	int	int(11)
anfiche_commission_dev	int	tinyint(1)
anfiche_vu_annuaire	int	tinyint(1)
anfiche_date_seminaire	int	int(11)
anfiche_old_url	string	text
anfiche_rdv_url	string	varchar
anfiche_rdv_agenda_id	int	nt(11)
anfiche_etat_option_visio	int	int(11) - BITFIELD
anfiche_statut_validation	int	int(11)
anfiche_params	string	text JSON
anfiche_script	string	text
anfiche_crea_date	string	datetime
anfiche_crea_user_id	int	int(11)
anfiche_modif_date	string	datetime
anfiche_modif_user_id	int	int(11)
anfiche_duplicated	int	int(1) bool
anfiche_lg	string	varchar(2) - internationalisation
anfiche_actif	int	int(11) - internationalisé
anfiche_focus	int	int(11) - internationalisé
anfiche_poste	string	varchar(255) - internationalisé
anfiche_societe	string	varchar(100) - internationalisé
anfiche_formejuridique	string	varchar(50) - internationalisé
anfiche_accroche	string	text - internationalisé
anfiche_description_courte	string	text - internationalisé
anfiche_commentaires	string	text - internationalisé
anfiche_biographie	string	text - internationalisé
anfiche_aide_juridictionnelle	string	text - internationalisé
anfiche_fonction	string	varchar(255) - internationalisé
anfiche_meta_title	string	varchar(200) - internationalisé
anfiche_meta_desc	string	text - internationalisé
anfiche_meta_keywords	string	text - internationalisé
aStructuresIds	array	Réservé pour l'API - Liste des IDs de structures
aSpecialitesIds	array	Réservé pour l'API - Liste des IDs de spéciélités
aDomCmpIds	array	Réservé pour l'API - Liste des IDs de domaines de compétences
aDomCmpFavIds	array	Réservé pour l'API - Liste des IDs de domaines de compétences FAVORIS
aLanguesIds	array	Réservé pour l'API - Liste des IDs de langues
aMoyensPaiementIds	array	Réservé pour l'API - Liste des IDs de moyens de paiement
aApplisIds	array	Réservé pour l'API - Liste des IDs d'applications/solutions
aDevisesIds	array	Réservé pour l'API - Liste des IDs de devises

/annuaire/membres/:id DELETE

Supprime une fiche membre
Détails

/annuaire/structures[/:id][/:id]... GET

Retourne une ou des fiches "structures"
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": []
    }
}

Return (response)

AnnuaireOrganisme_DB[]

Liste de fiches

AnnuaireOrganisme_DB

Propriété	Type	Type SQL / Infos
anorg_id	int	int(11)
anorg_unca_guid	string	varchar(255)
anorg_type	int	int(11)
anorg_orga_id	int	int(11) Rattachement à une ORGANISATION
anorg_nom	string	varchar(250)
anorg_formejuridique	string	varchar(255)
anorg_crpcen	string	varchar(10)
anorg_display_annonce	int	int(1)
anorg_iso	int	int(1)
anorg_charte_honoraires	int	int(1)
anorg_adresse1	string	varchar(250)
anorg_adresse2	string	varchar(250)
anorg_cp	string	varchar(75)
anorg_ville	string	varchar(250)
anorg_mail	string	varchar(250)
anorg_site	string	varchar(250)
anorg_url_paiement	string	varchar(250)
anorg_tel	string	varchar(75)
anorg_fax	string	varchar(75)
anorg_numero_groupe	int	int(11)
anorg_logo	string	varchar(255)
anorg_url	string	varchar(255)
anorg_dep_id	int	int(11)
anorg_barreau_id	int	int(11)
anorg_cour_appel_id	int	int(11)
anorg_espaceclient_url	string	varchar(255)
anorg_raison_sociale	string	varchar(250)
anorg_date_adhesion	int	int(11)
anorg_old_url	string	text
anorg_ordre	int	int(11)
anorg_crea_date	string	datetime
anorg_crea_user_id	int	int(11)
anorg_modif_date	string	datetime
anorg_modif_user_id	int	int(11)
anorg_duplicated	int	int(1) bool
anorg_params	string	text JSON
anorg_lg	string	varchar(2) - internationalisation
anorg_actif	int	int(1)
anorg_description	string	text /!\ Correspond en réalité au "sous-titre"
anorg_description_courte	string	text
anorg_description_longue	string	text
anorg_commentaires	string	text
anorg_meta_title	string	varchar(200)
anorg_meta_desc	string	text
anorg_meta_keywords	string	text

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/annuaire/structures POST

Enregistre (créé) une nouvelle fiche "structure" (sans préciser d'id)
/!\ En cours de développement...
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

AnnuaireOrganisme_DB + files(base64 ou URL absolues ou URL inchangées)

Example

json

{
    "anorg_id": null,
    "...": "..."
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

AnnuaireOrganisme_DB

Fiche créée

AnnuaireOrganisme_DB

Propriété	Type	Type SQL / Infos
anorg_id	int	int(11)
anorg_unca_guid	string	varchar(255)
anorg_type	int	int(11)
anorg_orga_id	int	int(11) Rattachement à une ORGANISATION
anorg_nom	string	varchar(250)
anorg_formejuridique	string	varchar(255)
anorg_crpcen	string	varchar(10)
anorg_display_annonce	int	int(1)
anorg_iso	int	int(1)
anorg_charte_honoraires	int	int(1)
anorg_adresse1	string	varchar(250)
anorg_adresse2	string	varchar(250)
anorg_cp	string	varchar(75)
anorg_ville	string	varchar(250)
anorg_mail	string	varchar(250)
anorg_site	string	varchar(250)
anorg_url_paiement	string	varchar(250)
anorg_tel	string	varchar(75)
anorg_fax	string	varchar(75)
anorg_numero_groupe	int	int(11)
anorg_logo	string	varchar(255)
anorg_url	string	varchar(255)
anorg_dep_id	int	int(11)
anorg_barreau_id	int	int(11)
anorg_cour_appel_id	int	int(11)
anorg_espaceclient_url	string	varchar(255)
anorg_raison_sociale	string	varchar(250)
anorg_date_adhesion	int	int(11)
anorg_old_url	string	text
anorg_ordre	int	int(11)
anorg_crea_date	string	datetime
anorg_crea_user_id	int	int(11)
anorg_modif_date	string	datetime
anorg_modif_user_id	int	int(11)
anorg_duplicated	int	int(1) bool
anorg_params	string	text JSON
anorg_lg	string	varchar(2) - internationalisation
anorg_actif	int	int(1)
anorg_description	string	text /!\ Correspond en réalité au "sous-titre"
anorg_description_courte	string	text
anorg_description_longue	string	text
anorg_commentaires	string	text
anorg_meta_title	string	varchar(200)
anorg_meta_desc	string	text
anorg_meta_keywords	string	text

/annuaire/structures/:id PUT

Enregistre (crée ou modifie) une fiche "structure" (en précisant obligatoirement l'id)
/!\ En cours de développement...
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

AnnuaireOrganisme_DB + files(base64 ou URL absolues ou URL inchangées) + catsids

Example

json

{
    "anorg_id": 1,
    "...": "..."
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

AnnuaireOrganisme_DB

Fiche créée ou modifiée

AnnuaireOrganisme_DB

Propriété	Type	Type SQL / Infos
anorg_id	int	int(11)
anorg_unca_guid	string	varchar(255)
anorg_type	int	int(11)
anorg_orga_id	int	int(11) Rattachement à une ORGANISATION
anorg_nom	string	varchar(250)
anorg_formejuridique	string	varchar(255)
anorg_crpcen	string	varchar(10)
anorg_display_annonce	int	int(1)
anorg_iso	int	int(1)
anorg_charte_honoraires	int	int(1)
anorg_adresse1	string	varchar(250)
anorg_adresse2	string	varchar(250)
anorg_cp	string	varchar(75)
anorg_ville	string	varchar(250)
anorg_mail	string	varchar(250)
anorg_site	string	varchar(250)
anorg_url_paiement	string	varchar(250)
anorg_tel	string	varchar(75)
anorg_fax	string	varchar(75)
anorg_numero_groupe	int	int(11)
anorg_logo	string	varchar(255)
anorg_url	string	varchar(255)
anorg_dep_id	int	int(11)
anorg_barreau_id	int	int(11)
anorg_cour_appel_id	int	int(11)
anorg_espaceclient_url	string	varchar(255)
anorg_raison_sociale	string	varchar(250)
anorg_date_adhesion	int	int(11)
anorg_old_url	string	text
anorg_ordre	int	int(11)
anorg_crea_date	string	datetime
anorg_crea_user_id	int	int(11)
anorg_modif_date	string	datetime
anorg_modif_user_id	int	int(11)
anorg_duplicated	int	int(1) bool
anorg_params	string	text JSON
anorg_lg	string	varchar(2) - internationalisation
anorg_actif	int	int(1)
anorg_description	string	text /!\ Correspond en réalité au "sous-titre"
anorg_description_courte	string	text
anorg_description_longue	string	text
anorg_commentaires	string	text
anorg_meta_title	string	varchar(200)
anorg_meta_desc	string	text
anorg_meta_keywords	string	text

/annuaire/structures/:id DELETE

Supprime une fiche structure
Détails

/annonces (12)

GET /annonces[/:id][/:id]...

POST /annonces

PUT /annonces/:id

PUT /annonces/ncis/:id-ncis

PUT /annonces/netty/:id-netty

DELETE /annonces/:id

DELETE /annonces/ncis/:id-ncis

DELETE /annonces/netty/:id-netty

GET /annonces/typesannonces

GET /annonces/types

GET /annonces/soustypes

GET /annonces/lieuxVente

/annonces[/:id][/:id]... GET

Retourne une ou des annonces
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Param

int

ncisEtudeId (default = 0) Spécifique NCIS, pour filtrer les annonces en fonction de l'étude

Param

bool|int

light (default = 0) Spécifique NCIS/NETTY, retourne des objets plus petits avec le minimum d'attributs

Param

int

siteid (default = 0)

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

Annonce_DB[]|Annonce_Light[]|AnnonceLieuVente_DB[]

Liste d'annonces

Annonce_DB

Propriété	Type	Type SQL / Infos
ann_id	int	int(11)
ann_titre	string	varchar(255)
ann_ref	string	varchar(255)
ann_type_bien_id	int	int(11)
ann_type_annonce_id	int	int(11)
ann_adresse_1	string	varchar(255)
ann_adresse_2	string	varchar(255)
ann_ville	string	varchar(255)
ann_cp	string	varchar(10)
ann_prix	string	decimal(10,2)
ann_prix_hors_honoraires	string	decimal(10,2)
ann_baisse_prix	int	int(1)
ann_desc	string	text
ann_nb_pieces	int	int(11)
ann_nb_chambres	int	int(11)
ann_nb_personnes	int	int(11)
ann_nb_couchages	int	int(11)
ann_surface	string	decimal(10,2)
ann_surface_terrain	string	decimal(10,2)
ann_dpe	int	int(11)
ann_dpe_classe	string	varchar(1) optionnel
ann_ges	int	int(11)
ann_ges_classe	string	varchar(1) optionnel
ann_cout_annuel_energie_min	string	decimal(10,2)
ann_cout_annuel_energie_max	string	decimal(10,2)
ann_annee_ref_energie	string	varchar(4)
ann_dpe_date_realisation	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_dpe_zone_climatique	int	int(1) bool
ann_photos	string	text JSON [{"file": "...","class": "...","title": "..."}]
ann_pieces_jointes	string	text JSON [{"file": "...","txt": "...","title": "...","target": "...","class": "..."}]
ann_pub_date	string	datetime
ann_pubfin_date	string	datetime
ann_ncis_etude_id	int	int(11)
ann_pays	string	varchar(255)
ann_honoraires	string	decimal(10,2)
ann_date_dispo	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_charges	int	int(11)
ann_etage	int	int(11)
ann_nb_etages	int	int(11)
ann_meuble	int	int(1) bool
ann_annee_construction	int	int(4)
ann_etat	int	int(11)
ann_nb_sdb	int	int(11)
ann_nb_sde	int	int(11)
ann_nb_wc	int	int(11)
ann_type_chauffage	int	int(11) - bitfield
ann_nb_terrasses	int	int(11)
ann_surface_terrasse	string	decimal(10,2)
ann_nb_balcons	int	int(11)
ann_ascenseur	int	int(1) bool
ann_cave	int	int(1) bool
ann_nb_parkings	int	int(11)
ann_nb_boxes	int	int(11)
ann_digicode	int	int(1) bool
ann_interphone	int	int(1) bool
ann_terrasse	int	int(1) bool
ann_situation	int	int(11)
ann_alarme	int	int(1) bool
ann_clim	int	int(1) bool
ann_piscine	int	int(1) bool
ann_cheminee	int	int(1) bool
ann_duplex	int	int(1) bool
ann_mandat_exclusif	int	int(1) bool
ann_coup_coeur	int	int(1) bool
ann_visite_virtuelle	string	varchar(255)
ann_visite_virtuelle_360	string	varchar(255)
ann_num_mandat	string	varchar(255)
ann_date_mandat	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_negociateur_nom	string	varchar(255)
ann_mandataire_nom	string	varchar(255)
ann_mandataire_mail	string	varchar(255)
ann_mandataire_tel	string	varchar(255)
ann_honoraires_visite_dossier_bail_locataire	string	decimal(10,2)
ann_honoraires_etat_lieux_locataire	string	decimal(10,2)
ann_depot_garantie	string	decimal(10,2)
ann_travaux_a_prevoir	int	int(1) bool
ann_ncis_bien_id	int	int(11)
ann_netty_etude_id	int	int(11)
ann_netty_bien_id	string	varchar(10)
ann_immo_notaires_id	int	int(11)
ann_noty_id	string	varchar(255)
ann_immonot_id	string	varchar(255)
ann_crpcen_etude_proprietaire	string	varchar(10)
ann_sous_type_bien	string	text
ann_viager_prix_bouquet	string	decimal(10,2)
ann_viager_rente_mensuelle	string	decimal(10,2) Utiliser "ann_viager_rente_montant" et "ann_viager_rente_periodicite" à la place
ann_viager_rente_montant	string	decimal(10,2)
ann_viager_rente_periodicite	int	int(11) - 0=aucune, 1=mensuelle, 2=bimensuelle, 3=trimestrielle, 4=semestrielle, 5=annuelle
ann_interactive_systeme_enchere	int	int(11) - 0=non defini, 1=ascendante, 2=descendante, voir constantes SYSTEME_ENCHERES_XXX
ann_interactive_pas_offre	string	decimal(10,2) - montant du pas de l'offre
ann_interactive_date_fin	string	datetime - fin de l'offre
ann_duree_bail	string	varchar(255)
ann_quai	int	int(1) bool
ann_nb_bureaux	int	int(11)
ann_terrain_agricole	int	int(1) bool
ann_terrain_constructible	int	int(1) bool
ann_frais_poursuites	string	decimal(10,2)
ann_honoraires_vendeur	int	int(1) bool
ann_honoraires_pourcentage_ttc	string	decimal(10,2)
ann_copropriete	int	int(1) bool
ann_nb_lots	int	int(11)
ann_charges_annuelles	string	decimal(10,2)
ann_syndic_prodecure	int	int(1) bool
ann_syndic_prodecure_details	string	varchar(255)
ann_exposition	string	varchar(2) N, S, E, O, NE, SE, NO, SO
ann_acces_pmr	int	int(1) bool
ann_situation_locative_loue	int\|null	int(1) bool
ann_cuisine	int	int(1) bool
ann_actif	int	int(11)
ann_focus	int	int(11)
ann_crea_date	string	datetime
ann_crea_user_id	int	int(11)
ann_modif_date	string	datetime
ann_modif_user_id	int	int(11)
ann_nature_regularisation	int	int(11)
ann_type_affichage_prix	int	int(11)
ann_url_bareme_honoraire	string	varchar (255)
ann_params	string	text JSON
ann_script	string	text
ann_statut_vente	int	int(11)
ann_ench_id	int	int(11)
ann_ench_lieu_id	int	int(11)
ann_ench_date_vente	string	datetime
ann_ench_date_visite	string	datetime\|JSON
ann_ench_desc	string	text
ann_ench_show_calcul_frais	int	int(1)
ann_ench_adjuge	int	int(1)
ann_ench_adjuge_montant	string	decimal(10,2)
ann_ench_vendu	int	int(1)
ann_ench_vendu_montant	string	decimal(10,2)
ann_ench_surenchere	int	int(1)
ann_ench_surenchere_date	string	datetime
ann_ench_surenchere_max_date	string	datetime
ann_ench_surenchere_montant	string	decimal(10,2)
ann_ench_report	int	int(1)
ann_ench_report_date	string	datetime
ann_ench_desertion	int	int(1)
ann_ench_annule	int	int(1)
ann_georisque	int	int(1)
ann_animaux_acceptes	int	int(1)
ann_tv	int	int(1)
ann_linge_lit	int	int(1)
ann_terrasse_couverte	int	int(1)
ann_jacuzzi	int	int(1)
ann_bouilloire	int	int(1)
ann_machine_cafe	int	int(1)
ann_micro_ondes	int	int(1)
ann_refrigerateur	int	int(1)
ann_cuisine_equipee	int	int(1)
ann_tables_chaises	int	int(1)
ann_sdb	int	int(1)
ann_linge_bain	int	int(1)
ann_wc_separe	int	int(1)
ann_seche_serviette	int	int(1)
ann_coin_repas	int	int(1)
ann_canape_convertible	int	int(1)
ann_canape	int	int(1)
ann_sanitaire_proximite	int	int(1)
ann_branchement_electrique	int	int(1)
ann_eau	int	int(1)
ann_emplacement_ombrage	int	int(1)
ann_tente	int	int(1)
ann_camping_car	int	int(1)
ann_caravane	int	int(1)
ann_meta_title	string	varchar(255) - par défaut valeur vide
ann_meta_desc	string	varchar(255) - par défaut valeur vide
ann_meta_keywords	string	varchar(255) - par défaut valeur vide
ann_url_canonical	string	varchar(2000)
aSitesIds	array	Liste des IDs de sites auxquels est rattachée cette annonce

Annonce_Light

Propriété	Type	Type SQL / Infos
ann_id	int	int(11)
ann_ref	string	varchar(255)
ann_pub_date	string	datetime
ann_pubfin_date	string	datetime
ann_ncis_etude_id	int	int(11)
ann_ncis_bien_id	int	int(11)
ann_netty_etude_id	int	int(11)
ann_netty_bien_id	int	int(11)
ann_actif	int	int(11)
ann_crea_date	string	datetime
ann_crea_user_id	int	int(11)
ann_modif_date	string	datetime
ann_modif_user_id	int	int(11)

AnnonceLieuVente_DB

Propriété	Type	Type SQL / Infos
lieu_id	int	int(11)
lieu_nom	string	varchar(255)
lieu_adresse_1	string	varchar(255)
lieu_adresse_2	string	varchar(255)
lieu_ville	string	varchar(255)
lieu_cp	string	varchar(10)
lieu_tel	string	varchar(255)
lieu_fax	string	varchar(255)
lieu_actif	int	int(1)
lieu_crea_date	string	datetime
lieu_crea_user_id	int	int(11)
lieu_modif_date	string	datetime
lieu_modif_user_id	int	int(11)

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/annonces POST

Enregistre (créé) une nouvelle annonce (sans préciser d'id)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

Annonce_DB + files(base64 ou URL absolues ou URL inchangées) + catsids

Example

json

{
    "ann_id": null,
    "ann_type_bien_id": 30,
    "ann_type_annonce_id": 2,
    "ann_photos": [
        {
            "file": "data:image/[webp|jpeg|gif|png];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de l'image",
            "class": "my class",
            "title": "Mon titre"
        },
        {
            "file": "//static.azko.fr/medias/shared/ann-1500284339596c85b3a5302718100649.jpg",
            "class": "my class",
            "title": "Mon titre"
        }
    ],
    "ann_pieces_jointes": [
        {
            "file": "//static.azko.fr/medias/shared/ann-1500284340596c85b425b13060062050.pdf",
            "txt": "Un fichier PDF",
            "title": "Mon titre",
            "target": "_blank",
            "class": "myClass"
        },
        {
            "file": "data:application/[extension];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de la pièce jointe",
            "txt": "Un fichier PDF",
            "title": "Mon titre",
            "target": "_blank",
            "class": "myClass"
        }
    ],
    "ann_pub_date": "2017-05-12 12:03:51",
    "ann_pubfin_date": null,
    "ann_actif": 1,
    "ann_focus": 0,
    "ann_crea_date": "2017-07-17 11:39:00",
    "ann_crea_user_id": 1,
    "ann_modif_date": "2017-07-17 12:04:38",
    "ann_modif_user_id": 1,
    "aSitesIds": [
        7
    ]
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

Annonce_DB

Annonce créée

Annonce_DB

Propriété	Type	Type SQL / Infos
ann_id	int	int(11)
ann_titre	string	varchar(255)
ann_ref	string	varchar(255)
ann_type_bien_id	int	int(11)
ann_type_annonce_id	int	int(11)
ann_adresse_1	string	varchar(255)
ann_adresse_2	string	varchar(255)
ann_ville	string	varchar(255)
ann_cp	string	varchar(10)
ann_prix	string	decimal(10,2)
ann_prix_hors_honoraires	string	decimal(10,2)
ann_baisse_prix	int	int(1)
ann_desc	string	text
ann_nb_pieces	int	int(11)
ann_nb_chambres	int	int(11)
ann_nb_personnes	int	int(11)
ann_nb_couchages	int	int(11)
ann_surface	string	decimal(10,2)
ann_surface_terrain	string	decimal(10,2)
ann_dpe	int	int(11)
ann_dpe_classe	string	varchar(1) optionnel
ann_ges	int	int(11)
ann_ges_classe	string	varchar(1) optionnel
ann_cout_annuel_energie_min	string	decimal(10,2)
ann_cout_annuel_energie_max	string	decimal(10,2)
ann_annee_ref_energie	string	varchar(4)
ann_dpe_date_realisation	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_dpe_zone_climatique	int	int(1) bool
ann_photos	string	text JSON [{"file": "...","class": "...","title": "..."}]
ann_pieces_jointes	string	text JSON [{"file": "...","txt": "...","title": "...","target": "...","class": "..."}]
ann_pub_date	string	datetime
ann_pubfin_date	string	datetime
ann_ncis_etude_id	int	int(11)
ann_pays	string	varchar(255)
ann_honoraires	string	decimal(10,2)
ann_date_dispo	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_charges	int	int(11)
ann_etage	int	int(11)
ann_nb_etages	int	int(11)
ann_meuble	int	int(1) bool
ann_annee_construction	int	int(4)
ann_etat	int	int(11)
ann_nb_sdb	int	int(11)
ann_nb_sde	int	int(11)
ann_nb_wc	int	int(11)
ann_type_chauffage	int	int(11) - bitfield
ann_nb_terrasses	int	int(11)
ann_surface_terrasse	string	decimal(10,2)
ann_nb_balcons	int	int(11)
ann_ascenseur	int	int(1) bool
ann_cave	int	int(1) bool
ann_nb_parkings	int	int(11)
ann_nb_boxes	int	int(11)
ann_digicode	int	int(1) bool
ann_interphone	int	int(1) bool
ann_terrasse	int	int(1) bool
ann_situation	int	int(11)
ann_alarme	int	int(1) bool
ann_clim	int	int(1) bool
ann_piscine	int	int(1) bool
ann_cheminee	int	int(1) bool
ann_duplex	int	int(1) bool
ann_mandat_exclusif	int	int(1) bool
ann_coup_coeur	int	int(1) bool
ann_visite_virtuelle	string	varchar(255)
ann_visite_virtuelle_360	string	varchar(255)
ann_num_mandat	string	varchar(255)
ann_date_mandat	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_negociateur_nom	string	varchar(255)
ann_mandataire_nom	string	varchar(255)
ann_mandataire_mail	string	varchar(255)
ann_mandataire_tel	string	varchar(255)
ann_honoraires_visite_dossier_bail_locataire	string	decimal(10,2)
ann_honoraires_etat_lieux_locataire	string	decimal(10,2)
ann_depot_garantie	string	decimal(10,2)
ann_travaux_a_prevoir	int	int(1) bool
ann_ncis_bien_id	int	int(11)
ann_netty_etude_id	int	int(11)
ann_netty_bien_id	string	varchar(10)
ann_immo_notaires_id	int	int(11)
ann_noty_id	string	varchar(255)
ann_immonot_id	string	varchar(255)
ann_crpcen_etude_proprietaire	string	varchar(10)
ann_sous_type_bien	string	text
ann_viager_prix_bouquet	string	decimal(10,2)
ann_viager_rente_mensuelle	string	decimal(10,2) Utiliser "ann_viager_rente_montant" et "ann_viager_rente_periodicite" à la place
ann_viager_rente_montant	string	decimal(10,2)
ann_viager_rente_periodicite	int	int(11) - 0=aucune, 1=mensuelle, 2=bimensuelle, 3=trimestrielle, 4=semestrielle, 5=annuelle
ann_interactive_systeme_enchere	int	int(11) - 0=non defini, 1=ascendante, 2=descendante, voir constantes SYSTEME_ENCHERES_XXX
ann_interactive_pas_offre	string	decimal(10,2) - montant du pas de l'offre
ann_interactive_date_fin	string	datetime - fin de l'offre
ann_duree_bail	string	varchar(255)
ann_quai	int	int(1) bool
ann_nb_bureaux	int	int(11)
ann_terrain_agricole	int	int(1) bool
ann_terrain_constructible	int	int(1) bool
ann_frais_poursuites	string	decimal(10,2)
ann_honoraires_vendeur	int	int(1) bool
ann_honoraires_pourcentage_ttc	string	decimal(10,2)
ann_copropriete	int	int(1) bool
ann_nb_lots	int	int(11)
ann_charges_annuelles	string	decimal(10,2)
ann_syndic_prodecure	int	int(1) bool
ann_syndic_prodecure_details	string	varchar(255)
ann_exposition	string	varchar(2) N, S, E, O, NE, SE, NO, SO
ann_acces_pmr	int	int(1) bool
ann_situation_locative_loue	int\|null	int(1) bool
ann_cuisine	int	int(1) bool
ann_actif	int	int(11)
ann_focus	int	int(11)
ann_crea_date	string	datetime
ann_crea_user_id	int	int(11)
ann_modif_date	string	datetime
ann_modif_user_id	int	int(11)
ann_nature_regularisation	int	int(11)
ann_type_affichage_prix	int	int(11)
ann_url_bareme_honoraire	string	varchar (255)
ann_params	string	text JSON
ann_script	string	text
ann_statut_vente	int	int(11)
ann_ench_id	int	int(11)
ann_ench_lieu_id	int	int(11)
ann_ench_date_vente	string	datetime
ann_ench_date_visite	string	datetime\|JSON
ann_ench_desc	string	text
ann_ench_show_calcul_frais	int	int(1)
ann_ench_adjuge	int	int(1)
ann_ench_adjuge_montant	string	decimal(10,2)
ann_ench_vendu	int	int(1)
ann_ench_vendu_montant	string	decimal(10,2)
ann_ench_surenchere	int	int(1)
ann_ench_surenchere_date	string	datetime
ann_ench_surenchere_max_date	string	datetime
ann_ench_surenchere_montant	string	decimal(10,2)
ann_ench_report	int	int(1)
ann_ench_report_date	string	datetime
ann_ench_desertion	int	int(1)
ann_ench_annule	int	int(1)
ann_georisque	int	int(1)
ann_animaux_acceptes	int	int(1)
ann_tv	int	int(1)
ann_linge_lit	int	int(1)
ann_terrasse_couverte	int	int(1)
ann_jacuzzi	int	int(1)
ann_bouilloire	int	int(1)
ann_machine_cafe	int	int(1)
ann_micro_ondes	int	int(1)
ann_refrigerateur	int	int(1)
ann_cuisine_equipee	int	int(1)
ann_tables_chaises	int	int(1)
ann_sdb	int	int(1)
ann_linge_bain	int	int(1)
ann_wc_separe	int	int(1)
ann_seche_serviette	int	int(1)
ann_coin_repas	int	int(1)
ann_canape_convertible	int	int(1)
ann_canape	int	int(1)
ann_sanitaire_proximite	int	int(1)
ann_branchement_electrique	int	int(1)
ann_eau	int	int(1)
ann_emplacement_ombrage	int	int(1)
ann_tente	int	int(1)
ann_camping_car	int	int(1)
ann_caravane	int	int(1)
ann_meta_title	string	varchar(255) - par défaut valeur vide
ann_meta_desc	string	varchar(255) - par défaut valeur vide
ann_meta_keywords	string	varchar(255) - par défaut valeur vide
ann_url_canonical	string	varchar(2000)
aSitesIds	array	Liste des IDs de sites auxquels est rattachée cette annonce

/annonces/:id PUT

Enregistre (crée ou modifie) une annonce (en précisant obligatoirement l'id)
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

Annonce_DB + files(base64 ou URL absolues ou URL inchangées) + catsids

Example

json

{
    "ann_id": 40,
    "ann_type_bien_id": 30,
    "ann_type_annonce_id": 2,
    "ann_photos": [
        {
            "file": "data:image/[webp|jpeg|gif|png];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de l'image",
            "class": "my class",
            "title": "Mon titre"
        },
        {
            "file": "//static.azko.fr/medias/shared/ann-1500284339596c85b3a5302718100649.jpg",
            "class": "my class",
            "title": "Mon titre"
        }
    ],
    "ann_pieces_jointes": [
        {
            "file": "//static.azko.fr/medias/shared/ann-1500284340596c85b425b13060062050.pdf",
            "txt": "Un fichier PDF",
            "title": "Mon titre",
            "target": "_blank",
            "class": "myClass"
        },
        {
            "file": "data:application/[extension];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de la pièce jointe",
            "txt": "Un fichier PDF",
            "title": "Mon titre",
            "target": "_blank",
            "class": "myClass"
        }
    ],
    "ann_pub_date": "2017-05-12 12:03:51",
    "ann_pubfin_date": null,
    "ann_actif": 1,
    "ann_focus": 0,
    "ann_crea_date": "2017-07-17 11:39:00",
    "ann_crea_user_id": 1,
    "ann_modif_date": "2017-07-17 12:04:38",
    "ann_modif_user_id": 1,
    "aSitesIds": [
        7
    ]
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

Annonce_DB

Annonce créée ou modifiée

Annonce_DB

Propriété	Type	Type SQL / Infos
ann_id	int	int(11)
ann_titre	string	varchar(255)
ann_ref	string	varchar(255)
ann_type_bien_id	int	int(11)
ann_type_annonce_id	int	int(11)
ann_adresse_1	string	varchar(255)
ann_adresse_2	string	varchar(255)
ann_ville	string	varchar(255)
ann_cp	string	varchar(10)
ann_prix	string	decimal(10,2)
ann_prix_hors_honoraires	string	decimal(10,2)
ann_baisse_prix	int	int(1)
ann_desc	string	text
ann_nb_pieces	int	int(11)
ann_nb_chambres	int	int(11)
ann_nb_personnes	int	int(11)
ann_nb_couchages	int	int(11)
ann_surface	string	decimal(10,2)
ann_surface_terrain	string	decimal(10,2)
ann_dpe	int	int(11)
ann_dpe_classe	string	varchar(1) optionnel
ann_ges	int	int(11)
ann_ges_classe	string	varchar(1) optionnel
ann_cout_annuel_energie_min	string	decimal(10,2)
ann_cout_annuel_energie_max	string	decimal(10,2)
ann_annee_ref_energie	string	varchar(4)
ann_dpe_date_realisation	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_dpe_zone_climatique	int	int(1) bool
ann_photos	string	text JSON [{"file": "...","class": "...","title": "..."}]
ann_pieces_jointes	string	text JSON [{"file": "...","txt": "...","title": "...","target": "...","class": "..."}]
ann_pub_date	string	datetime
ann_pubfin_date	string	datetime
ann_ncis_etude_id	int	int(11)
ann_pays	string	varchar(255)
ann_honoraires	string	decimal(10,2)
ann_date_dispo	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_charges	int	int(11)
ann_etage	int	int(11)
ann_nb_etages	int	int(11)
ann_meuble	int	int(1) bool
ann_annee_construction	int	int(4)
ann_etat	int	int(11)
ann_nb_sdb	int	int(11)
ann_nb_sde	int	int(11)
ann_nb_wc	int	int(11)
ann_type_chauffage	int	int(11) - bitfield
ann_nb_terrasses	int	int(11)
ann_surface_terrasse	string	decimal(10,2)
ann_nb_balcons	int	int(11)
ann_ascenseur	int	int(1) bool
ann_cave	int	int(1) bool
ann_nb_parkings	int	int(11)
ann_nb_boxes	int	int(11)
ann_digicode	int	int(1) bool
ann_interphone	int	int(1) bool
ann_terrasse	int	int(1) bool
ann_situation	int	int(11)
ann_alarme	int	int(1) bool
ann_clim	int	int(1) bool
ann_piscine	int	int(1) bool
ann_cheminee	int	int(1) bool
ann_duplex	int	int(1) bool
ann_mandat_exclusif	int	int(1) bool
ann_coup_coeur	int	int(1) bool
ann_visite_virtuelle	string	varchar(255)
ann_visite_virtuelle_360	string	varchar(255)
ann_num_mandat	string	varchar(255)
ann_date_mandat	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_negociateur_nom	string	varchar(255)
ann_mandataire_nom	string	varchar(255)
ann_mandataire_mail	string	varchar(255)
ann_mandataire_tel	string	varchar(255)
ann_honoraires_visite_dossier_bail_locataire	string	decimal(10,2)
ann_honoraires_etat_lieux_locataire	string	decimal(10,2)
ann_depot_garantie	string	decimal(10,2)
ann_travaux_a_prevoir	int	int(1) bool
ann_ncis_bien_id	int	int(11)
ann_netty_etude_id	int	int(11)
ann_netty_bien_id	string	varchar(10)
ann_immo_notaires_id	int	int(11)
ann_noty_id	string	varchar(255)
ann_immonot_id	string	varchar(255)
ann_crpcen_etude_proprietaire	string	varchar(10)
ann_sous_type_bien	string	text
ann_viager_prix_bouquet	string	decimal(10,2)
ann_viager_rente_mensuelle	string	decimal(10,2) Utiliser "ann_viager_rente_montant" et "ann_viager_rente_periodicite" à la place
ann_viager_rente_montant	string	decimal(10,2)
ann_viager_rente_periodicite	int	int(11) - 0=aucune, 1=mensuelle, 2=bimensuelle, 3=trimestrielle, 4=semestrielle, 5=annuelle
ann_interactive_systeme_enchere	int	int(11) - 0=non defini, 1=ascendante, 2=descendante, voir constantes SYSTEME_ENCHERES_XXX
ann_interactive_pas_offre	string	decimal(10,2) - montant du pas de l'offre
ann_interactive_date_fin	string	datetime - fin de l'offre
ann_duree_bail	string	varchar(255)
ann_quai	int	int(1) bool
ann_nb_bureaux	int	int(11)
ann_terrain_agricole	int	int(1) bool
ann_terrain_constructible	int	int(1) bool
ann_frais_poursuites	string	decimal(10,2)
ann_honoraires_vendeur	int	int(1) bool
ann_honoraires_pourcentage_ttc	string	decimal(10,2)
ann_copropriete	int	int(1) bool
ann_nb_lots	int	int(11)
ann_charges_annuelles	string	decimal(10,2)
ann_syndic_prodecure	int	int(1) bool
ann_syndic_prodecure_details	string	varchar(255)
ann_exposition	string	varchar(2) N, S, E, O, NE, SE, NO, SO
ann_acces_pmr	int	int(1) bool
ann_situation_locative_loue	int\|null	int(1) bool
ann_cuisine	int	int(1) bool
ann_actif	int	int(11)
ann_focus	int	int(11)
ann_crea_date	string	datetime
ann_crea_user_id	int	int(11)
ann_modif_date	string	datetime
ann_modif_user_id	int	int(11)
ann_nature_regularisation	int	int(11)
ann_type_affichage_prix	int	int(11)
ann_url_bareme_honoraire	string	varchar (255)
ann_params	string	text JSON
ann_script	string	text
ann_statut_vente	int	int(11)
ann_ench_id	int	int(11)
ann_ench_lieu_id	int	int(11)
ann_ench_date_vente	string	datetime
ann_ench_date_visite	string	datetime\|JSON
ann_ench_desc	string	text
ann_ench_show_calcul_frais	int	int(1)
ann_ench_adjuge	int	int(1)
ann_ench_adjuge_montant	string	decimal(10,2)
ann_ench_vendu	int	int(1)
ann_ench_vendu_montant	string	decimal(10,2)
ann_ench_surenchere	int	int(1)
ann_ench_surenchere_date	string	datetime
ann_ench_surenchere_max_date	string	datetime
ann_ench_surenchere_montant	string	decimal(10,2)
ann_ench_report	int	int(1)
ann_ench_report_date	string	datetime
ann_ench_desertion	int	int(1)
ann_ench_annule	int	int(1)
ann_georisque	int	int(1)
ann_animaux_acceptes	int	int(1)
ann_tv	int	int(1)
ann_linge_lit	int	int(1)
ann_terrasse_couverte	int	int(1)
ann_jacuzzi	int	int(1)
ann_bouilloire	int	int(1)
ann_machine_cafe	int	int(1)
ann_micro_ondes	int	int(1)
ann_refrigerateur	int	int(1)
ann_cuisine_equipee	int	int(1)
ann_tables_chaises	int	int(1)
ann_sdb	int	int(1)
ann_linge_bain	int	int(1)
ann_wc_separe	int	int(1)
ann_seche_serviette	int	int(1)
ann_coin_repas	int	int(1)
ann_canape_convertible	int	int(1)
ann_canape	int	int(1)
ann_sanitaire_proximite	int	int(1)
ann_branchement_electrique	int	int(1)
ann_eau	int	int(1)
ann_emplacement_ombrage	int	int(1)
ann_tente	int	int(1)
ann_camping_car	int	int(1)
ann_caravane	int	int(1)
ann_meta_title	string	varchar(255) - par défaut valeur vide
ann_meta_desc	string	varchar(255) - par défaut valeur vide
ann_meta_keywords	string	varchar(255) - par défaut valeur vide
ann_url_canonical	string	varchar(2000)
aSitesIds	array	Liste des IDs de sites auxquels est rattachée cette annonce

/annonces/ncis/:id-ncis PUT

Enregistre (créé ou modifie) une annonce NCIS (en précisant obligatoirement l'id "NCIS")
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

Annonce_DB + files(base64 ou URL absolues ou URL inchangées) + catsids

Example

json

{
    "ann_id": null,
    "ann_ncis_bien_id": 412,
    "ann_type_bien_id": 30,
    "ann_type_annonce_id": 2,
    "ann_photos": [
        {
            "file": "data:image/[webp|jpeg|gif|png];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de l'image",
            "class": "my class",
            "title": "Mon titre"
        },
        {
            "file": "//static.azko.fr/medias/shared/ann-1500284339596c85b3a5302718100649.jpg",
            "class": "my class",
            "title": "Mon titre"
        }
    ],
    "ann_pieces_jointes": [
        {
            "file": "//static.azko.fr/medias/shared/ann-1500284340596c85b425b13060062050.pdf",
            "txt": "Un fichier PDF",
            "title": "Mon titre",
            "target": "_blank",
            "class": "myClass"
        },
        {
            "file": "data:application/[extension];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de la piece jointe",
            "txt": "Un fichier PDF",
            "title": "Mon titre",
            "target": "_blank",
            "class": "myClass"
        }
    ],
    "ann_pub_date": "2017-05-12 12:03:51",
    "ann_pubfin_date": null,
    "ann_actif": 1,
    "ann_focus": 0,
    "ann_crea_date": "2017-07-17 11:39:00",
    "ann_crea_user_id": 1,
    "ann_modif_date": "2017-07-17 12:04:38",
    "ann_modif_user_id": 1,
    "aSitesIds": [
        7
    ]
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

Annonce_DB

annonce

Annonce_DB

Propriété	Type	Type SQL / Infos
ann_id	int	int(11)
ann_titre	string	varchar(255)
ann_ref	string	varchar(255)
ann_type_bien_id	int	int(11)
ann_type_annonce_id	int	int(11)
ann_adresse_1	string	varchar(255)
ann_adresse_2	string	varchar(255)
ann_ville	string	varchar(255)
ann_cp	string	varchar(10)
ann_prix	string	decimal(10,2)
ann_prix_hors_honoraires	string	decimal(10,2)
ann_baisse_prix	int	int(1)
ann_desc	string	text
ann_nb_pieces	int	int(11)
ann_nb_chambres	int	int(11)
ann_nb_personnes	int	int(11)
ann_nb_couchages	int	int(11)
ann_surface	string	decimal(10,2)
ann_surface_terrain	string	decimal(10,2)
ann_dpe	int	int(11)
ann_dpe_classe	string	varchar(1) optionnel
ann_ges	int	int(11)
ann_ges_classe	string	varchar(1) optionnel
ann_cout_annuel_energie_min	string	decimal(10,2)
ann_cout_annuel_energie_max	string	decimal(10,2)
ann_annee_ref_energie	string	varchar(4)
ann_dpe_date_realisation	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_dpe_zone_climatique	int	int(1) bool
ann_photos	string	text JSON [{"file": "...","class": "...","title": "..."}]
ann_pieces_jointes	string	text JSON [{"file": "...","txt": "...","title": "...","target": "...","class": "..."}]
ann_pub_date	string	datetime
ann_pubfin_date	string	datetime
ann_ncis_etude_id	int	int(11)
ann_pays	string	varchar(255)
ann_honoraires	string	decimal(10,2)
ann_date_dispo	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_charges	int	int(11)
ann_etage	int	int(11)
ann_nb_etages	int	int(11)
ann_meuble	int	int(1) bool
ann_annee_construction	int	int(4)
ann_etat	int	int(11)
ann_nb_sdb	int	int(11)
ann_nb_sde	int	int(11)
ann_nb_wc	int	int(11)
ann_type_chauffage	int	int(11) - bitfield
ann_nb_terrasses	int	int(11)
ann_surface_terrasse	string	decimal(10,2)
ann_nb_balcons	int	int(11)
ann_ascenseur	int	int(1) bool
ann_cave	int	int(1) bool
ann_nb_parkings	int	int(11)
ann_nb_boxes	int	int(11)
ann_digicode	int	int(1) bool
ann_interphone	int	int(1) bool
ann_terrasse	int	int(1) bool
ann_situation	int	int(11)
ann_alarme	int	int(1) bool
ann_clim	int	int(1) bool
ann_piscine	int	int(1) bool
ann_cheminee	int	int(1) bool
ann_duplex	int	int(1) bool
ann_mandat_exclusif	int	int(1) bool
ann_coup_coeur	int	int(1) bool
ann_visite_virtuelle	string	varchar(255)
ann_visite_virtuelle_360	string	varchar(255)
ann_num_mandat	string	varchar(255)
ann_date_mandat	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_negociateur_nom	string	varchar(255)
ann_mandataire_nom	string	varchar(255)
ann_mandataire_mail	string	varchar(255)
ann_mandataire_tel	string	varchar(255)
ann_honoraires_visite_dossier_bail_locataire	string	decimal(10,2)
ann_honoraires_etat_lieux_locataire	string	decimal(10,2)
ann_depot_garantie	string	decimal(10,2)
ann_travaux_a_prevoir	int	int(1) bool
ann_ncis_bien_id	int	int(11)
ann_netty_etude_id	int	int(11)
ann_netty_bien_id	string	varchar(10)
ann_immo_notaires_id	int	int(11)
ann_noty_id	string	varchar(255)
ann_immonot_id	string	varchar(255)
ann_crpcen_etude_proprietaire	string	varchar(10)
ann_sous_type_bien	string	text
ann_viager_prix_bouquet	string	decimal(10,2)
ann_viager_rente_mensuelle	string	decimal(10,2) Utiliser "ann_viager_rente_montant" et "ann_viager_rente_periodicite" à la place
ann_viager_rente_montant	string	decimal(10,2)
ann_viager_rente_periodicite	int	int(11) - 0=aucune, 1=mensuelle, 2=bimensuelle, 3=trimestrielle, 4=semestrielle, 5=annuelle
ann_interactive_systeme_enchere	int	int(11) - 0=non defini, 1=ascendante, 2=descendante, voir constantes SYSTEME_ENCHERES_XXX
ann_interactive_pas_offre	string	decimal(10,2) - montant du pas de l'offre
ann_interactive_date_fin	string	datetime - fin de l'offre
ann_duree_bail	string	varchar(255)
ann_quai	int	int(1) bool
ann_nb_bureaux	int	int(11)
ann_terrain_agricole	int	int(1) bool
ann_terrain_constructible	int	int(1) bool
ann_frais_poursuites	string	decimal(10,2)
ann_honoraires_vendeur	int	int(1) bool
ann_honoraires_pourcentage_ttc	string	decimal(10,2)
ann_copropriete	int	int(1) bool
ann_nb_lots	int	int(11)
ann_charges_annuelles	string	decimal(10,2)
ann_syndic_prodecure	int	int(1) bool
ann_syndic_prodecure_details	string	varchar(255)
ann_exposition	string	varchar(2) N, S, E, O, NE, SE, NO, SO
ann_acces_pmr	int	int(1) bool
ann_situation_locative_loue	int\|null	int(1) bool
ann_cuisine	int	int(1) bool
ann_actif	int	int(11)
ann_focus	int	int(11)
ann_crea_date	string	datetime
ann_crea_user_id	int	int(11)
ann_modif_date	string	datetime
ann_modif_user_id	int	int(11)
ann_nature_regularisation	int	int(11)
ann_type_affichage_prix	int	int(11)
ann_url_bareme_honoraire	string	varchar (255)
ann_params	string	text JSON
ann_script	string	text
ann_statut_vente	int	int(11)
ann_ench_id	int	int(11)
ann_ench_lieu_id	int	int(11)
ann_ench_date_vente	string	datetime
ann_ench_date_visite	string	datetime\|JSON
ann_ench_desc	string	text
ann_ench_show_calcul_frais	int	int(1)
ann_ench_adjuge	int	int(1)
ann_ench_adjuge_montant	string	decimal(10,2)
ann_ench_vendu	int	int(1)
ann_ench_vendu_montant	string	decimal(10,2)
ann_ench_surenchere	int	int(1)
ann_ench_surenchere_date	string	datetime
ann_ench_surenchere_max_date	string	datetime
ann_ench_surenchere_montant	string	decimal(10,2)
ann_ench_report	int	int(1)
ann_ench_report_date	string	datetime
ann_ench_desertion	int	int(1)
ann_ench_annule	int	int(1)
ann_georisque	int	int(1)
ann_animaux_acceptes	int	int(1)
ann_tv	int	int(1)
ann_linge_lit	int	int(1)
ann_terrasse_couverte	int	int(1)
ann_jacuzzi	int	int(1)
ann_bouilloire	int	int(1)
ann_machine_cafe	int	int(1)
ann_micro_ondes	int	int(1)
ann_refrigerateur	int	int(1)
ann_cuisine_equipee	int	int(1)
ann_tables_chaises	int	int(1)
ann_sdb	int	int(1)
ann_linge_bain	int	int(1)
ann_wc_separe	int	int(1)
ann_seche_serviette	int	int(1)
ann_coin_repas	int	int(1)
ann_canape_convertible	int	int(1)
ann_canape	int	int(1)
ann_sanitaire_proximite	int	int(1)
ann_branchement_electrique	int	int(1)
ann_eau	int	int(1)
ann_emplacement_ombrage	int	int(1)
ann_tente	int	int(1)
ann_camping_car	int	int(1)
ann_caravane	int	int(1)
ann_meta_title	string	varchar(255) - par défaut valeur vide
ann_meta_desc	string	varchar(255) - par défaut valeur vide
ann_meta_keywords	string	varchar(255) - par défaut valeur vide
ann_url_canonical	string	varchar(2000)
aSitesIds	array	Liste des IDs de sites auxquels est rattachée cette annonce

/annonces/netty/:id-netty PUT

Enregistre (créé ou modifie) une annonce NETTY (en précisant obligatoirement l'id "NETTY")
Détails

Param

int

workingOrgId (default = 0) Modifie l'ORGA sur laquelle on travaille. Réservé aux SUPER-ADMIN.

Request body

json

Annonce_DB + files(base64 ou URL absolues ou URL inchangées) + catsids

Example

json

{ "ann_id": null, "ann_netty_bien_id":AZ 412, "ann_type_bien_id": 30, "ann_type_annonce_id": 2, "ann_photos": [ { "file": "data:image/[webp|jpeg|gif|png];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de l'image", "class": "my class", "title": "Mon titre" }, { "file": "//static.azko.fr/medias/shared/ann-1500284339596c85b3a5302718100649.jpg", "class": "my class", "title": "Mon titre" } ], "ann_pieces_jointes": [ { "file": "//static.azko.fr/medias/shared/ann-1500284340596c85b425b13060062050.pdf", "txt": "Un fichier PDF", "title": "Mon titre", "target": "_blank", "class": "myClass" }, { "file": "data:application/[extension];base64,[BASE64_ENCODED_FILE_CONTENT] ... ou URL absolue de la piece jointe", "txt": "Un fichier PDF", "title": "Mon titre", "target": "_blank", "class": "myClass" } ], "ann_pub_date": "2017-05-12 12:03:51", "ann_pubfin_date": null, "ann_actif": 1, "ann_focus": 0, "ann_crea_date": "2017-07-17 11:39:00", "ann_crea_user_id": 1, "ann_modif_date": "2017-07-17 12:04:38", "ann_modif_user_id": 1, "aSitesIds": [7] }

Api-Return

json

{
    "output": {
        "success": 1,
        "response": {
            "...": "..."
        }
    }
}

Return (response)

Annonce_DB

annonce

Annonce_DB

Propriété	Type	Type SQL / Infos
ann_id	int	int(11)
ann_titre	string	varchar(255)
ann_ref	string	varchar(255)
ann_type_bien_id	int	int(11)
ann_type_annonce_id	int	int(11)
ann_adresse_1	string	varchar(255)
ann_adresse_2	string	varchar(255)
ann_ville	string	varchar(255)
ann_cp	string	varchar(10)
ann_prix	string	decimal(10,2)
ann_prix_hors_honoraires	string	decimal(10,2)
ann_baisse_prix	int	int(1)
ann_desc	string	text
ann_nb_pieces	int	int(11)
ann_nb_chambres	int	int(11)
ann_nb_personnes	int	int(11)
ann_nb_couchages	int	int(11)
ann_surface	string	decimal(10,2)
ann_surface_terrain	string	decimal(10,2)
ann_dpe	int	int(11)
ann_dpe_classe	string	varchar(1) optionnel
ann_ges	int	int(11)
ann_ges_classe	string	varchar(1) optionnel
ann_cout_annuel_energie_min	string	decimal(10,2)
ann_cout_annuel_energie_max	string	decimal(10,2)
ann_annee_ref_energie	string	varchar(4)
ann_dpe_date_realisation	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_dpe_zone_climatique	int	int(1) bool
ann_photos	string	text JSON [{"file": "...","class": "...","title": "..."}]
ann_pieces_jointes	string	text JSON [{"file": "...","txt": "...","title": "...","target": "...","class": "..."}]
ann_pub_date	string	datetime
ann_pubfin_date	string	datetime
ann_ncis_etude_id	int	int(11)
ann_pays	string	varchar(255)
ann_honoraires	string	decimal(10,2)
ann_date_dispo	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_charges	int	int(11)
ann_etage	int	int(11)
ann_nb_etages	int	int(11)
ann_meuble	int	int(1) bool
ann_annee_construction	int	int(4)
ann_etat	int	int(11)
ann_nb_sdb	int	int(11)
ann_nb_sde	int	int(11)
ann_nb_wc	int	int(11)
ann_type_chauffage	int	int(11) - bitfield
ann_nb_terrasses	int	int(11)
ann_surface_terrasse	string	decimal(10,2)
ann_nb_balcons	int	int(11)
ann_ascenseur	int	int(1) bool
ann_cave	int	int(1) bool
ann_nb_parkings	int	int(11)
ann_nb_boxes	int	int(11)
ann_digicode	int	int(1) bool
ann_interphone	int	int(1) bool
ann_terrasse	int	int(1) bool
ann_situation	int	int(11)
ann_alarme	int	int(1) bool
ann_clim	int	int(1) bool
ann_piscine	int	int(1) bool
ann_cheminee	int	int(1) bool
ann_duplex	int	int(1) bool
ann_mandat_exclusif	int	int(1) bool
ann_coup_coeur	int	int(1) bool
ann_visite_virtuelle	string	varchar(255)
ann_visite_virtuelle_360	string	varchar(255)
ann_num_mandat	string	varchar(255)
ann_date_mandat	string	datetime(yyyy-mm-dd hh:mm:ss)
ann_negociateur_nom	string	varchar(255)
ann_mandataire_nom	string	varchar(255)
ann_mandataire_mail	string	varchar(255)
ann_mandataire_tel	string	varchar(255)
ann_honoraires_visite_dossier_bail_locataire	string	decimal(10,2)
ann_honoraires_etat_lieux_locataire	string	decimal(10,2)
ann_depot_garantie	string	decimal(10,2)
ann_travaux_a_prevoir	int	int(1) bool
ann_ncis_bien_id	int	int(11)
ann_netty_etude_id	int	int(11)
ann_netty_bien_id	string	varchar(10)
ann_immo_notaires_id	int	int(11)
ann_noty_id	string	varchar(255)
ann_immonot_id	string	varchar(255)
ann_crpcen_etude_proprietaire	string	varchar(10)
ann_sous_type_bien	string	text
ann_viager_prix_bouquet	string	decimal(10,2)
ann_viager_rente_mensuelle	string	decimal(10,2) Utiliser "ann_viager_rente_montant" et "ann_viager_rente_periodicite" à la place
ann_viager_rente_montant	string	decimal(10,2)
ann_viager_rente_periodicite	int	int(11) - 0=aucune, 1=mensuelle, 2=bimensuelle, 3=trimestrielle, 4=semestrielle, 5=annuelle
ann_interactive_systeme_enchere	int	int(11) - 0=non defini, 1=ascendante, 2=descendante, voir constantes SYSTEME_ENCHERES_XXX
ann_interactive_pas_offre	string	decimal(10,2) - montant du pas de l'offre
ann_interactive_date_fin	string	datetime - fin de l'offre
ann_duree_bail	string	varchar(255)
ann_quai	int	int(1) bool
ann_nb_bureaux	int	int(11)
ann_terrain_agricole	int	int(1) bool
ann_terrain_constructible	int	int(1) bool
ann_frais_poursuites	string	decimal(10,2)
ann_honoraires_vendeur	int	int(1) bool
ann_honoraires_pourcentage_ttc	string	decimal(10,2)
ann_copropriete	int	int(1) bool
ann_nb_lots	int	int(11)
ann_charges_annuelles	string	decimal(10,2)
ann_syndic_prodecure	int	int(1) bool
ann_syndic_prodecure_details	string	varchar(255)
ann_exposition	string	varchar(2) N, S, E, O, NE, SE, NO, SO
ann_acces_pmr	int	int(1) bool
ann_situation_locative_loue	int\|null	int(1) bool
ann_cuisine	int	int(1) bool
ann_actif	int	int(11)
ann_focus	int	int(11)
ann_crea_date	string	datetime
ann_crea_user_id	int	int(11)
ann_modif_date	string	datetime
ann_modif_user_id	int	int(11)
ann_nature_regularisation	int	int(11)
ann_type_affichage_prix	int	int(11)
ann_url_bareme_honoraire	string	varchar (255)
ann_params	string	text JSON
ann_script	string	text
ann_statut_vente	int	int(11)
ann_ench_id	int	int(11)
ann_ench_lieu_id	int	int(11)
ann_ench_date_vente	string	datetime
ann_ench_date_visite	string	datetime\|JSON
ann_ench_desc	string	text
ann_ench_show_calcul_frais	int	int(1)
ann_ench_adjuge	int	int(1)
ann_ench_adjuge_montant	string	decimal(10,2)
ann_ench_vendu	int	int(1)
ann_ench_vendu_montant	string	decimal(10,2)
ann_ench_surenchere	int	int(1)
ann_ench_surenchere_date	string	datetime
ann_ench_surenchere_max_date	string	datetime
ann_ench_surenchere_montant	string	decimal(10,2)
ann_ench_report	int	int(1)
ann_ench_report_date	string	datetime
ann_ench_desertion	int	int(1)
ann_ench_annule	int	int(1)
ann_georisque	int	int(1)
ann_animaux_acceptes	int	int(1)
ann_tv	int	int(1)
ann_linge_lit	int	int(1)
ann_terrasse_couverte	int	int(1)
ann_jacuzzi	int	int(1)
ann_bouilloire	int	int(1)
ann_machine_cafe	int	int(1)
ann_micro_ondes	int	int(1)
ann_refrigerateur	int	int(1)
ann_cuisine_equipee	int	int(1)
ann_tables_chaises	int	int(1)
ann_sdb	int	int(1)
ann_linge_bain	int	int(1)
ann_wc_separe	int	int(1)
ann_seche_serviette	int	int(1)
ann_coin_repas	int	int(1)
ann_canape_convertible	int	int(1)
ann_canape	int	int(1)
ann_sanitaire_proximite	int	int(1)
ann_branchement_electrique	int	int(1)
ann_eau	int	int(1)
ann_emplacement_ombrage	int	int(1)
ann_tente	int	int(1)
ann_camping_car	int	int(1)
ann_caravane	int	int(1)
ann_meta_title	string	varchar(255) - par défaut valeur vide
ann_meta_desc	string	varchar(255) - par défaut valeur vide
ann_meta_keywords	string	varchar(255) - par défaut valeur vide
ann_url_canonical	string	varchar(2000)
aSitesIds	array	Liste des IDs de sites auxquels est rattachée cette annonce

/annonces/:id DELETE

Supprime une annonce
Détails

/annonces/ncis/:id-ncis DELETE

Supprime une annonce NCIS
Détails

/annonces/netty/:id-netty DELETE

Supprime une annonce NETTY
Détails

/annonces/typesannonces GET

Retourne la liste des types d'annonces
Détails

/annonces/types GET

Retourne la liste des types de biens
Détails

/annonces/soustypes GET

Retourne la liste des sous types de biens
Détails

/annonces/lieuxVente GET

Retourne la liste des lieux de ventes pouvant être sélectionnés dans le cadre d'une enchère de biens
Détails

Param

bool

onlyactifs (default = true)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

AnnonceLieuVente_DB[]

Liste des lieux de ventes

AnnonceLieuVente_DB

Propriété	Type	Type SQL / Infos
lieu_id	int	int(11)
lieu_nom	string	varchar(255)
lieu_adresse_1	string	varchar(255)
lieu_adresse_2	string	varchar(255)
lieu_ville	string	varchar(255)
lieu_cp	string	varchar(10)
lieu_tel	string	varchar(255)
lieu_fax	string	varchar(255)
lieu_actif	int	int(1)
lieu_crea_date	string	datetime
lieu_crea_user_id	int	int(11)
lieu_modif_date	string	datetime
lieu_modif_user_id	int	int(11)

/stats (12)

GET /stats/contacts[/:siteid]

GET /stats/biens

GET /stats/articles

GET /stats/paiements

GET /stats/encaissements[/:siteid]

GET /stats/analyticsDaily/:siteurl

GET /stats/analytics/:siteurl

GET /stats/myPoseo/:siteurl

GET /stats/myPoseoDaily/:siteurl

GET /stats/socialResume

GET /stats/facebook/:accountName

GET /stats/twitter/:accountName

/stats/contacts[/:siteid] GET

Retourne les stats de nb de contacts par mois ou par jour
Par mois le retour correspond au premier apireturn (soit le fonctionnement par défaut)
Par jour le retour correspond au deuxième apireturn
Détails

Param	string	mode (default = null) granularité des stats (par défaut vide = par mois, byDay = par jour)
Param	string	begindate (default = null) Date de début (format yyyy-mm-dd) \| uniquement valable si mode = days
Param	string	enddate (default = null) Date de fin (format yyyy-mm-dd) \| uniquement valable si mode = days
Api-Return	json	{ "output": { "success": 1, "response": [ { "201405": 15, "201406": 10, "...": "..." } ] } }
Api-Return	json	{ "output": { "success": 1, "response": [ { "dcPubDate": "2015-05-01", "dcNb": 5 }, { "dcPubDate": "2015-05-02", "dcNb": 3 } ] } }
Return (response)	array	Liste de stats

/stats/biens GET

Retourne les stats de nb de biens par jour pour un intervalle de temps donnés
Détails

/stats/articles GET

Retourne les stats de nb d'articles publiés par jour pour un intervalle de temps donnés
Détails

Param	string	begindate (default = null) Date de début (format yyyy-mm-dd)
Param	string	enddate (default = null) Date de fin (format yyyy-mm-dd)
Param	int	siteid (default = 0) Site concerné
Param	bool	onlyactifs (default = true)
Param	bool	onlypublished (default = true)
Param	bool	onlywaitingvalidation (default = false) - si passé à true, onlyactifs, onlypublished sont forcés à false et validationstatus à null
Param	int	validationstatus (default = null) - si passé à 1 alors renvoie les articles valides, si passé à 0 alors renvoie les articles refusés
Param	bool	onlycuration (default = false) - Permet de ne récupérer que les articles de curation
Param	int	typedateselection (default = 0) : permet de choisir si la sélection se fait sur la date de publication (valeur 0) ou sur la date de validation/refus (valeur 1)
Api-Return	json	{ "output": { "success": 1, "response": [ { "artPubDate": "2015-05-01", "artNb": 5 }, { "artPubDate": "2015-05-02", "artNb": 3 }, { "...": "..." } ] } }
Return (response)	array	Liste de stats

/stats/paiements GET

Retourne les stats du nombre de paiements par jour avec leur somme journalière pour un statut donné
Détails

/stats/encaissements[/:siteid] GET

Retourne les stats de nb d'encaissements par mois, le total et la moyenne
Détails

/stats/analyticsDaily/:siteurl GET

Retourne les stats Google Analytics par jour d'un site sur une plage de dates
Détails

/stats/analytics/:siteurl GET

Retourne les stats Google Analytics sur 1 année glissante
Détails

/stats/myPoseo/:siteurl GET

Retourne les stats de MyPoseoWs
Détails

/stats/myPoseoDaily/:siteurl GET

Retourne les stats de MyPoseoWs sur une plage de dates
Détails

/stats/socialResume GET

Retourne un résumé des stats de Twitter et Facebook de tous les comptes de l'organisation courante
Détails

/stats/facebook/:accountName GET

Retourne les stats de Facebook
Détails

/stats/twitter/:accountName GET

Retourne les stats de Twitter
Détails

/infosMobiles (1)

GET /infosMobiles[/:id][/:id]...

/infosMobiles[/:id][/:id]... GET

Retourne une ou des info(s) mobile(s) - (Articles de AZKO pour les clients APPLICATION MOBILE)
Détails

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Param

bool

onlyactifs (default = true)

Param

bool

onlypublished (default = true)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

BlogArticle_DB[]

Liste d'articles

BlogArticle_DB

Propriété	Type	Type SQL / Infos
art_id	int	int(11) unsigned
art_token	string	varchar(255) - Pour sécuriser le lien de validation de l'article
art_preview_token	string	varchar(255)
art_preview_token_date	string	datetime
art_titre	string	varchar(255)
art_texte	string	text
art_temps_lecture	int	int(11) unsigned 0 -> temps de lecture en minutes
art_url_perso	string	text
art_meta_title	string	text
art_meta_desc	string	text
art_meta_keywords	string	text
art_url_canonical	string	varchar(2000)
art_image	string	varchar(255)
art_lien_ext	string	varchar(255)
art_guid	string	varchar(255)
art_mentions_auteur	string	varchar(255)
art_focus	int	int(1) unsigned 0
art_disp_rss	int	int(1) unsigned 0
art_params	string	text JSON
art_actif	int	int(1) unsigned 0
art_validation_client	int	int(1) default null - NULL=En attente validation, 0=Refusé, 1=Validé, 2=Pas de validation en attente
art_validation_client_date	string	datetime - default null - Date de la validation/refus, en fonction de art_validation_client
art_motif_refus	string	varchar(255) - Si refus lors de la validation client, indication du motif
art_captcha	string	varchar(10) - Utile pour les articles soumis à validation (petites annonces)
art_pub_date	string	datetime
art_pubfin_date	string	datetime - date de fin de publication, optionnel
art_debut_date	string	datetime - date de début si c'est un événement, optionnel
art_fin_date	string	datetime - date de fin si c'est un événement, optionnel
art_rss_pub_date	string	datetime - si c'est un article issu de la curation, indique la date de publication telle que récupérée dans le flux
art_pj_archived_crons_last_update	string	datetime - date du dernier passage du CRON d'archivage/désarchivage des PJs/Images
art_crea_date	string	datetime
art_crea_user_id	int	int(11) unsigned 0
art_modif_date	string	datetime
art_modif_user_id	int	int(11) unsigned 0
aSitesIds	array	Liste des IDs des sites auxquels est rattaché cet article
aCatsIds	array	Liste des IDs des catégories auxquelles est rattaché cet article
aEpUsersIds	array	Liste des IDs d'EP-USERS auxquels est rattaché cet article

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/infosMobilesTest (1)

GET /infosMobilesTest[/:id][/:id]...

/infosMobilesTest[/:id][/:id]... GET

Retourne une ou des info(s) mobile(s) - (Articles de AZKO pour les clients APPLICATION MOBILE)
Détails

Param

int

pagenum (default = 1)

Param

int

nbparpage (default = 30)

Param

bool

onlyactifs (default = true)

Param

bool

onlypublished (default = true)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

BlogArticle_DB[]

Liste d'articles

BlogArticle_DB

Propriété	Type	Type SQL / Infos
art_id	int	int(11) unsigned
art_token	string	varchar(255) - Pour sécuriser le lien de validation de l'article
art_preview_token	string	varchar(255)
art_preview_token_date	string	datetime
art_titre	string	varchar(255)
art_texte	string	text
art_temps_lecture	int	int(11) unsigned 0 -> temps de lecture en minutes
art_url_perso	string	text
art_meta_title	string	text
art_meta_desc	string	text
art_meta_keywords	string	text
art_url_canonical	string	varchar(2000)
art_image	string	varchar(255)
art_lien_ext	string	varchar(255)
art_guid	string	varchar(255)
art_mentions_auteur	string	varchar(255)
art_focus	int	int(1) unsigned 0
art_disp_rss	int	int(1) unsigned 0
art_params	string	text JSON
art_actif	int	int(1) unsigned 0
art_validation_client	int	int(1) default null - NULL=En attente validation, 0=Refusé, 1=Validé, 2=Pas de validation en attente
art_validation_client_date	string	datetime - default null - Date de la validation/refus, en fonction de art_validation_client
art_motif_refus	string	varchar(255) - Si refus lors de la validation client, indication du motif
art_captcha	string	varchar(10) - Utile pour les articles soumis à validation (petites annonces)
art_pub_date	string	datetime
art_pubfin_date	string	datetime - date de fin de publication, optionnel
art_debut_date	string	datetime - date de début si c'est un événement, optionnel
art_fin_date	string	datetime - date de fin si c'est un événement, optionnel
art_rss_pub_date	string	datetime - si c'est un article issu de la curation, indique la date de publication telle que récupérée dans le flux
art_pj_archived_crons_last_update	string	datetime - date du dernier passage du CRON d'archivage/désarchivage des PJs/Images
art_crea_date	string	datetime
art_crea_user_id	int	int(11) unsigned 0
art_modif_date	string	datetime
art_modif_user_id	int	int(11) unsigned 0
aSitesIds	array	Liste des IDs des sites auxquels est rattaché cet article
aCatsIds	array	Liste des IDs des catégories auxquelles est rattaché cet article
aEpUsersIds	array	Liste des IDs d'EP-USERS auxquels est rattaché cet article

Multipage

headers

multipage_page
multipage_count
multipage_prev
multipage_next

/devicePushs (3)

GET /devicePushs

POST /devicePushs

DELETE /devicePushs

/devicePushs GET

Retourne un ou des devicePush(s) du token courant
Détails

Param

string

pushId (optionnel)

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

PushDevice_DB[]

Liste de devicePush

PushDevice_DB

Propriété	Type	Type SQL / Infos
pd_id	int	int(11)
pd_push_id	int	varchar(255)
pd_os	string	varchar(20) ios, android, browser
pd_user_api_token_id	int	int(11)
pd_user_id	int	int(11)
pd_actif	int	int(11)
pd_crea_date	string	datetime
pd_crea_user_id	int	int(11)
pd_modif_date	string	datetime
pd_modif_user_id	int	int(11)

/devicePushs POST

Enregistre un nouveau devicePush pour le token courant
Détails

Request body

json

pushId (requis) + os (requis, "ios" ou "android")

Example

json

{
    "pushId": "...",
    "os": "..."
}

Api-Return

json

{
    "output": {
        "success": 1,
        "response": [
            {
                "...": "..."
            }
        ]
    }
}

Return (response)

PushDevice_DB

Le devicePush qui vient d'être créé

PushDevice_DB

Propriété	Type	Type SQL / Infos
pd_id	int	int(11)
pd_push_id	int	varchar(255)
pd_os	string	varchar(20) ios, android, browser
pd_user_api_token_id	int	int(11)
pd_user_id	int	int(11)
pd_actif	int	int(11)
pd_crea_date	string	datetime
pd_crea_user_id	int	int(11)
pd_modif_date	string	datetime
pd_modif_user_id	int	int(11)

/devicePushs DELETE

Supprime un devicePush
Détails

Param	int	typeid (default = null)
Api-Return	json	{ "output": { "success": 1, "response": [ { "sous_type_bien_id": "sous_type_bien_libelle" } ] } }
Return (response)	array	Liste des sous types de biens

Param	string	status (default = null) Statut du paiement (default = PaiementLibre_DB::STATUT_PAIEMENT_PAYBOX_SUCCESS)
Param	string	begindate (default = null) Date de début (format yyyy-mm-dd)
Param	string	enddate (default = null) Date de fin (format yyyy-mm-dd)
Param	int	siteid (default = 0) Site concerné
Api-Return	json	{ "output": { "success": 1, "response": [ { "plDate": "2015-05-01", "plNb": 5, "plTotal": 1542.0799999999999 }, { "...": "..." } ] } }
Return (response)	array	Liste de stats

Example	-	/stats/analytics/www.azko.fr
Api-Return	json	{ "output": { "success": 1, "response": [ { "...": "..." } ] } }
Return (response)	object	Liste de stats

Example	-	/stats/myPoseo/azko.fr
Api-Return	json	{ "output": { "success": 1, "response": [ { "...": "..." } ] } }
Return (response)	array	Liste de stats

Example	-	/stats/facebook/agence.azko
Api-Return	json	{ "output": { "success": 1, "response": [ { "...": "..." } ] } }
Return (response)	array	Liste de stats

Example	-	/stats/twitter/agenceAzko
Api-Return	json	{ "output": { "success": 1, "response": [ { "...": "..." } ] } }
Return (response)	array	Liste de stats

Param	string	pushId (requis)
Api-Return	json	{ "output": { "success": 1, "response": true } }
Return (response)	bool	True si le devicePush a bien été supprimé

DOCUMENTATION API REST/JSONAZKO-CMS API - v1.0

Informations générales

Détail des webservices