Types

The Personalia API uses various types used to transfer data from and to the API. These types are defined in API DataType documents, which describe the known types, their properties and rules for those properties. API DataType documents can be maintained by API users using the Portal. This allows API users to introduce their own validation rules for properties of those types, so data can be validated according to their own needs.

Supported formats:

RAML:

RAML is a language for the definition of HTTP-based APIs that embody most or all of the principles of Representational State Transfer (REST). It is machine readable API design and is also human friendly. See the RAML website for more information.

Example of a RAML DataType document:

#%RAML 1.0 DataType
# Error entity 
type: object
additionalProperties: false
displayName: Error
description: An entity that contains information about an error.
xml: 
  name: error
  namespace: https://general.apiwebservices.com
properties: 
  code: 
    type: string
    required: true
    description: A code that identifies the error.
  index:
    type: number
    required: false
    default: -1
    description: If applicable, the zero based index of an item in a collection that is related to the error.
  message:
    type: string
    required: false
    default:
    description: A human readable text that provides additional information about the error.  

 

Available Types:

Name	Description
Error	An entity that contains information about an error.
Person	An entity that contains information about a person