docs.jsonld
type: ApiDocumentation
title: SocioLink API Family
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Child
supported class: Family
supported class: Marriage
supported class: Address
supported class: Certificate
supported class: Language
supported class: Origin
supported class: Person
supported class: Logger
supported class: Notification
supported class: Session
supported class: User
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
subclass of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
subclass of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

Child
type: Class
title: Child
supported property: SupportedProperty
  property: Child/itAdoptive
  title: itAdoptive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/childApproved
  title: childApproved
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/child
  title: child
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/family
  title: family
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Child/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Child resource.
  method: GET
  returns: Child
  title: getChild
supported operation: Operation
  description: Updates the Child resource.
  expects: Child
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Child
  title: patchChild

Child/itAdoptive
type: Property
domain: Child
the hydra core vocabulary: itAdoptive
range: boolean

Child/childApproved
type: Property
domain: Child
the hydra core vocabulary: childApproved
range: boolean

Child/description
type: Property
domain: Child
the hydra core vocabulary: description
range: string

Child/child
type: Link
domain: Child
the hydra core vocabulary: child
max cardinality: 1
range: Person

Child/family
type: Link
domain: Child
the hydra core vocabulary: family
max cardinality: 1
range: Family

Child/status
type: Property
domain: Child
the hydra core vocabulary: status
range: string

Child/details
type: Property
domain: Child
the hydra core vocabulary: details

Child/createdAt
type: Property
domain: Child
the hydra core vocabulary: createdAt
range: dateTime

Child/updatedAt
type: Property
domain: Child
the hydra core vocabulary: updatedAt
range: dateTime

Child/createdBy
type: Link
domain: Child
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Child/updatedBy
type: Link
domain: Child
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Child/itDeleted
type: Property
domain: Child
the hydra core vocabulary: itDeleted
range: boolean

Child/deletedAt
type: Property
domain: Child
the hydra core vocabulary: deletedAt
range: dateTime

Child/deletedBy
type: Link
domain: Child
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Child/itErased
type: Property
domain: Child
the hydra core vocabulary: itErased
range: boolean

Child/erasedAt
type: Property
domain: Child
the hydra core vocabulary: erasedAt
range: dateTime

Child/erasedBy
type: Link
domain: Child
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Family
type: Class
title: Family
supported property: SupportedProperty
  property: Family/fatherApproved
  title: fatherApproved
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/motherApproved
  title: motherApproved
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/itMatriarchy
  title: itMatriarchy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/father
  title: father
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/mother
  title: mother
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/marriage
  title: marriage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/children
  title: children
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Family/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Family resource.
  method: GET
  returns: Family
  title: getFamily
supported operation: Operation
  description: Updates the Family resource.
  expects: Family
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Family
  title: patchFamily

Family/fatherApproved
type: Property
domain: Family
the hydra core vocabulary: fatherApproved
range: boolean

Family/motherApproved
type: Property
domain: Family
the hydra core vocabulary: motherApproved
range: boolean

Family/itMatriarchy
type: Property
domain: Family
the hydra core vocabulary: itMatriarchy
range: boolean

Family/description
type: Property
domain: Family
the hydra core vocabulary: description
range: string

Family/father
type: Link
domain: Family
the hydra core vocabulary: father
max cardinality: 1
range: Person

Family/mother
type: Link
domain: Family
the hydra core vocabulary: mother
max cardinality: 1
range: Person

Family/marriage
type: Link
domain: Family
the hydra core vocabulary: marriage
max cardinality: 1
range: Marriage

Family/children
type: Link
domain: Family
the hydra core vocabulary: children
range: Child

Family/status
type: Property
domain: Family
the hydra core vocabulary: status
range: string

Family/details
type: Property
domain: Family
the hydra core vocabulary: details

Family/createdAt
type: Property
domain: Family
the hydra core vocabulary: createdAt
range: dateTime

Family/updatedAt
type: Property
domain: Family
the hydra core vocabulary: updatedAt
range: dateTime

Family/createdBy
type: Link
domain: Family
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Family/updatedBy
type: Link
domain: Family
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Family/itDeleted
type: Property
domain: Family
the hydra core vocabulary: itDeleted
range: boolean

Family/deletedAt
type: Property
domain: Family
the hydra core vocabulary: deletedAt
range: dateTime

