Comparaison des versions

Ancienne version 4

changes.mady.by.user Stéphane Becker

Sauvegardée le

comparé à

Nouvelle version 5

changes.mady.by.user Stéphane Becker

Sauvegardée le

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

Résumé

Manipulation de l'entité entité Branchoffice (Agences) en en lecture/écriture/suppression via un objet métier depuis une application externe.

...

Les tables utilisées sont :

  • sw_data_branchoffice  : Table des agences

Critères d'activation

WHK_Branchoffice est est défini dans la gestion des webhooks du studio.

Fonctionnement

verb: GET
resultType: simple

info
Bloc de code
language
json
  "branchoffice": {
    "codebranchoffice": "75.PAR",
    "name": "Paris",
    "address1": "1 avenue des Champs Elysées",
    "address2": "",
    "postalCode": "75000",
    "city": "PARIS",
    "generictype_ID_country": "FR",
    "phoneNumber": "01 88 81 50 10",
    "faxNumber": "01 89 82 51 11",
    "email": "agc-paris@papyrus.fr"
  }

verb: GET
resultType: extended

Info
Bloc de code
languagejson
  "branchoffice":{
    "codebranchoffice": "75.PAR",
    "name": "Paris",
    "address1": "1 avenue des Champs Elysées",
    "address2": "",
    "postalCode": "75000",
    "city": "PARIS",
    "generictype_ID_country": "FR",
    "phoneNumber": "01 88 81 50 10",
    "faxNumber": "01 89 82 51 11",
    "email": "agc-paris@papyrus.fr",
    "website": "www.papyrus.com",
    "bankholidayparamheader_ID": "FRANCE",
    "gpsLongitude": "",
    "gpsLatitude": "",
    "baseusergroup_ID": "#TEST SB-TEST SB lib"
  }

Verbverb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour les tables la table generictype_country.

...

Bloc de code
languagejson
"related": [
{
  "generictype_country": {
    "codegenerictype": "COUNTRY-FR",
    "label": "FRANCE",
    "originalCode": "FR",
    "dataType": "COUNTRY",
    "description": "",
    "translationKey": "GenType_COUNTRY-FR",
    "generictype_ID_parent": "",
    "tag": "",
    "orderNumber": ""
  }
}]

verb: PUT

Infocode
languagejson
{
  "branchoffice": {
    "codebranchoffice": "75.PAR", /* Code globalement unique de l'agence (Varchar (255))*/
    "name": "Paris", /* Nom de l'agence (Varchar (255))*/
    "address1": "1 avenue des Champs Elysées", /* Adresse 1 (Varchar (255))*/
    "address2": "", /* Adresse 2 (Varchar (255))*/
    "postalCode": "75000", /* Code postal (Varchar (16))*/
    "city": "PARIS", /* Ville (Varchar (255))*/
    "generictype_ID_country": "COUNTRY-FR", /* Code pays (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = COUNTRY)*/            
    "phoneNumber": "01 88 81 50 10", /* Numéro de téléphone (Varchar (64))*/
    "faxNumber": "01 89 82 51 11", /* Numéro de télécopie (Varchar (64))*/
    "email": "agc-paris@papyrus.fr", /* Email (Varchar (255))*/
    "website": "www.papyrus.com", /* Site internet (Varchar (255))*/
    "bankholidayparamheader_ID": "", /* Code entête paramétrage jours fériés (ForeignKey () - sw_data_bankholidayparamheader.codebankholidayparamheader)*/
    "baseusergroup_ID": "TEST SB-BRANCHOFFICE" /*  Code groupe utilisateur (ForeignKey () - sw_data_baseusergroup.codebaseusergroup)*/            
  }     
}

verb: LIST
resultType: simple, extended, extendedRelated reprendre les définitions du GET

info
Bloc de code
language
json
"filters:" {
  "codeBranchoffice": "value", filter is equal
  "name": "value", filter is contains
  "codeCountry": "value", filter is equal  
},
"orderBy": "value"

Valeur possibles pour le tri "orderBy" :

  • codeBranchOfficeAsc : par code agence ascendant

  • nameAsc : par nom ascendant