SOAP support module for Gusex.
Summary
Functions
Generate SOAP envelope for retrieving a full report for a specific entity in BIR service. Accepts a REGON number, report name, and endpoint URL. Returns a string containing the SOAP envelope XML.
Generate SOAP envelope for retrieving an aggregate report from BIR service. Accepts a report date, report name, and endpoint URL. Returns a string containing the SOAP envelope XML.
Generate SOAP envelope for searching entities in BIR service. Accepts a
%ParametryWyszukiwania{} struct and an endpoint URL, which can be either the
test or production URL. Returns a string containing the SOAP envelope XML.
Generate SOAP envelope for retrieving a service parameter value from BIR service. Accepts a parameter name and endpoint URL. Returns a string containing the SOAP envelope XML.
Generate SOAP envelope for logging out from BIR service. Accepts a session ID and endpoint URL. Returns a string containing the SOAP envelope XML.
Generate SOAP envelope for logging in to BIR service. Accepts a user key and
an optional environment parameter (default is :test). Returns a string
containing the SOAP envelope XML.
Functions
Generate SOAP envelope for retrieving a full report for a specific entity in BIR service. Accepts a REGON number, report name, and endpoint URL. Returns a string containing the SOAP envelope XML.
Parameters
regon: The REGON number of the entity (9 or 14 digits).report_name: The name of the report to retrieve (e.g., "BIR12OsPrawna", "BIR12OsFizycznaDaneOgolne").endpoint_url: The endpoint URL for the BIR service, which can be either the test or production URL.
Returns
- A string containing the SOAP envelope XML for the full report request.
Generate SOAP envelope for retrieving an aggregate report from BIR service. Accepts a report date, report name, and endpoint URL. Returns a string containing the SOAP envelope XML.
Parameters
report_date: The date for the report in the only correct format: "YYYY-MM-DD".report_name: The name of the aggregate report to retrieve.endpoint_url: The endpoint URL for the BIR service, which can be either the test or production URL.
Returns
- A string containing the SOAP envelope XML for the aggregate report request.
Generate SOAP envelope for searching entities in BIR service. Accepts a
%ParametryWyszukiwania{} struct and an endpoint URL, which can be either the
test or production URL. Returns a string containing the SOAP envelope XML.
Parameters
search_params: A %Gusex.Types.ParametryWyszukiwania{} struct containing search parameters.endpoint_url: The endpoint URL for the BIR service, which can be either the test or production URL.
Returns
- A string containing the SOAP envelope XML for the entity search request.
Generate SOAP envelope for retrieving a service parameter value from BIR service. Accepts a parameter name and endpoint URL. Returns a string containing the SOAP envelope XML.
Parameters
parameter_name: The name of the parameter to retrieve (e.g., "StatusSesji", "KomunikatKod").endpoint_url: The endpoint URL for the BIR service, which can be either the test or production URL.
Returns
- A string containing the SOAP envelope XML for the parameter value request.
Generate SOAP envelope for logging out from BIR service. Accepts a session ID and endpoint URL. Returns a string containing the SOAP envelope XML.
Parameters
session_id: The session identifier to terminate.endpoint_url: The endpoint URL for the BIR service, which can be either the test or production URL.
Returns
- A string containing the SOAP envelope XML for the logout request.
Generate SOAP envelope for logging in to BIR service. Accepts a user key and
an optional environment parameter (default is :test). Returns a string
containing the SOAP envelope XML.
Parameters
user_key: The user key for authentication.endpoint_url: The endpoint URL for the BIR service, which can be either the test or production URL.
Returns
- A string containing the SOAP envelope XML for the login request.