Family/deletedBy
type: Link
domain: Family
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Family/itErased
type: Property
domain: Family
the hydra core vocabulary: itErased
range: boolean

Family/erasedAt
type: Property
domain: Family
the hydra core vocabulary: erasedAt
range: dateTime

Family/erasedBy
type: Link
domain: Family
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Marriage
type: Class
title: Marriage
supported property: SupportedProperty
  property: Marriage/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/marriageDate
  title: marriageDate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/marriageCity
  title: marriageCity
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/document
  title: document
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/documentUri
  title: documentUri
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Marriage/documentFile
  title: documentFile
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Marriage/marriageCountry
  title: marriageCountry
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/firstWitness
  title: firstWitness
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/secondWitness
  title: secondWitness
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/family
  title: family
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Marriage/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Marriage resource.
  method: GET
  returns: Marriage
  title: getMarriage
supported operation: Operation
  description: Updates the Marriage resource.
  expects: Marriage
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Marriage
  title: patchMarriage

Marriage/reference
type: Property
domain: Marriage
the hydra core vocabulary: reference
range: string

Marriage/marriageDate
type: Property
domain: Marriage
the hydra core vocabulary: marriageDate
range: dateTime

Marriage/marriageCity
type: Property
domain: Marriage
the hydra core vocabulary: marriageCity
range: string

Marriage/document
type: Property
domain: Marriage
the hydra core vocabulary: document
range: string

Marriage/documentUri
type: Property
domain: Marriage
the hydra core vocabulary: documentUri
range: string

Marriage/documentFile
type: Property
domain: Marriage
the hydra core vocabulary: documentFile

Marriage/marriageCountry
type: Property
domain: Marriage
the hydra core vocabulary: marriageCountry
range: string

Marriage/firstWitness
type: Link
domain: Marriage
the hydra core vocabulary: firstWitness
max cardinality: 1
range: Person

Marriage/secondWitness
type: Link
domain: Marriage
the hydra core vocabulary: secondWitness
max cardinality: 1
range: Person

Marriage/family
type: Link
domain: Marriage
the hydra core vocabulary: family
max cardinality: 1
range: Family

Marriage/status
type: Property
domain: Marriage
the hydra core vocabulary: status
range: string

Marriage/details
type: Property
domain: Marriage
the hydra core vocabulary: details

Marriage/createdAt
type: Property
domain: Marriage
the hydra core vocabulary: createdAt
range: dateTime

Marriage/updatedAt
type: Property
domain: Marriage
the hydra core vocabulary: updatedAt
range: dateTime

Marriage/createdBy
type: Link
domain: Marriage
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Marriage/updatedBy
type: Link
domain: Marriage
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Marriage/itDeleted
type: Property
domain: Marriage
the hydra core vocabulary: itDeleted
range: boolean

Marriage/deletedAt
type: Property
domain: Marriage
the hydra core vocabulary: deletedAt
range: dateTime

Marriage/deletedBy
type: Link
domain: Marriage
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Marriage/itErased
type: Property
domain: Marriage
the hydra core vocabulary: itErased
range: boolean

Marriage/erasedAt
type: Property
domain: Marriage
the hydra core vocabulary: erasedAt
range: dateTime

Marriage/erasedBy
type: Link
domain: Marriage
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Address
type: Class
title: Address
supported property: SupportedProperty
  property: Address/street
  title: street
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/quarter
  title: quarter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/township
  title: township
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/city
  title: city
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/region
  title: region
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/person
  title: person
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Address/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Address resource.
  method: GET
  returns: Address
  title: getAddress
supported operation: Operation
  description: Updates the Address resource.
  expects: Address
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Address
  title: patchAddress

Address/street
type: Property
domain: Address
the hydra core vocabulary: street
range: string

Address/quarter
type: Property
domain: Address
the hydra core vocabulary: quarter
range: string

Address/township
type: Property
domain: Address
the hydra core vocabulary: township
range: string

Address/city
type: Property
domain: Address
the hydra core vocabulary: city
range: string

Address/region
type: Property
domain: Address
the hydra core vocabulary: region
range: string

Address/country
type: Property
domain: Address
the hydra core vocabulary: country
range: string

Address/person
type: Link
domain: Address
the hydra core vocabulary: person
max cardinality: 1
range: Person

