Skip to content

ValidationAPI.md

Latest commit

 

History

History
44 lines (24 loc) · 3.38 KB

ValidationAPI.md

File metadata and controls

44 lines (24 loc) · 3.38 KB

Validation API Specifications

The validation API specification defines a standard interface for the validation of UBL JSON instances at three levels

  • Structure : that the JSON instance conforms to the corresponding JSON schema for the specific document type as referenced by the "$schema" element in the JSON instance.
  • Codes : that the code values used in the JSON instance are defined in a relevant code-list, which may be either a core code-list or a context specific code list.
  • Rules : that the JSON instance complies with the specific business rules for the implementation context identified by the "ProfileID" element in the JSON instance.

The JSON instances MUST comply with the UBL Syntax 2.0 Specification.

Validation Context

As defined by the UBL Customisation Guide and as implemented by the DBC, UBL allows for the notions of "CustomizationID" and "ProfileID" that are used to define additional restrictions or rules that apply in a specific geographic or industry or process context. In general, the "CustomizationID" represents a broad context whilst "ProfileID" reflects further restrictions within that broad context. The Ausdigital.org suite of semantic specifications uses these two identifiers as follows:

  • There is one "CustomizationID" value that indicates the Australian Digital Business Council restrictions on the global UBL documents. The set of DBC restrictions is evident when comparing the DBC CoreInvoice Schema with the equivalent global UBL 2.1 Invoice Schema.
  • There are a number of "ProfileID" values that represent the rules that apply when the core invoice is used in specific business processes such as RCTI, TaXReceipt, CreditNote, etc. The rules are defined with each semantic specification (eg billing semantics

All validation rules are tagged with the relevant customizationID(s) and profileID(s) that apply. Each instance document also contains both these identifiers. Therefore the validation model is to examine the instance document to determine which validation rules should be applied.

API Validator Specification

Is maintained at swaggerhub : UBL Syntax 2.0 Transformation and Validation API

The API is very simple - it accepts an instance document and returns a list of zero or more error responses. All error responses will comply with the ausdigital standard RESTful Errors structure.

Document Structure Error Response Codes

Error Code Error Message
struct-01 The $schema reference is missing and so this document cannot be validated
struct-02
struct-03

Code-List Error Response Codes

Are maintained together with the code-lists specification

Business Rules Error Response Codes

Are maintained together with the relevant semantic specification - for example billing semantics