6. Odczyt informacji diagnostycznych

Biblioteka pozwala na pobranie informacji-komunikatów z API.

Służy do tego metoda GetValue, której parametr określa jakie informacje chcemy uzyskać.
Zwraca ona obiekt GetValueResponse, który w parametrze Result przedstawia zwrócone dane w postaci tekstu.
Rzutując go na odpowiedni interfejs możemy uzyskać parametr odpowiadający zwracanej informacji.

Możliwe parametry:

• GetValueType.StanDanych - Zwracana jest informacja o stanie danych jaki jest udostępniany.
• GetValueType.KomunikatKod - Zwraca kod komunikatu.
• GetValueType.KomunikatTresc - Zwraca treść komunikatu.
• GetValueType.StatusSesji - Zwraca status sesji.
• GetValueType.StatusUslugi - Zwraca status usługi. (Wywołanie nie wymaga aktywnej sesji)
• GetValueType.KomunikatUslugi - Zwraca komunikat usługi. (Wywołanie nie wymaga aktywnej sesji)

Interfejsy i wartości parametru Result:

• IStanDanych - stan danych w postaci tekstu (string)
• IKomunikatKod - kod komunikatu (uint?)
• IKomunikatTresc - treść komunikatu w postaci tekstu (string)
• IStatusSesji - wartość true albo false w zależności czy sesja jest aktywna czy nie (bool)
• IStatusUslugi - status usługi (StatusUslugi - enum)

StatusUslugi - wartości:

• StatusUslugi.NIEDOSTEPNA - usługa niedostępna
• StatusUslugi.DOSTEPNA - usługa dostępna
• StatusUslugi.PRZERWA_TECHNICZNA - przerwa techniczna

Przykłady

Sprawdzenie stanu danych

var response = (IStanDanych) gusClient.GetValue(GetValueType.StanDanych);

Console.WriteLine(response.Result);

Sprawdzenie dostępności usługi

var response = (IStatusUslugi) gusClient.GetValue(GetValueType.StatusUslugi);

if(response.Result==StatusUslugi.NIEDOSTEPNA || response.Result==StatusUslugi.PRZERWA_TECHNICZNA){
    Console.WriteLine("Usługa GUS REGON API jest niedostępna.");
}else{
    Console.WriteLine("Usługa działa poprawnie!");
}

Sprawdzenie aktywności sesji

var response = (IStatusSesji) gusClient.GetValue(GetValueType.StatusSesji);

if(response.Result){
    Console.WriteLine("Sesja aktywna.");
}else{
    Console.WriteLine("Sesja nieaktywna.");
}

Więcej informacji na temat znaczenia zwracanych wartości, można znaleźć w dokumentacji GUS REGON API.