Address/status
type: Property
domain: Address
the hydra core vocabulary: status
range: string

Address/details
type: Property
domain: Address
the hydra core vocabulary: details

Address/createdAt
type: Property
domain: Address
the hydra core vocabulary: createdAt
range: dateTime

Address/updatedAt
type: Property
domain: Address
the hydra core vocabulary: updatedAt
range: dateTime

Address/createdBy
type: Link
domain: Address
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Address/updatedBy
type: Link
domain: Address
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Address/itDeleted
type: Property
domain: Address
the hydra core vocabulary: itDeleted
range: boolean

Address/deletedAt
type: Property
domain: Address
the hydra core vocabulary: deletedAt
range: dateTime

Address/deletedBy
type: Link
domain: Address
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Address/itErased
type: Property
domain: Address
the hydra core vocabulary: itErased
range: boolean

Address/erasedAt
type: Property
domain: Address
the hydra core vocabulary: erasedAt
range: dateTime

Address/erasedBy
type: Link
domain: Address
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Certificate
type: Class
title: Certificate
supported property: SupportedProperty
  property: Certificate/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/docDate
  title: docDate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/document
  title: document
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/documentUri
  title: documentUri
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Certificate/documentFile
  title: documentFile
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Certificate/person
  title: person
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Certificate/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Certificate resource.
  method: GET
  returns: Certificate
  title: getCertificate
supported operation: Operation
  description: Updates the Certificate resource.
  expects: Certificate
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Certificate
  title: patchCertificate

Certificate/category
type: Property
domain: Certificate
the hydra core vocabulary: category
range: string

Certificate/docDate
type: Property
domain: Certificate
the hydra core vocabulary: docDate
range: dateTime

Certificate/description
type: Property
domain: Certificate
the hydra core vocabulary: description
range: string

Certificate/document
type: Property
domain: Certificate
the hydra core vocabulary: document
range: string

Certificate/documentUri
type: Property
domain: Certificate
the hydra core vocabulary: documentUri
range: string

Certificate/documentFile
type: Property
domain: Certificate
the hydra core vocabulary: documentFile

Certificate/person
type: Link
domain: Certificate
the hydra core vocabulary: person
max cardinality: 1
range: Person

Certificate/status
type: Property
domain: Certificate
the hydra core vocabulary: status
range: string

Certificate/details
type: Property
domain: Certificate
the hydra core vocabulary: details

Certificate/createdAt
type: Property
domain: Certificate
the hydra core vocabulary: createdAt
range: dateTime

Certificate/updatedAt
type: Property
domain: Certificate
the hydra core vocabulary: updatedAt
range: dateTime

Certificate/createdBy
type: Link
domain: Certificate
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Certificate/updatedBy
type: Link
domain: Certificate
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Certificate/itDeleted
type: Property
domain: Certificate
the hydra core vocabulary: itDeleted
range: boolean

Certificate/deletedAt
type: Property
domain: Certificate
the hydra core vocabulary: deletedAt
range: dateTime

Certificate/deletedBy
type: Link
domain: Certificate
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Certificate/itErased
type: Property
domain: Certificate
the hydra core vocabulary: itErased
range: boolean

Certificate/erasedAt
type: Property
domain: Certificate
the hydra core vocabulary: erasedAt
range: dateTime

Certificate/erasedBy
type: Link
domain: Certificate
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Language
type: Class
title: Language
supported property: SupportedProperty
  property: Language/language
  title: language
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/person
  title: person
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Language resource.
  method: GET
  returns: Language
  title: getLanguage
supported operation: Operation
  description: Updates the Language resource.
  expects: Language
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Language
  title: patchLanguage

Language/language
type: Property
domain: Language
the hydra core vocabulary: language
range: string

Language/person
type: Link
domain: Language
the hydra core vocabulary: person
max cardinality: 1
range: Person

Language/status
type: Property
domain: Language
the hydra core vocabulary: status
range: string

Language/details
type: Property
domain: Language
the hydra core vocabulary: details

Language/createdAt
type: Property
domain: Language
the hydra core vocabulary: createdAt
range: dateTime

Language/updatedAt
type: Property
domain: Language
the hydra core vocabulary: updatedAt
range: dateTime

