| serverUrl |
String
|
optional
URL d'accès au service. Par défaut "https://data.geopf.fr/SERVICE/".
Permet de forcer l'utilisation d'un service équivalent déployé derrière une éventuelle autre URL d'accès.
Si ce paramètre est renseigné alors, le paramètre par défaut est ignoré. |
| protocol |
String
|
optional
Le protocole à utiliser pour récupérer les informations du service :
peut valoir 'JSONP' ou 'XHR'.
Par défaut, c'est le protocole XHR qui sera utilisé.
Attention, le protocole JSONP n'est pas valide dans un environnement NodeJS (Utilisation du mode XHR). |
| ssl |
Boolean
|
optional
Indique si l'on souhaite intérroger les services en https.
Ce paramètre ne fonctionne que pour une utilisation hors navigateur (ex. NodeJS).
Sur un navigateur, le protocole est automatiquement extrait de l'url du site...
Par défaut, on utilise le protocole http (ssl=false). |
| proxyURL |
String
|
optional
Le proxy à utiliser pour pallier au problème de cross-domain dans le cas d'une requête XHR.
Utile si le paramètre 'protocol' vaut 'XHR', il ne sera pas pris en compte si protocol vaut JSONP. |
| callbackSuffix |
String
|
optional
Suffixe de la fonction de callback à utiliser, dans le cas du protocole JSONP.
Par défaut, la fonction de callback portera un nom du type "callback"+ID, où ID est soit un identifiant unique généré à chaque requête,
soit le paramètre callbackSuffix s'il est spécifié. Par exemple, si callbackSuffix="_2", la fonction sera "callback_2 ()".
Utile pour utiliser une réponse déjà encapsulée dans une fonction de callback, dont le nom est connu
Utile seulement si le paramètre 'protocol' vaut 'JSONP', il ne sera pas pris en compte si protocol vaut 'XHR'. |
| httpMethod |
String
|
optional
La méthode HTTP
à utiliser dans le cas d'une requête XHR : peut valoir 'GET' ou 'POST'.
Non pris en compte si 'protocol' vaut JSONP qui fonctionne obligatoirement en GET.
Par défaut, c'est la méthode GET qui est utilisée. |
| contentType |
String
|
optional
Content-Type de la requete
à utiliser dans le cas d'une requête XHR en mode POST.
Non pris en compte si 'protocol' vaut JSONP et/ou la méthode HTTP vaut GET.
Par défaut, c'est la méthode GET qui est utilisée donc on n'utilise pas de Content-Type. |
| timeOut |
Number
|
optional
Délai d'attente maximal (en ms) de la réponse du service (à partir de l'envoi de la requête).
Par défaut, aucun timeOut n'est pris en compte (timeoutDelay= 0). |
| rawResponse |
Boolean
|
optional
Indique si l'on souhaite que la réponse du service ne soit pas parsée par l'API avant d'être restituée.
(Cf. paramètre « onSuccess » pour plus de détails). |
| onSuccess |
function
|
optional
Fonction appelée lorsque le service répond correctement à la requête
(code HTTP 200, sans message d'erreur).
Cette fonction prend en paramètre la réponse du service,
soit sous la forme d'un Object Javascript formaté par le parseur dédié à la syntaxe du service (comportement par défaut) ;
soit brute au format String non prétraité si le paramètre « rawResponse » a été précisé avec la valeur « true ». |
| onFailure |
function
|
optional
Fonction appelée lorsque le service ne répond pas correctement
(code HTTP de retour différent de 200 ou pas de réponse). |
| onBeforeParse |
function
|
optional
Fonction appelée avant le parsing de la réponse
Permet de modifier la réponse avant parsing et la fonction doit retourner une String.
Cette fonction prend en paramètre la réponse telle que renvoyée par le service
(cad au format json ou xml).
Pour le JSONP, si le paramètre "rawResponse" a été précisé avec la valeur "true",
la fonction prend en paramètre un Object JavaScript contenant la réponse XML. |
