{"id":21614950,"url":"https://github.com/eea/european.cache.registry","last_synced_at":"2025-08-04T07:10:59.485Z","repository":{"id":23182277,"uuid":"26538451","full_name":"eea/european.cache.registry","owner":"eea","description":"A middleware between ODS Licensing System and F-Gas Registry and BDR.","archived":false,"fork":false,"pushed_at":"2025-04-28T11:11:28.000Z","size":914,"stargazers_count":4,"open_issues_count":2,"forks_count":2,"subscribers_count":48,"default_branch":"master","last_synced_at":"2025-04-28T12:26:18.022Z","etag":null,"topics":["bdr","docker","flask","mysql","python"],"latest_commit_sha":null,"homepage":"https://bdr.eionet.europa.eu","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eea.png","metadata":{"files":{"readme":"README-API.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-11-12T13:59:31.000Z","updated_at":"2025-04-28T11:11:22.000Z","dependencies_parsed_at":"2022-08-21T19:50:42.683Z","dependency_job_id":"51d97a28-e86b-42a8-b3f0-4d1a66b8cea1","html_url":"https://github.com/eea/european.cache.registry","commit_stats":null,"previous_names":[],"tags_count":151,"template":false,"template_full_name":null,"purl":"pkg:github/eea/european.cache.registry","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Feuropean.cache.registry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Feuropean.cache.registry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Feuropean.cache.registry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Feuropean.cache.registry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eea","download_url":"https://codeload.github.com/eea/european.cache.registry/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eea%2Feuropean.cache.registry/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268660156,"owners_count":24286028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bdr","docker","flask","mysql","python"],"created_at":"2024-11-24T22:10:07.181Z","updated_at":"2025-08-04T07:10:59.451Z","avatar_url":"https://github.com/eea.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"API Documentation\n=========================================\n\nThe european.cache.registry API allows a client (BDR) to access cached data fetched\nfrom various sources (FGas Registry, ODS Registry, BDR Registry).\n\nThe API uses HTTP for transport, JSON as data format and does not require\nauthentication.\n\nOverview\n--------\n**Auditor calls:**\n\n* [`/auditors/list/`](#auditorslist) - list all auditors\n* [`/auditors/[auditor_uid]/details/`](#auditorsauditor_uiddetails) - details about an auditor\n* [`/undertaking/[domain]/[company_id]/auditor/[auditor_uid]/check`](#undertakingdomaincompany_idauditorauditor_uidcheck) - verifies if the auditor and the company are from the same country. Returns the auditor information if this condition is met.\n* [`/undertaking/[domain]/[company_id]/auditor/[auditor_uid]/assign/`](#post-undertakingdomaincompany_idauditorauditor_uidassign) - assigns auditor to company\n* [`/undertaking/[domain]/[company_id]/auditor/[auditor_uid]/unassign/`](#post-undertakingdomaincompany_idauditorauditor_uidunassign) - unassigns an auditor from a company\n* [`/auditors/verification_envelopes/?reporting_envelope_url=/reporting/envelope/url`](#get-auditorsverification_envelopesreporting_envelope_urlreportingenvelopeurl) -  returns the list of verification envelopes for a given reporting envelope\n\n**Undertaking calls:**\n\n* [`/undertaking/[domain]/list`](#undertakingdomainlist) - all verified undertakings from domain\n* [`/undertaking/[domain]/list-small`](#undertakingdomainlist-small) - all verified undertakings from domain but with fewer details\n* [`/undertaking/[domain]/list/all`](#undertakingdomainlistall) - all undertakings from domain, including unverified\n* [`/undertaking/[domain]/list_by_vat/[vat]`](#undertakingdomainlist_by_vat) - filter by vat undertakings from domain\n* [`/undertaking/[domain]/filter`](#undertakingdomainfilternameidvatcountrycodeor_vator_name) - count of undertakings from domain, given field filters\n* [`/undertaking/[domain]/[company_id]/details`](#undertakingdomaincompany_iddetails) - details about an undertaking from a domain\n* [`/undertaking/[domain]/[company_id]/details-short`](#undertakingdomaincompany_iddetails-short) - short details about an undertaking from a domain\n* [`/undertaking/[domain]/[company_id]/statusupdate`](#undertakingdomaincompany_idstatusupdate---post) - change the status of a company from a domain\n\n**Licences calls**\n\n* [`/undertaking/[domain]/[company_id]/licences/[year]/aggregated`](#undertakingdomaincompany_idlicencesyearaggregated---post) - all substances(licences data aggregated) for one undertaking delivered in a year\n* [`/undertaking/[domain]/[company_id]/deliveries/[year]/licences`](#undertakingdomainpkdeliveriesyearlicences---get) - all licences for one undertaking for a certain year\n* [`/undertaking/[domain]/[company_id]/deliveries/[year]/substances`](#undertakingdomainpkdeliveriesyearsubstances---get) - all substances for one undertaking for a certain year\n\n**Stocks calls**\n\n* [`/stocks`](#stocks---get) - all stocks in the database\n* [`/stocks/[company_id]`](#stocks12345---post) - all stocks for one company per years\n* [`/stocks/years/[years]`](#stocksyears2019---get) - all stocks for one selected year\n* `/stocks/import` - import new stocks\n\n**User calls:**\n\n* [`/user/list`](#userlist) - all users\n* [`/user/[username]/companies`](#userusernamecompanies) - all verified companies the user has access to\n* [`/user/companies?username=[username]\u0026ecas_id=[ecas_id]`](#usercompaniesusernameusernameecas_idecas_id) - all verified companies the user has access to (check is done with both parameters on both username and ecas_id fields)\n* [`/user/companies/v2?username=[username]\u0026ecas_id=[ecas_id]`](#usercompaniesv2usernameusernameecas_idecas_id) - all verified companies and audited companies the user has access to\n\n**Matching calls:**\n\n* [`/candidate/[domain]/list`](#candidatedomainlist) -  all matching candidates from domain\n* [`/candidate/[domain]/list/verified`](#candidatedomainlistverified---get) - list verified undertakings from domain\n* [`/candidate/[domain]/verify/[undertaking_id]/[oldcompany_id]/`](#candidatedomainverifyundertaking_idoldcompany_id---post) - mark an\nundertaking-company link as verified from domain\n* [`/candidate/[domain]/verify-none/[undertaking_id]`](#candidatedomainverify-noneundertaking_id---post) - mark an\nundertaking as verified from domain\n* [`/candidate/[domain]/unverify/[undertaking_id]/`](#candidatedomainunverifyundertaking_id---post) - unverify undertaking-company link\nafter prior verfication from domain\n* [`/candidate/[domain]/manual/[undertaking_id]/[oldcompany_account]`](#candidatedomainmanualundertaking_idoldcompany_account---post) - manualy link\nundertaking with company account\n\n* [`/match/run`](#matchrun---get) - run matching algorithm\n* [`/match/flush`](#matchflush---get) - remove all matching links created by the matching algorithm,\nverified or not\n\n**Export calls:**\n\n* [`/export/user/list/[domain]`](#exportuserlistdomain) - export users list as CSV\n* [`/export/user/json/[domain]`](#exportuserlistdomain) - export users list as JSON\n* [`/export/undertaking/[domain]`](#exportundertakingdomain) - export companies list from domain as CSV\n\n**Mails calls:**\n\n* [`/mail/list`](#maillist) - list the mails\n* [`/mail/add`](#mailadd---post) - add a mail to the list\n* [`/mail/delete`](#maildelete---post) - delete a mail from the list\n* [`/alert_lockdown/wrong_match`](#alert_lockdownwrong_match---post) - alert on wrong matching of a company\n* [`/alert_lockdown/wrong_lockdown`](#alert_lockdownwrong_lockdown---post) - alert on wrong lockdown\n* [`/alert_lockdown/unmatch`](#alert_lockdownunmatch---post) - alert at unmatch\n\n**Sync**:\n\n* [`/sync/collections_title`](#synccollections_title---get)\n* [`/sync/fgases`](#syncfgases---get)\n* [`/sync/ods`](#syncods---get)\n* [`/sync/licences`](#synclicences----get)\n\n**Log calls:**\n* [`/log/matching/[domain]`](#logmatchingdomain) - matching logs\n* [`/log/sync[domain]`](logsyncdomain) - data sync logs\n\n**Settings:**\n\n* [`/settings`](#settings) - overview of the middleware settings\n\n**Debug:**\n\n* [`/sync/fgases_debug_noneu`](#syncfgases_debug_noneu---get) - returns a list with all NON EU companies without a legal representative from FGas\n\nAuditor calls\n==============\n \n/auditors/list/\n---------------\n\nReturns the list of auditors\n\n    [\n      {\n        \"auditor_uid\": \"ABDFDFS\",\n        \"name\": \"Auditor name\",\n        \"website\": \"website.com\",\n        \"phone\": \"12342432\",\n        \"date_created\": \"01/01/2024\",\n        \"date_updated\": \"01/01/2024\",\n        \"date_created_in_ecr\": \"01/01/2024\",\n        \"date_updated_in_ecr\": \"01/01/2024\",\n        \"status\": \"VALID\",\n        \"ets_accreditation\": true,\n        \"ms_accreditation\": true,\n        \"ms_accreditation_issuing_countries\": [\n          \"BE\",\n        ],\n        \"address\": {\n            \"street\": \"One\",\n            \"number\": null,\n            \"zipcode\": null,\n            \"city\": \"City\",\n            \"country\": {\n                \"code\": \"PL\",\n                \"name\": \"Poland\",\n                \"type\": \"EU_TYPE\"\n            }\n        },\n        \"users\": [\n            {\n                \"ecas_id\": \"ecas_id\",\n                \"username\": \"username\",\n                \"first_name\": \"First name\",\n                \"last_name\": \"Last name\",\n                \"email\": \"mail@test.com\",\n                \"type\": \"TYPE\"\n            }\n        ],\n        \"audited_companies\": [\n            {\n                \"start_date\": \"20/02/2025\",\n                \"end_date\": \"21/03/2025\",\n                \"reporting_envelope_url\": \"reporting/folder/1234\",\n                \"verification_envelope_url\": \"verification/folder/12345\",\n                \"auditor\": {\n                    \"auditor_uid\": \"ABDFDFS\",\n                    \"name\": \"Auditor name\"\n                },\n                \"undertaking\": {\n                    \"company_id\": 10085,\n                    \"domain\": \"FGAS\",\n                    \"name\": \"Company name\"\n                },\n                \"user\": {\n                    \"ecas_id\": \"ecas_id\",\n                    \"username\": \"username\",\n                    \"first_name\": \"First name\",\n                    \"last_name\": \"Last name\",\n                    \"email\": \"mail@test.com\",\n                    \"type\": \"TYPE\"\n                }\n            },\n            {\n                \"start_date\": \"21/02/2025\",\n                \"end_date\": \"None\",\n                \"reporting_envelope_url\": \"reporting/folder/123423\",\n                \"verification_envelope_url\": \"verification/folder/1234345\",\n                \"auditor\": {\n                    \"auditor_uid\": \"ABDFDFS\",\n                    \"name\": \"Auditor name\"\n                },\n                \"undertaking\": {\n                    \"company_id\": 10085,\n                    \"domain\": \"FGAS\",\n                    \"name\": \"Company name\"\n                },\n                \"user\": {\n                    \"ecas_id\": \"ecas_id\",\n                    \"username\": \"username\",\n                    \"first_name\": \"First name\",\n                    \"last_name\": \"Last name\",\n                    \"email\": \"mail@test.com\",\n                    \"type\": \"TYPE\"\n                }\n            }\n        ]\n      }\n    ]\n\nauditors/[auditor_uid]/details/\n-------------------------------\n\nReturns the auditor\n\n    {\n        \"auditor_uid\": \"ABDFDFS\",\n        \"name\": \"Auditor name\",\n        \"website\": \"website.com\",\n        \"phone\": \"12342432\",\n        \"date_created\": \"01/01/2024\",\n        \"date_updated\": \"01/01/2024\",\n        \"date_created_in_ecr\": \"01/01/2024\",\n        \"date_updated_in_ecr\": \"01/01/2024\",\n        \"status\": \"VALID\",\n        \"ets_accreditation\": true,\n        \"ms_accreditation\": true,\n        \"ms_accreditation_issuing_countries\": [\n          \"BE\",\n        ],\n        \"address\": {\n            \"street\": \"One\",\n            \"number\": null,\n            \"zipcode\": null,\n            \"city\": \"City\",\n            \"country\": {\n                \"code\": \"PL\",\n                \"name\": \"Poland\",\n                \"type\": \"EU_TYPE\"\n            }\n        },\n        \"users\": [\n            {\n                \"ecas_id\": \"ecas_id\",\n                \"username\": \"username\",\n                \"first_name\": \"First name\",\n                \"last_name\": \"Last name\",\n                \"email\": \"mail@test.com\",\n                \"type\": \"TYPE\"\n            }\n        ],\n        \"audited_companies\": [\n            {\n                \"start_date\": \"20/02/2025\",\n                \"end_date\": \"21/03/2025\",\n                \"reporting_envelope_url\": \"reporting/folder/1234\",\n                \"verification_envelope_url\": \"verification/folder/12345\",\n                \"auditor\": {\n                    \"auditor_uid\": \"ABDFDFS\",\n                    \"name\": \"Auditor name\"\n                },\n                \"undertaking\": {\n                    \"company_id\": 10085,\n                    \"domain\": \"FGAS\",\n                    \"name\": \"Company name\"\n                },\n                \"user\": {\n                    \"ecas_id\": \"ecas_id\",\n                    \"username\": \"username\",\n                    \"first_name\": \"First name\",\n                    \"last_name\": \"Last name\",\n                    \"email\": \"mail@test.com\",\n                    \"type\": \"TYPE\"\n                }\n            },\n            {\n                \"start_date\": \"21/02/2025\",\n                \"end_date\": \"None\",\n                \"reporting_envelope_url\": \"reporting/folder/123423\",\n                \"verification_envelope_url\": \"verification/folder/1234345\",\n                \"auditor\": {\n                    \"auditor_uid\": \"ABDFDFS\",\n                    \"name\": \"Auditor name\"\n                },\n                \"undertaking\": {\n                    \"company_id\": 10085,\n                    \"domain\": \"FGAS\",\n                    \"name\": \"Company name\"\n                },\n                \"user\": {\n                    \"ecas_id\": \"ecas_id\",\n                    \"username\": \"username\",\n                    \"first_name\": \"First name\",\n                    \"last_name\": \"Last name\",\n                    \"email\": \"mail@test.com\",\n                    \"type\": \"TYPE\"\n                }\n            }\n        ]\n    }\n\n/undertaking/[domain]/[company_id]/auditor/[auditor_uid]/check\n--------------------------------------------------------------\n\nReturns the auditor if:\n* the Auditor has a valid status.\n* Auditor has ets_accreditation = True **OR** Company's country code (calculated as the address country or representative country) is included in ms_accreditation_issuing_countries\n\n      {\n          \"access\": true,\n          \"auditor\": {\n              \"auditor_uid\": \"ABDSDE\",\n              \"name\": \"Auditor name\",\n              \"website\": null,\n              \"phone\": \"+2343243453\",\n              \"date_created\": \"01/01/2024\",\n              \"date_updated\": \"01/01/2024\",\n              \"date_created_in_ecr\": \"01/01/2024\",\n              \"date_updated_in_ecr\": \"01/01/2024\",\n              \"status\": \"VALID\",\n              \"ets_accreditation\": true,\n              \"ms_accreditation\": true,\n              \"ms_accreditation_issuing_countries\": [\n                \"BE\"\n              ],\n              \"address\": {\n                  \"street\": \"One\",\n                  \"number\": null,\n                  \"zipcode\": null,\n                  \"city\": \"City\",\n                  \"country\": {\n                      \"code\": \"PL\",\n                      \"name\": \"Poland\",\n                      \"type\": \"EU_TYPE\"\n                  }\n              },\n              \"users\": [\n                  {\n                      \"ecas_id\": \"ecas_id\",\n                      \"username\": \"username\",\n                      \"first_name\": \"First name\",\n                      \"last_name\": \"Last name\",\n                      \"email\": \"mail@mail.com\",\n                      \"type\": \"TYPE\"\n                  }\n              ]\n          }\n      }\n\n_POST:_ /undertaking/[domain]/[company_id]/auditor/[auditor_uid]/assign/\n------------------------------------------------------------------------\n\nAssigns the auditor _[auditor_uid]_, lead by the given user _[email]_ to the company _[company_id]_ if:\n* the Auditor has a valid status.\n* Auditor has ets_accreditation = True **OR** Company's country code (calculated as the address country or representative country) is included in ms_accreditation_issuing_countries\n* There is no other assignation for the same company_id + auditor_uid + email + reporting_envelope_url+ verification_envelope_url open _(i.e.: end_date = None)_\n* There is no assignation open for the verification_envelope_url _(i.e.: end_date=None)_\n* Given email matches a user in the Auditor's contact persons\n\n_POST DATA:_\n\n* _email = Lead user email (selected from Auditor's contact persons), required_\n* _reporting_envelope_url = Original envelope URL, required_\n* _verification_envelope_url = Verification envelope URL, required_\n\n        {\n          \"email\": \"mail@test.com\",\n          \"reporting_envelope_url\": \"/folder/sds/23423\",\n          \"verification_envelope_url\": \"/folder/dsfs/dsfsdf\"\n        }\n\nResponse:\n\n    {\n      \"success\": true,\n      \"errors\": [],\n    }\n\n\n_POST:_ /undertaking/[domain]/[company_id]/auditor/[auditor_uid]/unassign/\n--------------------------------------------------------------------------\n\nUnassigns the auditor _[auditor_uid]_, lead by the given user _[email]_ from the company _[company_id]_ .\nThe auditor will still be visible in the undertaking detail and auditor listing/detail endpoints, however the end date field will be filled.\n\n_POST DATA:_\n\n* _email = Lead user email (selected from Auditor's contact persons), required_\n* _reporting_envelope_url = Original envelope URL, required_\n* _verification_envelope_url = Verification envelope URL, required_\n\n        {\n          \"email\": \"mail@test.com\",\n          \"reporting_envelope_url\": \"/folder/sds/23423\",\n          \"verification_envelope_url\": \"/folder/dsfs/dsfsdf\"\n        }\n\nResponse:\n\n    {\n      \"success\": true,\n      \"errors\": [],\n    }\n\n\n_GET_: /auditors/verification_envelopes/?reporting_envelope_url=/reporting/envelope/url\n---------------------------------------------------------------------------------------\nReturns a list of all the verification_envelopes available for the given reporting envelope url.\nIncludes information on the assigned user for that verification evelope, the auditor company and the undertaking.\n\n    {\n        \"verification_envelopes\": [\n            {\n                \"start_date\": \"20/02/2025\",\n                \"end_date\": \"21/02/2025\",\n                \"reporting_envelope_url\": \"/reporting/envelope/url\",\n                \"verification_envelope_url\": \"/verification/envelope/url/1/\",\n                \"auditor\": {\n                    \"auditor_uid\": \"1234ABC\",\n                    \"name\": \"Auditor name\"\n                },\n                \"undertaking\": {\n                    \"company_id\": 12345,\n                    \"domain\": \"DOMAIN\",\n                    \"name\": \"Undertaking name\"\n                },\n                \"user\": {\n                    \"ecas_id\": \"ecas_id\",\n                    \"username\": \"username1\",\n                    \"first_name\": \"First name\",\n                    \"last_name\": \"Last name\",\n                    \"email\": \"email@mail.com\",\n                    \"type\": \"TYPE\"\n                }\n            },\n            {\n                \"start_date\": \"21/02/2025\",\n                \"end_date\": \"21/02/2025\",\n                \"reporting_envelope_url\": \"/reporting/envelope/url\",\n                \"verification_envelope_url\": \"/verification/envelope/url/1/\",\n                \"auditor\": {\n                    \"auditor_uid\": \"1234ABC\",\n                    \"name\": \"Auditor name\"\n                },\n                \"undertaking\": {\n                    \"company_id\": 12345,\n                    \"domain\": \"DOMAIN\",\n                    \"name\": \"Undertaking name\"\n                },\n                \"user\": {\n                    \"ecas_id\": \"ecas_id\",\n                    \"username\": \"username2\",\n                    \"first_name\": \"First name\",\n                    \"last_name\": \"Last name\",\n                    \"email\": \"email2@mail.com\",\n                    \"type\": \"TYPE\"\n                }\n            },\n        ]\n    }\n\n\nUndertaking calls\n=================\n\n/undertaking/[domain]/list\n--------------------------\n\nReturns the list of all verified undertakings in the system, as fetched from domain registry.\n\n    [\n      {\n        \"website\": \"WEBSITE--10085\",\n        \"status\": \"VALID\",\n        \"domain\": \"FGAS\",\n        \"users\": [\n          {\n            \"username\": \"nzhouray\",\n            \"ecas_id\": \"nzhouray\",\n            \"first_name\": \"fname--9367\",\n            \"last_name\": \"lname--9367\",\n            \"id\": 1,\n            \"email\": \"9367email@climaOds2010.yyy\"\n          }\n        ],\n        \"representative\": {\n          \"name\": \"EULEGALNAME44\",\n          \"contact_last_name\": \"lname--9853\",\n          \"vatnumber\": \"EUVAT44\",\n          \"contact_email\": \"9853email@climaOds2010.yyy\",\n          \"contact_first_name\": \"fname--9853\",\n          \"address\": {\n            \"city\": \"city--7954\",\n            \"country\": {\n              \"code\": \"IE\",\n              \"type\": \"EU_TYPE\",\n              \"name\": \"Ireland\"\n            },\n            \"zipcode\": \"zipcode--7954\",\n            \"number\": \"nrstreet--7954\",\n            \"street\": \"street--7954\"\n        },\n        \"country_history\": [],\n        \"represent_history\": [\n          {\n          \"name\": \"EULEGALNAME44 OLD\",\n          \"contact_last_name\": \"lname--9853\",\n          \"vatnumber\": \"EUVAT45\",\n          \"contact_email\": \"9853email@climaOds2010.yyy\",\n          \"contact_first_name\": \"fname--9853\",\n          \"address\": {\n            \"city\": \"city--7954\",\n            \"country\": {\n              \"code\": \"IE\",\n              \"type\": \"EU_TYPE\",\n              \"name\": \"Ireland\"\n            },\n            \"zipcode\": \"zipcode--7954\",\n            \"number\": \"nrstreet--7954\",\n            \"street\": \"street--7954\"\n        }\n        ],\n        \"date_updated\": \"10/10/2014\",\n        \"phone\": \"+3212310085\",\n        \"country_code\": \"CN\",\n        \"address\": {\n          \"city\": \"city--7953\",\n          \"country\": {\n            \"code\": \"CN\",\n            \"type\": \"NONEU_TYPE\",\n            \"name\": \"China (excluding Hong Kong and Macao)\"\n          },\n          \"zipcode\": \"zipcode--7953\",\n          \"number\": \"nrstreet--7953\",\n          \"street\": \"street--7953\"\n        },\n        \"businessprofile\": {\n          \"highleveluses\": \"fgas.importer.of.refrigeration.ac..and.heatpump.equipment.containing.hfcs\"\n        },\n        \"oldcompany_verified\": true,\n        \"oldcompany_account\": \"fgas22331\",\n        \"oldcompany_extid\": 4,\n        \"collection_id\": null,\n        \"types\": \"FGAS_PRODUCER_IMPORTER_HFCS\",\n        \"undertaking_type\": \"FGASUndertaking\",\n        \"name\": \"FGAS-NMORGANIZATION--10085\",\n        \"company_id\": 10085,\n        \"date_created\": \"10/10/2014\",\n        \"vat\": null\n      }\n    ]\n\n\n/undertaking/[domain]/list-small\n--------------------------------\n\n    [\n    {\n        \"domain\": \"ODS\",\n        \"name\": \"NMORGANIZATION--26610\",\n        \"company_id\": 26610,\n        \"address\": {\n            \"city\": \" Sofia\",\n            \"country\": {\n                \"code\": \"BG\",\n                \"type\": \"EU_TYPE\",\n                \"name\": \"Bulgaria\"\n            },\n            \"zipcode\": \"cp19855\",\n            \"number\": \"1\",\n            \"street\": \"str--19855\"\n        },\n        \"date_created\": \"07/04/2017\",\n        \"vat\": \"NREORI26610\",\n        \"users\": [\n            {\n                \"ecas_id\": \"nwuderra\",\n                \"username\": \"nwuderra\",\n                \"first_name\": \"fname--25688\",\n                \"last_name\": \"lname--25688\",\n                \"email\": \"25688email@climaOds2010.yyy\"\n            }\n        ]\n    }\n    ]\n\n/undertaking/[domain]/list/all\n------------------------------\n\nReturns a list of all undertakings in the system (verified or not), as fetched from domain registry.\n\n    [\n      {\n        \"website\": \"WEBSITE--10085\",\n        \"status\": \"VALID\",\n        \"domain\": \"FGAS\",\n        \"users\": [\n          {\n            \"username\": \"nzhouray\",\n            \"ecas_id\": \"nzhouray\",\n            \"first_name\": \"fname--9367\",\n            \"last_name\": \"lname--9367\",\n            \"id\": 1,\n            \"email\": \"9367email@climaOds2010.yyy\"\n          }\n        ],\n        \"representative\": {\n          \"name\": \"EULEGALNAME44\",\n          \"contact_last_name\": \"lname--9853\",\n          \"vatnumber\": \"EUVAT44\",\n          \"contact_email\": \"9853email@climaOds2010.yyy\",\n          \"contact_first_name\": \"fname--9853\",\n          \"address\": {\n            \"city\": \"city--7954\",\n            \"country\": {\n              \"code\": \"IE\",\n              \"type\": \"EU_TYPE\",\n              \"name\": \"Ireland\"\n            },\n            \"zipcode\": \"zipcode--7954\",\n            \"number\": \"nrstreet--7954\",\n            \"street\": \"street--7954\"\n        },\n        \"represent_history\": [\n          {\n          \"name\": \"EULEGALNAME44 OLD\",\n          \"contact_last_name\": \"lname--9853\",\n          \"vatnumber\": \"EUVAT45\",\n          \"contact_email\": \"9853email@climaOds2010.yyy\",\n          \"contact_first_name\": \"fname--9853\",\n          \"address\": {\n            \"city\": \"city--7954\",\n            \"country\": {\n              \"code\": \"IE\",\n              \"type\": \"EU_TYPE\",\n              \"name\": \"Ireland\"\n            },\n            \"zipcode\": \"zipcode--7954\",\n            \"number\": \"nrstreet--7954\",\n            \"street\": \"street--7954\"\n        }\n        ],\n        \"date_updated\": \"10/10/2014\",\n        \"phone\": \"+3212310085\",\n        \"country_code\": \"CN\",\n        \"address\": {\n          \"city\": \"city--7953\",\n          \"country\": {\n            \"code\": \"CN\",\n            \"type\": \"NONEU_TYPE\",\n            \"name\": \"China (excluding Hong Kong and Macao)\"\n          },\n          \"zipcode\": \"zipcode--7953\",\n          \"number\": \"nrstreet--7953\",\n          \"street\": \"street--7953\"\n        },\n        \"businessprofile\": {\n          \"highleveluses\": \"fgas.importer.of.refrigeration.ac..and.heatpump.equipment.containing.hfcs\"\n        },\n        \"collection_id\": null,\n        \"oldcompany_account\": \"fgas22331\",\n        \"oldcompany_extid\": 4,\n        \"types\": \"FGAS_PRODUCER_IMPORTER_HFCS\",\n        \"undertaking_type\": \"FGASUndertaking\",\n        \"name\": \"FGAS-NMORGANIZATION--10085\",\n        \"company_id\": 10085,\n        \"date_created\": \"10/10/2014\",\n        \"vat\": null\n      },\n    ]\n\n/undertaking/[domain]/list_by_vat/\u003cvat\u003e\n---------------------------------------\n\nReturns a list of all verified undertakings in the system given by their VAT, as fetched from domain registry.\n\n    [\n      {\n        \"name\": \"FGAS-NMORGANIZATION--10078\",\n        \"company_id\": 10078\n      }\n    ]\n\n/undertaking/[domain]/filter?[name|id|vat|countrycode|OR_vat|OR_name]\n---------------------------------------------------------------------\n\nReturn true or false if there are companies for the given filter.\n\nThe *OR_name* and *OR_vat* filters refer to EuLegalRepresentative.\n\nThe *name* and *OR_name* filters use LIKE queries.\n\n    [\n      {\n        \"exists\": true,\n        \"count\": 1\n      }\n    ]\n\n/undertaking/[domain]/[company_id]/details\n------------------------------------------\n\nReturns an undertakings details from the system, as fetched from domain registry.\n\n    {\n      \"company_id\": 10085,\n      \"collection_id\": null,\n      \"undertaking_type\": \"FGASUndertaking\",\n      \"website\": \"WEBSITE--10085\",\n      \"status\": \"VALID\",\n      \"domain\": \"FGAS\",\n      \"name\": \"FGAS-NMORGANIZATION--10085\",\n      \"phone\": \"+3212310085\",\n      \"oldcompany_account\": \"fgas22331\",\n      \"oldcompany_extid\": 4,\n      \"businessprofile\": {\n        \"highleveluses\": \"\"\n      },\n      \"representative\": {\n        \"name\": \"EULEGALNAME44\",\n        \"contact_last_name\": \"lname--9853\",\n        \"vatnumber\": \"EUVAT44\",\n        \"contact_email\": \"9853email@climaOds2010.yyy\",\n        \"contact_first_name\": \"fname--9853\",\n        \"address\": {\n          \"city\": \"city--7954\",\n          \"country\": {\n            \"code\": \"IE\",\n            \"type\": \"EU_TYPE\",\n            \"name\": \"Ireland\"\n          },\n          \"zipcode\": \"zipcode--7954\",\n          \"number\": \"nrstreet--7954\",\n          \"street\": \"street--7954\"\n        }\n      },\n      \"country_history\": [],\n      \"represent_history\": [\n          {\n          \"name\": \"EULEGALNAME44 OLD\",\n          \"contact_last_name\": \"lname--9853\",\n          \"vatnumber\": \"EUVAT45\",\n          \"contact_email\": \"9853email@climaOds2010.yyy\",\n          \"contact_first_name\": \"fname--9853\",\n          \"address\": {\n            \"city\": \"city--7954\",\n            \"country\": {\n              \"code\": \"IE\",\n              \"type\": \"EU_TYPE\",\n              \"name\": \"Ireland\"\n            },\n            \"zipcode\": \"zipcode--7954\",\n            \"number\": \"nrstreet--7954\",\n            \"street\": \"street--7954\"\n        }\n      ],\n      \"auditors\": [\n          {\n              \"start_date\": \"20/02/2025\",\n              \"end_date\": \"21/03/2025\",\n              \"reporting_envelope_url\": \"reporting/folder/1234\",\n              \"verification_envelope_url\": \"verification/folder/12345\",\n              \"auditor\": {\n                  \"auditor_uid\": \"ABCDEDF\",\n                  \"name\": \"Auditor name\"\n              },\n              \"undertaking\": {\n                  \"company_id\": 10085,\n                  \"domain\": \"FGAS\",\n                  \"name\": \"Company name\"\n              },\n              \"user\": {\n                  \"ecas_id\": \"ecas_id\",\n                  \"username\": \"username\",\n                  \"first_name\": \"First name\",\n                  \"last_name\": \"Last name\",\n                  \"email\": \"mail@test.com\",\n                  \"type\": \"TYPE\"\n              }\n          },\n          {\n              \"start_date\": \"21/02/2025\",\n              \"end_date\": \"None\",\n              \"reporting_envelope_url\": \"reporting/folder/123423\",\n              \"verification_envelope_url\": \"verification/folder/1234345\",\n              \"auditor\": {\n                  \"auditor_uid\": \"ABCDEDF\",\n                  \"name\": \"Auditor name\"\n              },\n              \"undertaking\": {\n                  \"company_id\": 10085,\n                  \"domain\": \"FGAS\",\n                  \"name\": \"Company name\"\n              },\n              \"user\": {\n                  \"ecas_id\": \"ecas_id\",\n                  \"username\": \"username\",\n                  \"first_name\": \"First name\",\n                  \"last_name\": \"Last name\",\n                  \"email\": \"mail@test.com\",\n                  \"type\": \"TYPE\"\n              }\n          }\n      ],\n      \"address\": {\n        \"city\": \"city--7953\",\n        \"country\": {\n          \"code\": \"CN\",\n          \"type\": \"NONEU_TYPE\",\n          \"name\": \"China (excluding Hong Kong and Macao)\"\n        },\n        \"zipcode\": \"zipcode--7953\",\n        \"number\": \"nrstreet--7953\",\n        \"street\": \"street--7953\"\n      },\n      \"vat\": null,\n      \"users\": [\n        {\n          \"ecas_id\": \"nzhouray\",\n          \"username\": \"nzhouray\",\n          \"first_name\": \"fname--9367\",\n          \"last_name\": \"lname--9367\",\n          \"email\": \"9367email@climaOds2010.yyy\"\n        }\n      ]\n    }\n\n/undertaking/[domain]/[company_id]/details-short\n-------------------------------------------------\n\nThis url is used to retrive details of a certain company and the contact persons of that company.\n\n    {\n        \"company_id\": 324,\n        \"company_name\": \"NMORGANIZATION--324\",\n        \"address\": \"str--567, 1\",\n        \"postal_code\": \"cp567\",\n        \"city\": \"Darmstadt\",\n        \"country\": \"Germany\",\n        \"eori_code\": \"NREORI324\",\n        \"contact_persons\": [\n          {\n            \"first_name\": \"fname25716\",\n            \"last_name\": \"lname25716\",\n            \"email\": \"25716email@test.yyy\"\n          },\n          {\n            \"first_name\": \"fname--25717\",\n            \"last_name\": \"lname--25717\",\n            \"email\": \"25717email@test.yyy\"\n          }\n        ]\n    }\n\n/undertaking/[domain]/[company_id]/statusupdate - POST\n------------------------------------------------------\n\nThis url is used to update the status of a company from a certain domain by POST method with the new status\n\nLicences calls\n==============\n\n/undertaking/[domain]/[company_id]/licences/[year]/aggregated - POST\n-------------------------------------------------------------\n\nThis url is used to retrive the current delivery of substances for one undertaking in a certain year.\nThe substances can be also filtered by substance name or types(actions), by suppling a JSON of the form:\n\n    {\n      \"substances\": [\"Substance name1\", \"Substance name 2\" ],\n      \"actions\": [\"action1\", \"action2\"]\n    }\n\nResponse example:\n\n    [\n      {\n        \"year\": 2019,\n        \"substance\": \"HCFC-142b (virgin)\",\n        \"quantity\": 1234,\n        \"company_id\": 234,\n        \"use_kind\": \"\",\n        \"use_desc\": \"feedstock\",\n        \"type\": \"export\"\n      },\n      {\n        \"year\": 2019,\n        \"substance\": \"Halon 2402 (non-virgin)\",\n        \"quantity\": 23,\n        \"company_id\": 234,\n        \"use_kind\": \"\",\n        \"use_desc\": \"critical uses\",\n        \"type\": \"export\"\n      }\n    ]\n\n\n/undertaking/[domain]/[pk]/deliveries/[year]/licences - GET\n---------------------------------------------------------------------------\n\nProvies a list with all the licences for one undertaking for a certain year\n\n\n    [\n      {\n        \"year\": 2018,\n        \"licence_id\": 1234,\n        \"chemical_name\": \"HBFC-31 B1\",\n        \"organization_country_name\": \"IT\",\n        \"organization_country_name_orig\": \"Italy\",\n        \"custom_procedure_name\": \"Name\",\n        \"international_party_country_name\": \"US\",\n        \"international_party_country_name_orig\": \"United States of America\",\n        \"total_odp_mass\": 20,\n        \"net_mass\": 4,\n        \"licence_state\": \"CLOSED\",\n        \"long_licence_number\": \"NUMBER2342\",\n        \"template_detailed_use_code\": \"import.of.substance.for.feedstock.use.detailed.use\",\n        \"licence_type\": \"IFDS\",\n        \"mixture_nature_type\": \"VIRGIN\",\n        \"date_created\": \"16/01/2020\",\n        \"date_updated\": null,\n        \"substance_id\": 2\n      },\n      {\n        \"year\": 2018,\n        \"licence_id\": 1235,\n        \"chemical_name\": \"HBFC-31 B1\",\n        \"organization_country_name\": \"IT\",\n        \"organization_country_name_orig\": \"Italy\",\n        \"custom_procedure_name\": \"Release for free circulation\",\n        \"international_party_country_name\": \"US\",\n        \"international_party_country_name_orig\": \"United States of America\",\n        \"total_odp_mass\": 43,\n        \"net_mass\": 32,\n        \"licence_state\": \"CLOSED\",\n        \"long_licence_number\": \"NUMBER23131\",\n        \"template_detailed_use_code\": \"import.of.substance.for.feedstock.use.detailed.use\",\n        \"licence_type\": \"IFDS\",\n        \"mixture_nature_type\": \"VIRGIN\",\n        \"date_created\": \"16/01/2020\",\n        \"date_updated\": null,\n        \"substance_id\": 2\n      }\n    ]\n\n\n/undertaking/[domain]/[pk]/deliveries/[year]/substances - GET\n-----------------------------------------------------------------------------\n\nProvies a list with all the substances for one undertaking for a certain year\n\n\n    [\n      {\n        \"year\": 2018,\n        \"substance\": \"HBFC-31 B1 (virgin)\",\n        \"lic_use_kind\": \"free circulation\",\n        \"lic_use_desc\": \"feedstock\",\n        \"lic_type\": \"import\",\n        \"quantity\": 2342,\n        \"date_created\": \"16/01/2020\",\n        \"date_updated\": \"16/01/2020\",\n        \"delivery_id\": 2\n      },\n      {\n        \"year\": 2018,\n        \"substance\": \"HCFC-22 (virgin)\",\n        \"lic_use_kind\": \"\",\n        \"lic_use_desc\": \"refrigeration\",\n        \"lic_type\": \"export\",\n        \"quantity\": 5433,\n        \"date_created\": \"16/01/2020\",\n        \"date_updated\": \"16/01/2020\",\n        \"delivery_id\": 2\n      }\n    ]\n\nStocks calls\n============\n\n/stocks - GET\n--------------\n\nThis url is used to retrive all the stocks in the database:\n\nResponse example:\n\n    [\n        {\n          \"year\": 2019,\n          \"type\": \"fr\",\n          \"substance_name_form\": \"cfd\",\n          \"is_virgin\": true,\n          \"code\": \"12412\",\n          \"result\": 1234,\n          \"company_id\": 12412,\n          \"company_name\": \"NMORGANIZATION--12412\"\n        },\n        {\n          \"year\": 2019,\n          \"type\": \"fr\",\n          \"substance_name_form\": \"cdf\",\n          \"is_virgin\": true,\n          \"code\": \"43523\",\n          \"result\": 54354,\n          \"company_id\": 1243,\n          \"company_name\": \"NMORGANIZATION--43523\"\n        }\n    ]\n\n/stocks/years/2019 - GET\n------------------------\n\n    [\n      {\n        \"type\": \"cb\",\n        \"substance_name_form\": \"Cdf\",\n        \"is_virgin\": true,\n        \"code\": \"ods12345\",\n        \"result\": 12345\n      },\n      {\n        \"type\": \"d\",\n        \"substance_name_form\": \"Cdf\",\n        \"is_virgin\": true,\n        \"code\": \"ods12345\",\n        \"result\": 12345\n      },\n    ]\n\n/stocks/12345 - POST\n--------------------\n\n    {\n      \"12345\": {\n        \"2019\":\n      }\n    }\n\nUser calls\n==========\n\n\n/user/list\n----------\n\nReturns a list of all undertakings in the system, as fetched from all registries.\n\n    [\n      {\n        \"ecas_id\": \"user1\",\n        \"username\": \"user1\",\n        \"first_name\": \"User 1\",\n        \"last_name\": \"User 1\",\n        \"email\": \"user1@mock.ec.europa.eu\"\n      },\n    ]\n\n/user/[username]/companies\n--------------------------\n\nThe _username_ should be a username (ex: \"user1\")\n\nReturns the list of undertakings for a user given by its unique username.\n\n\n    [\n      {\n        \"collection_id\": null,\n        \"domain\": \"FGAS\",\n        \"country\": \"CN\",\n        \"company_id\": 10085,\n        \"name\": \"FGAS-NMORGANIZATION--10085\",\n        \"respresentative_country\": \"DE\",\n        \"country_history\": [],\n        \"represent_history\": [\n          {\n          \"name\": \"EULEGALNAME44 OLD\",\n          \"contact_last_name\": \"lname--9853\",\n          \"vatnumber\": \"EUVAT45\",\n          \"contact_email\": \"9853email@climaOds2010.yyy\",\n          \"contact_first_name\": \"fname--9853\",\n          \"address\": {\n            \"city\": \"city--7954\",\n            \"country\": {\n              \"code\": \"IE\",\n              \"type\": \"EU_TYPE\",\n              \"name\": \"Ireland\"\n            },\n            \"zipcode\": \"zipcode--7954\",\n            \"number\": \"nrstreet--7954\",\n            \"street\": \"street--7954\"\n        }\n      ],\n      }\n    ]\n\n\n/user/companies?username=[username]\u0026ecas_id=[ecas_id]\n-----------------------------------------------------\n\nThe _username_ should be a username (ex: \"user1\")\nThe _ecas_id_ should be of the same format as the username\n\nReturns the list of undertakings for a user given by its username or ecas_id.\nThe values given are checked against both the username and ecas_id field, to ensure that the user is found.\n\n\n    [\n      {\n        \"collection_id\": null,\n        \"domain\": \"FGAS\",\n        \"country\": \"CN\",\n        \"company_id\": 10085,\n        \"name\": \"FGAS-NMORGANIZATION--10085\",\n        \"respresentative_country\": \"DE\",\n        \"country_history\": [],\n        \"represent_history\": [\n          {\n          \"name\": \"EULEGALNAME44 OLD\",\n          \"contact_last_name\": \"lname--9853\",\n          \"vatnumber\": \"EUVAT45\",\n          \"contact_email\": \"9853email@climaOds2010.yyy\",\n          \"contact_first_name\": \"fname--9853\",\n          \"address\": {\n            \"city\": \"city--7954\",\n            \"country\": {\n              \"code\": \"IE\",\n              \"type\": \"EU_TYPE\",\n              \"name\": \"Ireland\"\n            },\n            \"zipcode\": \"zipcode--7954\",\n            \"number\": \"nrstreet--7954\",\n            \"street\": \"street--7954\"\n        }\n      ],\n      }\n    ]\n\n\n/user/companies/v2?username=[username]\u0026ecas_id=[ecas_id]\n--------------------------------------------------------\n\nThe _username_ should be a username (ex: \"user1\")\nThe _ecas_id_ should be of the same format as the username\n\nReturns the list of undertakings for a user given by its username or ecas_id.\nReturn the list of audited companies and the verification folder url for a user given by its username or ecas_id.\n\nThe values given are checked against both the username and ecas_id field, to ensure that the user is found.\n\n\n    {\n        \"reporter\": [\n            {\n                \"collection_id\": null,\n                \"domain\": \"FGAS\",\n                \"country\": \"CN\",\n                \"company_id\": 10085,\n                \"name\": \"FGAS-NMORGANIZATION--10085\",\n                \"respresentative_country\": \"DE\",\n                \"country_history\": [],\n                \"represent_history\": [\n                    {\n                        \"name\": \"EULEGALNAME44 OLD\",\n                        \"contact_last_name\": \"lname--9853\",\n                        \"vatnumber\": \"EUVAT45\",\n                        \"contact_email\": \"9853email@climaOds2010.yyy\",\n                        \"contact_first_name\": \"fname--9853\",\n                        \"address\": {\n                            \"city\": \"city--7954\",\n                            \"country\": {\n                            \"code\": \"IE\",\n                            \"type\": \"EU_TYPE\",\n                            \"name\": \"Ireland\"\n                            },\n                            \"zipcode\": \"zipcode--7954\",\n                            \"number\": \"nrstreet--7954\",\n                            \"street\": \"street--7954\"\n                        }\n                    }\n                ]\n            }\n        ],\n        \"auditor\": [\n            {   \n                \"verification_envelope_url\": \"verification/envelope/url/\",\n                \"collection_id\": null,\n                \"domain\": \"FGAS\",\n                \"country\": \"CN\",\n                \"company_id\": 10085,\n                \"name\": \"FGAS-NMORGANIZATION--10085\",\n                \"respresentative_country\": \"DE\",\n                \"country_history\": [],\n                \"represent_history\": [\n                    {\n                        \"name\": \"EULEGALNAME44 OLD\",\n                        \"contact_last_name\": \"lname--9853\",\n                        \"vatnumber\": \"EUVAT45\",\n                        \"contact_email\": \"9853email@climaOds2010.yyy\",\n                        \"contact_first_name\": \"fname--9853\",\n                        \"address\": {\n                            \"city\": \"city--7954\",\n                            \"country\": {\n                            \"code\": \"IE\",\n                            \"type\": \"EU_TYPE\",\n                            \"name\": \"Ireland\"\n                            },\n                            \"zipcode\": \"zipcode--7954\",\n                            \"number\": \"nrstreet--7954\",\n                            \"street\": \"street--7954\"\n                        }\n                    }\n                ]\n            }\n        ]\n    }\n\nMatching calls\n==============\n\nThe methods available via HTTP POST should also encapsulate the username, for\nlogging purposes.\n\n/candidate/[domain]/list\n------------------------\n\nLists all possible Company candidates for matching with existing Undertakings from domain.\n\n    [\n      {\n        \"status\": \"VALID\",\n        \"country\": \"Italy\",\n        \"company_id\": 22549,\n        \"name\": \"NMORGANIZATION--22549\"\n      },\n    ]\n\n\n/candidate/[domain]/verify/[undertaking_id]/[oldcompany_id]/ - POST\n-----------------------------------------------\n\nVerifies the link created by the matching algorithm between an Undertaking (from a\ndomain) and a Company from BDR.\n\n    {\n      \"verified\": true,\n      \"company_id\": 10085,\n      \"collection_id\": 3934\n    }\n\n\n/candidate/[domain]/verify-none/[undertaking_id]/ - POST\n-----------------------------------------------\n\nVerifies the Undertaking without a Company link.\n\n    {\n      \"verified\": true,\n      \"company_id\": 10085,\n      \"collection_id\": 3934\n    }\n\n\n/candidate/[domain]/unverify/[undertaking_id]/ - POST\n-------------------------------------------------\n\nUnverify any link between an Undertaking (from a domain) and a Company.\n\n    {\n      \"website\": \"WEBSITE--10085\",\n      \"status\": \"VALID\",\n      \"address_id\": 1,\n      \"name\": \"FGAS-NMORGANIZATION--10085\",\n      \"undertaking_type\": \"FGASUndertaking\",\n      \"date_updated\": \"10/10/2014\",\n      \"represent_id\": 1,\n      \"domain\": \"FGAS\",\n      \"oldcompany_extid\": null,\n      \"phone\": \"+3212310085\",\n      \"oldcompany_verified\": false,\n      \"company_id\": 10085,\n      \"types\": \"FGAS_PRODUCER_IMPORTER_HFCS\",\n      \"country_code\": \"CN\",\n      \"date_created\": \"10/10/2014\",\n      \"oldcompany_account\": null,\n      \"vat\": null,\n      \"businessprofile_id\": 1\n    }\n\n/candidate/[domain]/manual/[undertaking_id]/[oldcompany_account] - POST\n-----------------------------------------------------------------------\n\nManualy link an Undertaking and a Company account, without previous linking by the\nmatching algorithm.\n\n    {\n        \"undertaking_id\": 234,\n        \"oldcompany_account\": \"fgas22331\",\n        \"verified\": true,\n    }\n\n/candidate/[domain]/list/verified - GET\n---------------------------------------\n\nLists the already verified undertakings from a domain.\n\n    [\n      {\n        \"website\": \"WEBSITE--10085\",\n        \"status\": \"VALID\",\n        \"address_id\": 1,\n        \"name\": \"FGAS-NMORGANIZATION--10085\",\n        \"undertaking_type\": \"FGASUndertaking\",\n        \"date_updated\": \"10/10/2014\",\n        \"represent_id\": 1,\n        \"domain\": \"FGAS\",\n        \"oldcompany_extid\": null,\n        \"phone\": \"+3212310085\",\n        \"oldcompany_verified\": true,\n        \"company_id\": 10085,\n        \"types\": \"FGAS_PRODUCER_IMPORTER_HFCS\",\n        \"country_code\": \"CN\",\n        \"date_created\": \"10/10/2014\",\n        \"oldcompany_account\": null,\n        \"vat\": null,\n        \"businessprofile_id\": 1\n      }\n    ]\n\n/match/run - GET\n----------------\n\nRun the matching algorithm. This creates a link between a matching Undertaking and a\nCompany. These links must be manualy verified, using the verified routes explained above.\n\n    {\n        'success': True/False,\n        'message': 'Success/Error message'\n    }\n\n/match/flush - GET\n------------------\n\nClean-up all matching links created by the algorithm, **including** those that were\nverified by a user.\n\n    {\n        'success': True/False,\n        'message': 'Success/Error message'\n    }\n\nExport calls\n============\n\n/export/user/list/[domain]\n-----------------\n\nThis URL is used to export the list of users with their companies and the companies' contact persons as an Excel file.\n\n/export/undertaking/[domain]\n----------------------------\n\nThis URL is used to export the list of undertakings from ``/undertakings/[domain]/list`` as an Excel file.\n\nMails calls\n===========\n\n\n/mail/list\n----------\n\nDisplay the list of all mails to be notified about companies matching.\n\n    [\n      {\n        'mail': 'new@mail.com',\n        'first_name': 'first_name',\n        'last_name': 'last_name'\n      }\n    ]\n\n\n/mail/add - POST\n----------------\n\nAdd a new contact to be notified on matching. The POST should contain the following data:\n\n    {\n      'mail': 'new@mail.com',\n      'first_name': 'first_name',\n      'last_name': 'last_name'\n    }\n\nOn success returns:\n\n    {\n        'success': True\n    }\n\nOn failure returns:\n\n    {\n        'success': False,\n        'message': 'This email address already exists'\n    }\n\n/mail/delete - POST\n-------------------\n\nDelete a contact from the mailing list. The POST should contain the following data:\n\n    {\n      'mail': 'mail_to_be_deleted@example.com',\n    }\n\nOn success returns:\n\n    {\n        'success': True\n    }\n\nOn failure returns:\n\n    {\n        'success': False,\n        'message': 'This email address does not exists'\n    }\n\n/alert_lockdown/wrong_match - POST\n----------------------------------\n\nSend an alert email when a company matching was done wrong. \nThe expected input POST data should consist of an ``user`` and a ``company_id``.\n\n\n/alert_lockdown/wrong_lockdown - POST\n-------------------------------------\n\nIn case the lock down is over and no matching should be changed, the interested parties will be alerted with an email.\nThe expected input POST data should consist of an ``user`` and a ``company_id``.\n\n\n/alert_lockdown/unmatch - POST\n------------------------------\n\nThis mail should be sent when an unmatching call has been made.\nThe expected input POST data should consist of an ``user`` and a ``company_id``.\n\nSync calls\n==================\n\nAll endpoints in this category return a json response with the following format:\n\n\n    {\n        'success': True/False,\n        'message': 'Success/Error message'\n    }\n\n/sync/collections_title - GET\n-----------------------------\n\n/sync/fgases - GET\n------------------\n\nOptional parameters:\n\n* days (integer, default = 7)\n* updated_since (string, datetime format DD/MM/YYYY)\n* id (integer, the external id of the company) \n\n/sync/ods - GET\n---------------\n\nOptional parameters:\n\n* days (integer, default = 7)\n* updated_since (string, datetime format DD/MM/YYYY)\n* id (integer, the external id of the company)\n\n\n/sync/licences -  GET\n---------------------\n\nLog calls\n=========\n\n/log/matching/[domain]\n-------------\n\nLists a matching log list for 2 companies and the user who made it at which\ntime, sorted in decrease order by timestamp.\n\n    [\n      {\n        \"verified\": true,\n        \"timestamp\": \"27/11/2014 15:56\",\n        \"company_id\": 10051,\n        \"user\": \"vitalie\",\n      }\n    ]\n\n\n/log/sync/[domain]\n---------\n\nLists a data sync log which shows when the sync was ran, sorted in decrease\norder by execution_time\n\n    [\n      {\n        \"execution_time\": \"26/11/2014 16:42\",\n        \"organizations\": 413,\n        \"using_last_update\": \"10/10/2014\"\n        \"for_user\": False,\n      }\n    ]\n\nSettings calls\n==============\n\n/settings\n---------\n\nDisplay the value of the configured middleware settings\n\n    {\n      \"BASE_URL\": \"http://example.com\",\n      \"BASE_URL_FGAS\": \"http://example.com\",\n      \"BASE_URL_ODS\": \"http://example.com\"\n    }\n\n\nDebug calls\n==================\n\nAll endpoints in this category return a json response with the following format:\n\n    {\n        'success': True/False,\n        'message': 'Success/Error message'\n    }\n\n/sync/fgases_debug_noneu - GET\n------------------------------\n\nOptional parameters:\n\n* days (integer, default = 7)\n* updated_since (string, datetime format DD/MM/YYYY)\n\n\nSettings calls\n==============\n\n/settings\n---------\n\nDisplay the value of the configured middleware settings\n\n    {\n      \"BASE_URL\": \"http://example.com\",\n      \"BASE_URL_FGAS\": \"http://example.com\",\n      \"BASE_URL_ODS\": \"http://example.com\"\n    }\n\n\nDebug calls\n==================\n\nAll endpoints in this category return a json response with the following format:\n\n    {\n        'success': True/False,\n        'message': 'Success/Error message'\n    }\n\n/sync/fgases_debug_noneu - GET\n------------------------------\n\nOptional parameters:\n\n* days (integer, default = 7)\n* updated_since (string, datetime format DD/MM/YYYY)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feea%2Feuropean.cache.registry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feea%2Feuropean.cache.registry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feea%2Feuropean.cache.registry/lists"}