Language/createdBy
type: Link
domain: Language
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Language/updatedBy
type: Link
domain: Language
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Language/itDeleted
type: Property
domain: Language
the hydra core vocabulary: itDeleted
range: boolean

Language/deletedAt
type: Property
domain: Language
the hydra core vocabulary: deletedAt
range: dateTime

Language/deletedBy
type: Link
domain: Language
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Language/itErased
type: Property
domain: Language
the hydra core vocabulary: itErased
range: boolean

Language/erasedAt
type: Property
domain: Language
the hydra core vocabulary: erasedAt
range: dateTime

Language/erasedBy
type: Link
domain: Language
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Origin
type: Class
title: Origin
supported property: SupportedProperty
  property: Origin/tribe
  title: tribe
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/street
  title: street
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/quarter
  title: quarter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/township
  title: township
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/city
  title: city
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/region
  title: region
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/person
  title: person
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Origin/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Origin resource.
  method: GET
  returns: Origin
  title: getOrigin
supported operation: Operation
  description: Updates the Origin resource.
  expects: Origin
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Origin
  title: patchOrigin

Origin/tribe
type: Property
domain: Origin
the hydra core vocabulary: tribe
range: string

Origin/street
type: Property
domain: Origin
the hydra core vocabulary: street
range: string

Origin/quarter
type: Property
domain: Origin
the hydra core vocabulary: quarter
range: string

Origin/township
type: Property
domain: Origin
the hydra core vocabulary: township
range: string

Origin/city
type: Property
domain: Origin
the hydra core vocabulary: city
range: string

Origin/region
type: Property
domain: Origin
the hydra core vocabulary: region
range: string

Origin/country
type: Property
domain: Origin
the hydra core vocabulary: country
range: string

Origin/person
type: Link
domain: Origin
the hydra core vocabulary: person
max cardinality: 1
range: Person

Origin/status
type: Property
domain: Origin
the hydra core vocabulary: status
range: string

Origin/details
type: Property
domain: Origin
the hydra core vocabulary: details

Origin/createdAt
type: Property
domain: Origin
the hydra core vocabulary: createdAt
range: dateTime

Origin/updatedAt
type: Property
domain: Origin
the hydra core vocabulary: updatedAt
range: dateTime

Origin/createdBy
type: Link
domain: Origin
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Origin/updatedBy
type: Link
domain: Origin
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Origin/itDeleted
type: Property
domain: Origin
the hydra core vocabulary: itDeleted
range: boolean

Origin/deletedAt
type: Property
domain: Origin
the hydra core vocabulary: deletedAt
range: dateTime

Origin/deletedBy
type: Link
domain: Origin
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Origin/itErased
type: Property
domain: Origin
the hydra core vocabulary: itErased
range: boolean

Origin/erasedAt
type: Property
domain: Origin
the hydra core vocabulary: erasedAt
range: dateTime

Origin/erasedBy
type: Link
domain: Origin
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Person
type: Class
title: Person
supported property: SupportedProperty
  property: Person/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/pseudonym
  title: pseudonym
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/phone
  title: phone
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/nationality
  title: nationality
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/itExpatriate
  title: itExpatriate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/trueNameAllowed
  title: trueNameAllowed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/itDeceased
  title: itDeceased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/avatarUri
  title: avatarUri
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Person/avatarFile
  title: avatarFile
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Person/civilStatus
  title: civilStatus
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/tribe
  title: tribe
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/origin
  title: origin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/languages
  title: languages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/certificates
  title: certificates
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/fathers
  title: fathers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/mothers
  title: mothers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/children
  title: children
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/givenName
  title: givenName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/familyName
  title: familyName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/lastName
  title: lastName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/birthPlace
  title: birthPlace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/birthDate
  title: birthDate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/biography
  title: biography
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Person/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation

Person/reference
type: Property
domain: Person
the hydra core vocabulary: reference
range: string

Person/pseudonym
type: Property
domain: Person
the hydra core vocabulary: pseudonym
range: string

Person/phone
type: Property
domain: Person
the hydra core vocabulary: phone

Person/nationality
type: Property
domain: Person
the hydra core vocabulary: nationality
range: string

Person/itExpatriate
type: Property
domain: Person
the hydra core vocabulary: itExpatriate
range: boolean

Person/trueNameAllowed
type: Property
domain: Person
the hydra core vocabulary: trueNameAllowed
range: boolean

