Commit 62409699 authored by Sarah Werner's avatar Sarah Werner
Browse files

Added and updated descriptions and changed field names and order according to feedback received.

parent e05fa8af
Loading
Loading
Loading
Loading
Loading
+92 −47
Original line number Diff line number Diff line
@@ -409,17 +409,21 @@
    },
    "ValidityPeriod": {
      "type": "object",
      "description": "Validity time period",
      "properties": {
        "begin": {
          "$ref": "ts_103280_2017_07#/$defs/QualifiedMicrosecondDateTime" 
          "$ref": "ts_103280_2017_07#/$defs/QualifiedMicrosecondDateTime",
          "description": "Start of the validity period" 
        },
        "end": {
          "$ref": "ts_103280_2017_07#/$defs/QualifiedMicrosecondDateTime" 
          "$ref": "ts_103280_2017_07#/$defs/QualifiedMicrosecondDateTime",
          "description": "End of the validity period" 
        }
      }
    },
    "Person": {
      "type": "object",
      "description": "Natural person",
      "properties": {
        "surname": {
          "type": "string",
@@ -430,31 +434,39 @@
          "description" : "Given names, forenames, familiar names and any other secondary names"
        },
        "initials": {
          "type": "string"
          "type": "string",
          "description": "Initials of the person" 
        },
        "salutation": {
          "type": "string"
          "type": "string",
          "description": "Salutation of the person" 
        },
        "sex": {
          "type": "string",
          "pattern": "[FMX]",
          "enum": [
            "F", 
            "M", 
            "X"
          ],
          "description": "F = female; M = male; X = unspecified; according to e.g. ICAO Document 9303 part 4 clause 4.1.1"
        },
        "dateOfBirth": {
          "$ref": "#/$defs/Date" 
          "$ref": "#/$defs/Date",
          "description": "Date of birth of the person" 
        }
      }
    },
    "Date": {
      "type": "string",
      "pattern": "[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])",
      "description": "Date in format YYYY-MM-DD"
      "description": "Date in format YYYY-MM-DD according to ISO 8601"
    },
    "Organisation": {
      "type": "object",
      "description": "Organisation, juridical person",
      "properties" : {
        "name": {
          "type": "string" 
          "type": "string", 
          "description": "Name of the organisation" 
        },
        "VATNumber": {
          "type": "string", 
@@ -465,12 +477,15 @@
    },     
    "BankAccount": {
     "type": "object",
     "description": "Bank account information",
     "properties": {
        "iBAN": { 
          "$ref": "#/$defs/IBAN"
          "$ref": "#/$defs/IBAN",
          "description": "International Bank Account Number of the bank account" 
        },
        "accountHolder": {
          "type": "string"	
          "type": "string",
          "description": "Holder of the bank account"
        }         
      }
    },
@@ -481,37 +496,46 @@
    },    
    "PaymentCard": {
      "type": "object",
      "description": "Payment card information",
      "properties": {
        "cardNumber": {
          "$ref": "#/$defs/PaymentCardNumber"
          "$ref": "#/$defs/PaymentCardNumber",
          "description": "Number of the payment card, e.g. credit card number"
        },
        "cardHolder" : {
          "type": "string"
          "type": "string",
          "description": "Holder of the payment card"
        }, 
        "cardType": {	
          "type": "string",
          "description": "Nature of the card, e.g. VISA"
          "description": "Type of the payment card, e.g. VISA"
        },
        "dateOfExpiry": { 
          "$ref": "ts_103280_2017_07#/$defs/QualifiedDateTime" 
          "$ref": "#/$defs/Date",
          "description": "Date of expiry of the payment card" 
        }            
      }
    },
    "PaymentCardNumber": {
      "type": "string",
      "pattern": "^\\d{8,19}$"
      "pattern": "^\\d{8,19}$",
      "description": "Number of a payment card"
    }, 
    "Contract": {
      "type": "object", 
      "description": "Contract information",
      "properties": {
        "id": {
          "type": "string"
          "type": "string",
          "description": "Contract number"
        },             
        "begin": { 
          "$ref": "ts_103280_2017_07#/$defs/QualifiedDateTime" 
          "$ref": "ts_103280_2017_07#/$defs/QualifiedDateTime",
          "description": "Start of the contract" 
        },
        "end": { 
          "$ref": "ts_103280_2017_07#/$defs/QualifiedDateTime" 
          "$ref": "ts_103280_2017_07#/$defs/QualifiedDateTime", 
          "description": "End of the contract"
        },
        "natureOfContract": { 
          "type": "string",
@@ -519,91 +543,112 @@
        }  
      }
    },
    "ContactDetails": {
    "ContactDetail": {
      "type": "object",
      "description": "Contact detail information",
      "properties": {
        "emailAddress": {
        "emailAddresses": {
			    "type": "array",
			    "items": {
				    "$ref": "ts_103280_2017_07#/$defs/InternationalizedEmailAddress" 
			    }
			    },
        "phoneNumber": {
          "description": "Email addresses of the contact"
        },               
        "phoneNumbers": {
			    "type": "array",
			    "items": {
				    "$ref": "ts_103280_2017_07#/$defs/InternationalE164" 
			    }
			    },
        "address": {
          "description": "Phone numbers of the contact"
        },
        "addresses": {
			    "type": "array",
			    "items": {
				    "$ref": "#/$defs/Address"
			    }
			    },
          "description": "Addresses of the contact"
        }
      }
    },
    "Address": {
      "type": "object",
      "description": "Address information",
      "properties": {
        "street": {
          "type": "string"
          "type": "string",
          "description": "Street of the address"
        },
        "houseNumber": { 
          "type": "string" 
          "type": "string", 
          "description": "House number of the street and other specific extensions"
        },
        "city": { 
          "type": "string" 
          "type": "string", 
          "description": "City of the address"
        },
        "postalCode": { 
          "type": "string" 
          "type": "string",
          "description": "Postal code of the address"
        },
        "countryCode": { 
          "$ref": "ts_103280_2017_07#/$defs/ISOCountryCode"
          "$ref": "ts_103280_2017_07#/$defs/ISOCountryCode",
          "description": "Country code of the address"
        }
      }
    },
    "IdentityVerification": {
      "type": "object",
      "description": "Identity verfication information",
      "properties": {
        "typeOfIdentityVerficationDocument": {
        "typeOfDocument": {
          "type": "string",
          "description": "Type of the identity verification document, e.g. identity card"
        },  
        "documentFile": {
          "$ref": "#/$defs/DocumentFile",
          "description": "Document file, e.g. copy of the identity card"
        },
        "documentNumber": {
          "type": "string"
          "type": "string",
          "description": "Document number of the document used for identity verification, e.g. identity card number"
        },          
        "issuingAuthority": {
          "type": "string"
          "type": "string",
          "description": "Issuing authority of the document used for identity verfication, e.g. of the identity card"
        },   
        "dateOfExpiry": {
          "$ref": "ts_103280_2017_07#/$defs/QualifiedDateTime" 
          "$ref": "#/$defs/Date",
          "description": "Date of expiry of the document used for identity verfication, e.g. of the identity card"
        },
        "countryCode": {
          "$ref": "ts_103280_2017_07#/$defs/ISOCountryCode"
        },
        "identityVerficiationDocumentFile": {
          "$ref": "#/$defs/DocumentFile"
          "$ref": "ts_103280_2017_07#/$defs/ISOCountryCode",
          "description": "Country code where the document used for identify verification (e.g. the identity card) is issued"
        }       
      }
    },
    "DocumentFile": {
      "type": "object",
      "description": "Document file",
      "properties": {
        "natureOfDocument": {
          "type": "string",
          "description": "Nature of the document, e.g. invoice"
        },
        "fileName": {
          "type": "string" 
          "type": "string", 
          "description": "File name of the document"
        },             
        "mimeType": {
         "type": "string" 
        },           
        "natureOfDocument": {
          "type": "string"
         "type": "string",
         "description": "Mime type of the document"
        },                  
        "content": {
          "type": "string",
          "description": "Content of the file base64 encoded"
        },
        "checksum": {          
          "$ref": "ts_103280_2017_07#/$defs/ShortString"        
          "$ref": "ts_103280_2017_07#/$defs/ShortString",
          "description": "Checksum computed for the document using the algoritm provided in checksumType"        
        },        
        "checksumType": {          
          "$ref": "ts_103280_2017_07#/$defs/ShortString",