CodBiOpenPLZQueryAction

class CodBiOpenPLZQueryAction : IPluginServletAction

Questo servlet funge da nano server per passare la richiesta da un modulo utilizzando CodBi insieme al file OpenPLZ REST API (consulta la documentazione per ulteriori informazioni informazioni sul parametro di intestazione). A differenza del servizio REST che restituisce risultati impaginati, questo servlet accumula tutti i dati disponibili e li restituisce come un unico blocco.

Chiavi di configurazione:

  • OpenPLZ_URL: l'URL dell'endpoint da utilizzare.

  • OpenPLZ_UpdateCycle: il numero di ore di attesa finché una richiesta non provoca una nuova richiesta REST.

Intestazione:

  • country: il codice del paese di cui recuperare i dati.

  • orgaUnit: l'unità organizzativa da recuperare (ad esempio /de/ FederalStates). Questo potrebbe essere Stati federali, Province federali o Cantoni.

  • officialKey La chiave opzionale (numero) di uno stato, provincia o cantone da cui ottenere dettagli.

  • dettaglio: il dettaglio facoltativo da recuperare su un determinato stato, provincia o cantone identificato da la officialKey (non opzionale se è presente una chiave ufficiale). Possono essere Comuni, o Distretti.

  • param1 Possono essere passati fino a quattro parametri lungo la richiesta (ad esempio postalCode, nome, località, searchTerm).

  • param2 Possono essere passati fino a quattro parametri lungo la richiesta (ad esempio postalCode, nome, località, searchTerm).

  • param3 Possono essere passati fino a quattro parametri lungo la richiesta (ad esempio postalCode, nome, località, searchTerm).

  • param4 Possono essere passati fino a quattro parametri lungo la richiesta (ad esempio postalCode, nome, località, searchTerm).

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open override fun execute(p0: IPluginServletActionParams): IPluginServletActionRetVal

Recupera la directory delle autorità dall'API OpenPLZ. Implementazione mancante: buffering di dati e richiederli nuovamente dopo un certo numero di ore.

Link copied to clipboard
Link copied to clipboard
open override fun getDisplayName(p0: Locale): String
Link copied to clipboard
open override fun getName(): String

Returns "CodBi_OpenPLZ_Query"

Link copied to clipboard
open override fun initialize(configData: IPluginInitializeData)

Imposta nome utente, password (anche recuperando la directory dei contatti in buffer utilizzando credenziali fornite) e facoltativamente url.

Link copied to clipboard
open fun initPlugin()
Link copied to clipboard
open fun install(p0: IPluginInstallData)
Link copied to clipboard
open fun shutdown()
open fun shutdown(p0: IPluginShutdownData)
Link copied to clipboard
open fun uninstall(p0: IPluginUninstallData)
Link copied to clipboard
open override fun validateConfigurationData(configData: IPluginValidationData): IPluginInitializeValidationResult?

Aggiorna nome utente, password e hrsTillUpdate.