Person/itDeceased
type: Property
domain: Person
the hydra core vocabulary: itDeceased
range: boolean

Person/avatar
type: Property
domain: Person
the hydra core vocabulary: avatar
range: string

Person/avatarUri
type: Property
domain: Person
the hydra core vocabulary: avatarUri
range: string

Person/avatarFile
type: Property
domain: Person
the hydra core vocabulary: avatarFile

Person/civilStatus
type: Property
domain: Person
the hydra core vocabulary: civilStatus
range: string

Person/tribe
type: Property
domain: Person
the hydra core vocabulary: tribe
range: string

Person/origin
type: Link
domain: Person
the hydra core vocabulary: origin
max cardinality: 1
range: Origin

Person/address
type: Link
domain: Person
the hydra core vocabulary: address
max cardinality: 1
range: Address

Person/languages
type: Link
domain: Person
the hydra core vocabulary: languages
range: Language

Person/certificates
type: Link
domain: Person
the hydra core vocabulary: certificates
range: Certificate

Person/fathers
type: Link
domain: Person
the hydra core vocabulary: fathers
range: Family

Person/mothers
type: Link
domain: Person
the hydra core vocabulary: mothers
range: Family

Person/children
type: Link
domain: Person
the hydra core vocabulary: children
range: Child

Person/givenName
type: Property
domain: Person
the hydra core vocabulary: givenName
range: string

Person/familyName
type: Property
domain: Person
the hydra core vocabulary: familyName
range: string

Person/lastName
type: Property
domain: Person
the hydra core vocabulary: lastName
range: string

Person/birthPlace
type: Property
domain: Person
the hydra core vocabulary: birthPlace
range: string

Person/birthDate
type: Property
domain: Person
the hydra core vocabulary: birthDate
range: dateTime

Person/biography
type: Property
domain: Person
the hydra core vocabulary: biography
range: string

Person/status
type: Property
domain: Person
the hydra core vocabulary: status
range: string

Person/details
type: Property
domain: Person
the hydra core vocabulary: details

Person/createdAt
type: Property
domain: Person
the hydra core vocabulary: createdAt
range: dateTime

Person/updatedAt
type: Property
domain: Person
the hydra core vocabulary: updatedAt
range: dateTime

Person/createdBy
type: Link
domain: Person
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Person/updatedBy
type: Link
domain: Person
the hydra core vocabulary: updatedBy
max cardinality: 1
range: User

Person/itDeleted
type: Property
domain: Person
the hydra core vocabulary: itDeleted
range: boolean

Person/deletedAt
type: Property
domain: Person
the hydra core vocabulary: deletedAt
range: dateTime

Person/deletedBy
type: Link
domain: Person
the hydra core vocabulary: deletedBy
max cardinality: 1
range: User

Person/itErased
type: Property
domain: Person
the hydra core vocabulary: itErased
range: boolean

Person/erasedAt
type: Property
domain: Person
the hydra core vocabulary: erasedAt
range: dateTime

Person/erasedBy
type: Link
domain: Person
the hydra core vocabulary: erasedBy
max cardinality: 1
range: User

Person/name
type: Property
domain: Person
the hydra core vocabulary: name
range: string

Person/gender
type: Property
domain: Person
the hydra core vocabulary: gender
range: string

Logger
type: Class
title: Logger
supported property: SupportedProperty
  property: Logger/origin
  title: origin
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/objectType
  title: objectType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/ipAddress
  title: ipAddress
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/userAgent
  title: userAgent
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/data
  title: data
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/endpoint
  title: endpoint
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/httpMethod
  title: httpMethod
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Logger/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Logger resource.
  method: GET
  returns: Logger
  title: getLogger
supported operation: Operation
  description: Updates the Logger resource.
  expects: Logger
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Logger
  title: patchLogger

Logger/origin
type: Property
domain: Logger
the hydra core vocabulary: origin
range: string

Logger/objectType
type: Property
domain: Logger
the hydra core vocabulary: objectType
range: string

Logger/ipAddress
type: Property
domain: Logger
the hydra core vocabulary: ipAddress
range: string

Logger/userAgent
type: Property
domain: Logger
the hydra core vocabulary: userAgent
range: string

Logger/data
type: Property
domain: Logger
the hydra core vocabulary: data

