Update API Odoo Comunitats Energètiques authored by Xavier Bonet's avatar Xavier Bonet
...@@ -8,21 +8,21 @@ Aquests ednpoints estan auto-documentats al mateix Odoo (test) aquí: [api_docs] ...@@ -8,21 +8,21 @@ Aquests ednpoints estan auto-documentats al mateix Odoo (test) aquí: [api_docs]
**Alerta**: Hi ha però algunes limitacions en aquesta auto-documentació que fa que hi hagi algunes *variants* d'algunes crides no quedin reflectides en aquest recurs del Odoo (tenim pendent de revisar com millorar això), de manera que a continuació mantenim un apartat especific per a cada EndPoint amb totes les variants més ben documentades: **Alerta**: Hi ha però algunes limitacions en aquesta auto-documentació que fa que hi hagi algunes *variants* d'algunes crides no quedin reflectides en aquest recurs del Odoo (tenim pendent de revisar com millorar això), de manera que a continuació mantenim un apartat especific per a cada EndPoint amb totes les variants més ben documentades:
## community ## API community
## crm-lead ## API crm-lead
## member ## API member
## profile ## API profile
## maps ## API maps
API usada pel back-end del MApa a la Web Pública per interactuar amb l'Odoo. En aquest cas veure la [pròpia auto-documentació del Odoo](https://erp-test.somcomunitats.coop/api-docs?urls.primaryName=api%2Fprivate%3A%20maps#/default) al respecte. API usada pel back-end del MApa a la Web Pública per interactuar amb l'Odoo. En aquest cas veure la [pròpia auto-documentació del Odoo](https://erp-test.somcomunitats.coop/api-docs?urls.primaryName=api%2Fprivate%3A%20maps#/default) al respecte.
## Endpoint: Creacion de la peticion de alta de socia (desde formulario) ## FORMULARI Petició de alta de socia a una CE
- Funcionalitat: Accés al formulari de la web pública de Odoo que permet registrar una subscripció de una persona ( persona física, no jurídica !) a una comunitat energètica. - Funcionalitat: Accés al formulari de la web pública de Odoo que permet registrar una subscripció de una persona ( persona física, no jurídica !) a una comunitat energètica.
- URL: `odoo_root_url/become_cooperator` - URL: `odoo_server_root_url/become_cooperator`
- Paràmetres: - Paràmetres:
- `odoo_company_id` (int): s'ha de correspondre amb un ID vàlid de Odoo corresponent a una res_company.id (companyia de Odoo = Comunitat Energètica). - `odoo_company_id` (int): s'ha de correspondre amb un ID vàlid de Odoo corresponent a una res_company.id (companyia de Odoo = Comunitat Energètica).
- Resposta: - Resposta:
...@@ -30,7 +30,7 @@ API usada pel back-end del MApa a la Web Pública per interactuar amb l'Odoo. En ...@@ -30,7 +30,7 @@ API usada pel back-end del MApa a la Web Pública per interactuar amb l'Odoo. En
- [nok]: retorna codi de error i missatge: - [nok]: retorna codi de error i missatge:
- [500] `Not valid parameter value [odoo_company_id]` : el valor rebut no es correspon amb cap ID de res_company al Odoo. - [500] `Not valid parameter value [odoo_company_id]` : el valor rebut no es correspon amb cap ID de res_company al Odoo.
- Exemples crida a testing: - Exemples crida a testing:
- Si la petició va orientada a la CE amb id de companyia = 2 al Odoo, aleshores: https://erp-test.somcomunitats.coop/become_cooperator?odoo_company_id=2 - Si la petició va orientada a la CE amb id de companyia = 5 al Odoo, aleshores: https://erp-test.somcomunitats.coop/become_cooperator?odoo_company_id=5
- Consideracions funcionals: - Consideracions funcionals:
- Un cop enviat el formulari amb èxit, Odoo mostra aquest missatge: - Un cop enviat el formulari amb èxit, Odoo mostra aquest missatge:
... ...
......