Added 'test_openads_connexion' endpoint and README completed
This commit is contained in:
parent
522634d564
commit
ee0173698e
71
README
71
README
|
@ -0,0 +1,71 @@
|
|||
Passerelle connector to openADS
|
||||
===============================
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
- create a symbolik link from this module to the passerelle 'apps' directory
|
||||
|
||||
- add to Passerelle installed apps settings:
|
||||
INSTALLED_APPS += ('passerelle.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
|
||||
|
|
@ -152,8 +152,13 @@ class AtrealOpenads(BaseResource):
|
|||
return {'response': response.status_code}
|
||||
|
||||
|
||||
@endpoint(description="Test an openADS 'connexion'")
|
||||
def test_openads_connexion(self, request):
|
||||
return self.check_status()
|
||||
|
||||
|
||||
@endpoint(
|
||||
description="Create an openADS 'dossier' (harcoded for now)",
|
||||
description="Create an openADS 'dossier'",
|
||||
methods=['post'],
|
||||
pattern='^(?P<type_dossier>\w+)/?$',
|
||||
example_pattern='{type_dossier}/',
|
||||
|
|
Reference in New Issue