Copyright © 2020. Aurea Software, Inc. ("Aurea")
| API / APIs Radiofréquence | |
| Version ACE : 5.0-00 | |
|
Package : Standard Sous-programme Basic : Demande_Liste_Activites Nom de la gnc : gnc_rf_rechtypact |
Fonctionnalité Général : |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet de fournir la liste des types d’activité affectés à un opérateur donné.
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RAS. |
Prototype de la fonction Basic
| Demande_Liste_Activites (numero_module, age, ltypact(5), libtypact(5), idprfact(5)) |
Messages en entrée
| RECH_ACT~age~ |
Messages en sortie
| Retour~[ltypact~liract~idprfact~]... 5 types d’activité au plus |
Valeurs restituées par l’API
| VALEUR | REMARQUE |
| 1 | Il y a au moins une activité affectée à l’opérateur. |
| 70 | L’opérateur n’existe pas. |
| 71 | Il n’y a pas d’activité affectée à l’opérateur. |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
| 1 | Recherche des types d’activité affectés à l’opérateur choisi. |
| Détail : |
Read the depot for the operator. If the operator does not exist the API returns the error code 70. The status of the operator is changed to connected (LOPR.statut = 3). Look for an active activity profile for the operator (LPRFOPR.active = 1). If no one active profile is found the API returns the error code 71. For each activity type for the active activity profile found (up to 5) The API returns the activity type (LPRFACT.ltypact), the label of the activity type (LACTTYP.libtypact), which is truncated up to 13 symbols and the identifier of the activity profile (lprfact.idprfact). |
Erreurs possibles
| CAUSE | EFFET |
| L’opérateur n’existe pas. |
Code retour 70, message « L'opérateur n'est pas un opérateur RF » |
| Il n’y a pas d’activité affectée à l’opérateur, donc pas de profil d’activité. |
Code retour 71, message « L'opérateur n'a pas de profils » |
Exemple(s) d’utilisation
| ret = Demande_Liste_Activites (numero_module, age, ltypact, libtypact, idprfact) |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| idopr | CHAR | 8 | O | Code opérateur |
| NOM | DESCRIPTION | FORMAT |
|---|---|---|
| ltypact1 | Type of the 1. activity for the 1. active activity profile | Number |
| libtypact1 | Label of the 1. activity type for the 1. active activity profile | Char(13) |
| idprfact1 | Identifier of the 1. active activity profile | Number |
| ltypact2 | Type of the 2. activity for the 2. active activity profile | Number |
| libtypact2 | Label of the 2. activity type for the 2. active activity profile | Char(13) |
| idprfact2 | Identifier of the 2. active activity profile | Number |
| ltypact3 | Type of the 3. activity for the 3. active activity profile | Number |
| libtypact3 | Label of the 3. activity type for the 3. active activity profile | Char(13) |
| idprfact3 | Identifier of the 3. active activity profile | Number |
| ltypact4 | Type of the 4. activity for the 4. active activity profile | Number |
| libtypact4 | Label of the 4. activity type for the 4. active activity profile | Char(13) |
| idprfact4 | Identifier of the 5. active activity profile | Number |
| ltypact5 | Type of the 5. activity for the 5. active activity profile | Number |
| libtypact5 | Label of the 5. activity type for the 5. active activity profile | Char(13) |
| idprfact5 | Identifier of the 5. active activity profile | Number |