Skip to content

EuropeanStudentCard/escn-java-validator-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ESCN Validator Client

License

EscnClientFactory is a Java client designed to interact with the European Student Card Router application (ESC-R) API. It provides functionality to validate ESCN (European Student Card Numbers) using a RESTful API endpoint. This class is part of a larger library aimed at simplifying integration with ESC services.

Usage

Creating an Instance of EscnClientFactory

You can create an instance of EscnClientFactory with the default host or a specified host.

Default Host

EscnClientFactory factory = EscnClientFactory.create();

Specified Host

EscnClientFactory factory = EscnClientFactory.create("http://your-custom-host.com");

Validating an ESCN

To validate an ESCN, use the validateEscn method. This method throws IOException and URISyntaxException if an error occurs during the request.

  String escn = "123456789012";
  CardVO card = factory.validateEscn(escn);

Class Documentation

EscnClientFactory

Factory class for creating instances of ESCN Client.

Methods
  • create(): Creates a new instance of EscnClientFactory with the default host URL.
  • create(String host): Creates a new instance of EscnClientFactory with a specified host URL.
  • CardVO validateEscn(String escn): Validates the given ESCN and returns a CardVO object containing the validation result.

About

This Java client library validates European Student Card Numbers (ESCN), enabling ESC-R users to confirm the authenticity and correctness of ESCNs.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages