This repository has been archived on 2023-02-22. You can view files and clone it, but cannot push or open issues or pull requests.
passerelle-atreal-openads/README

87 lines
2.7 KiB
Plaintext

Passerelle connector to openADS
===============================
Installation
------------
- add to Passerelle installed apps settings:
INSTALLED_APPS += ('atreal_openads',)
Usage
-----
- create and configure new connector
- Title/description: whatever you want
- Collectivity: enter the technical ID from openADS
- openADS API login : the login credential to connect to openADS.API
- openADS API password : the password credential to connect to openADS.API
- Extra debug: check if you want more debug logging
- test service by clicking on the available links
- the /test_openads_connexion/ endpoint try to establish a connection with openADS.API
Usage in w.c.s.
---------------
- create dossier
- a processing data to the workflow named 'Numéro dossier' with identifier 'numero_dossier'
- wcs workflow action "call webservice"
URL : https://passerelle.dev.publik.love/atreal-openads/inst0/create_dossier/DIA/
Method : POST (JSON)
Send form data : checked
Response type : JSON
Identifier : wsdia
- wcs workflow action "processing data"
Modify processing data:
Field: Numéro dossier
Value: wsdia_response_numero_dossier
- wcs workflow action "message in history"
Message : "Récépissé reçu"
Files attached : (Python expr) "utils.dict_from_prefix('wsdia_response_recepisse_', locals())"
- get dossier
- wcs workflow action "call webservice"
URL : https://passerelle.dev.publik.love/atreal-openads/inst0/get_dossier/DIA
Data to send in parameter of the URL:
Name : numero_dossier
Value: (Python expr) "form_var_numero_dossier"
Method : GET
Response type : JSON
Identifier : wsetat
- get courrier
- wcs workflow action "call webservice"
URL : https://passerelle.dev.publik.love/atreal-openads/inst0/get_courrier/DIA
Data to send in parameter of the URL:
Name : numero_dossier
Value: (Python expr) "form_var_numero_dossier"
Method : GET
Response type : JSON
Identifier : wscourrier
License
-------
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.
You should have received a copy of the GNU Affero General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>.