Logger/endpoint
type: Property
domain: Logger
the hydra core vocabulary: endpoint
range: string

Logger/httpMethod
type: Property
domain: Logger
the hydra core vocabulary: httpMethod
range: string

Logger/createdAt
type: Property
domain: Logger
the hydra core vocabulary: createdAt
range: dateTime

Logger/createdBy
type: Link
domain: Logger
the hydra core vocabulary: createdBy
max cardinality: 1
range: User

Notification
type: Class
title: Notification
supported property: SupportedProperty
  property: Notification/origin
  title: origin
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/ipAddress
  title: ipAddress
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/userAgent
  title: userAgent
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/message
  title: message
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/itRequireAction
  title: itRequireAction
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/actionUri
  title: actionUri
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Notification/recipient
  title: recipient
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Notification resource.
  method: GET
  returns: Notification
  title: getNotification
supported operation: Operation
  description: Updates the Notification resource.
  expects: Notification
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Notification
  title: patchNotification

Notification/origin
type: Property
domain: Notification
the hydra core vocabulary: origin
range: string

Notification/ipAddress
type: Property
domain: Notification
the hydra core vocabulary: ipAddress
range: string

Notification/userAgent
type: Property
domain: Notification
the hydra core vocabulary: userAgent
range: string

Notification/category
type: Property
domain: Notification
the hydra core vocabulary: category
range: string

Notification/headLine
type: Property
domain: Notification
the hydra core vocabulary: headLine
range: string

Notification/message
type: Property
domain: Notification
the hydra core vocabulary: message
range: string

Notification/itRequireAction
type: Property
domain: Notification
the hydra core vocabulary: itRequireAction
range: boolean

Notification/actionUri
type: Property
domain: Notification
the hydra core vocabulary: actionUri
range: string

Notification/status
type: Property
domain: Notification
the hydra core vocabulary: status
range: string

Notification/createdAt
type: Property
domain: Notification
the hydra core vocabulary: createdAt
range: dateTime

Notification/recipient
type: Link
domain: Notification
the hydra core vocabulary: recipient
max cardinality: 1
range: User

Session
type: Class
title: Session
supported property: SupportedProperty
  property: Session/refreshToken
  title: refreshToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Session/username
  title: username
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Session/valid
  title: valid
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Session resource.
  method: GET
  returns: owl:Nothing
  title: getSession
supported operation: Operation
  type: DeleteAction
  description: Deletes the Session resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteSession

Session/refreshToken
type: Property
domain: Session
the hydra core vocabulary: refreshToken
range: string

Session/username
type: Property
domain: Session
the hydra core vocabulary: username
range: string

Session/valid
type: Property
domain: Session
the hydra core vocabulary: valid
range: dateTime

User
type: Class
title: User
supported property: SupportedProperty
  property: User/username
  title: username
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/plainPassword
  title: plainPassword
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/loginCount
  title: loginCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/itActive
  title: itActive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastConnectedAt
  title: lastConnectedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/firstLoginAt
  title: firstLoginAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastLoginAt
  title: lastLoginAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/person
  title: person
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a User resource.
  method: GET
  returns: User
  title: getUser
supported operation: Operation
  description: Updates the User resource.
  expects: User
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: User
  title: patchUser

User/username
type: Property
domain: User
the hydra core vocabulary: username
range: string

User/roles
type: Property
domain: User
the hydra core vocabulary: roles

User/password
type: Property
domain: User
the hydra core vocabulary: password
range: string

User/plainPassword
type: Property
domain: User
the hydra core vocabulary: plainPassword
range: string

User/loginCount
type: Property
domain: User
the hydra core vocabulary: loginCount
range: integer

User/itActive
type: Property
domain: User
the hydra core vocabulary: itActive
range: boolean

User/createdAt
type: Property
domain: User
the hydra core vocabulary: createdAt
range: dateTime

User/lastConnectedAt
type: Property
domain: User
the hydra core vocabulary: lastConnectedAt
range: dateTime

User/firstLoginAt
type: Property
domain: User
the hydra core vocabulary: firstLoginAt
range: dateTime

User/lastLoginAt
type: Property
domain: User
the hydra core vocabulary: lastLoginAt
range: dateTime

User/person
type: Link
domain: User
the hydra core vocabulary: person
max cardinality: 1
range: Person

User/userIdentifier
type: Property
domain: User
the hydra core vocabulary: userIdentifier
range: string

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/child
  title: getChildCollection
  description: The collection of Child resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/family
  title: getFamilyCollection
  description: The collection of Family resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/marriage
  title: getMarriageCollection
  description: The collection of Marriage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/address
  title: getAddressCollection
  description: The collection of Address resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/certificate
  title: getCertificateCollection
  description: The collection of Certificate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/language
  title: getLanguageCollection
  description: The collection of Language resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/origin
  title: getOriginCollection
  description: The collection of Origin resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/person
  title: getPersonCollection
  description: The collection of Person resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/logger
  title: getLoggerCollection
  description: The collection of Logger resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/notification
  title: getNotificationCollection
  description: The collection of Notification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/session
  title: getSessionCollection
  description: The collection of Session resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/child
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Child
supported operation: Operation
  type: CreateAction
  description: Creates a Child resource.
  expects: Child
  method: POST
  returns: Child
  title: postChild
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Child resources.
  method: GET
  returns: Collection
  title: getChildCollection

Entrypoint/family
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Family
supported operation: Operation
  type: CreateAction
  description: Creates a Family resource.
  expects: Family
  method: POST
  returns: Family
  title: postFamily
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Family resources.
  method: GET
  returns: Collection
  title: getFamilyCollection

Entrypoint/marriage
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Marriage
supported operation: Operation
  type: CreateAction
  description: Creates a Marriage resource.
  expects: Marriage
  method: POST
  returns: Marriage
  title: postMarriage
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Marriage resources.
  method: GET
  returns: Collection
  title: getMarriageCollection

Entrypoint/address
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Address
supported operation: Operation
  type: CreateAction
  description: Creates a Address resource.
  expects: Address
  method: POST
  returns: Address
  title: postAddress
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Address resources.
  method: GET
  returns: Collection
  title: getAddressCollection

Entrypoint/certificate
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Certificate
supported operation: Operation
  type: CreateAction
  description: Creates a Certificate resource.
  expects: Certificate
  method: POST
  returns: Certificate
  title: postCertificate
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Certificate resources.
  method: GET
  returns: Collection
  title: getCertificateCollection

Entrypoint/language
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Language
supported operation: Operation
  type: CreateAction
  description: Creates a Language resource.
  expects: Language
  method: POST
  returns: Language
  title: postLanguage
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Language resources.
  method: GET
  returns: Collection
  title: getLanguageCollection

Entrypoint/origin
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Origin
supported operation: Operation
  type: CreateAction
  description: Creates a Origin resource.
  expects: Origin
  method: POST
  returns: Origin
  title: postOrigin
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Origin resources.
  method: GET
  returns: Collection
  title: getOriginCollection

Entrypoint/person
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Person
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Person resources.
  method: GET
  returns: Collection
  title: getPersonCollection

Entrypoint/logger
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Logger
supported operation: Operation
  type: CreateAction
  description: Creates a Logger resource.
  expects: Logger
  method: POST
  returns: Logger
  title: postLogger
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Logger resources.
  method: GET
  returns: Collection
  title: getLoggerCollection

Entrypoint/notification
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Notification
supported operation: Operation
  type: CreateAction
  description: Creates a Notification resource.
  expects: Notification
  method: POST
  returns: Notification
  title: postNotification
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Notification resources.
  method: GET
  returns: Collection
  title: getNotificationCollection

Entrypoint/session
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Session
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Session resources.
  method: GET
  returns: Collection
  title: getSessionCollection

Entrypoint/user
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

SupportedProperty
property: Person/deletedBy
title: deletedBy
required: false
readable: true
writeable: true

SupportedProperty
property: Person/itErased
title: itErased
required: false
readable: true
writeable: true

SupportedProperty
property: Person/erasedAt
title: erasedAt
required: false
readable: true
writeable: true

SupportedProperty
property: Person/erasedBy
title: erasedBy
required: false
readable: true
writeable: true

SupportedProperty
property: Person/name
title: name
required: false
readable: true
writeable: false

SupportedProperty
property: Person/gender
title: gender
required: true
readable: true
writeable: true

Operation
type: FindAction
description: Retrieves a Person resource.
method: GET
returns: Person
title: getPerson