docs.jsonld
type: ApiDocumentation
title: e-Tax User API
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Jobtitle
supported class: Message
supported class: Apikey
supported class: Attribution
supported class: Category
supported class: Composing
supported class: Role
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

Jobtitle
type: Class
title: Jobtitle
supported property: SupportedProperty
  property: Jobtitle/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Jobtitle/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Jobtitle resource.
  method: GET
  returns: Jobtitle
  title: getJobtitle
supported operation: Operation
  description: Updates the Jobtitle resource.
  expects: Jobtitle
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Jobtitle
  title: patchJobtitle

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

Jobtitle/realm
type: Property
domain: Jobtitle
the hydra core vocabulary: realm

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

Jobtitle/itLocked
type: Property
domain: Jobtitle
the hydra core vocabulary: itLocked
range: boolean

Jobtitle/itHidden
type: Property
domain: Jobtitle
the hydra core vocabulary: itHidden
range: boolean

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

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

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

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

Jobtitle/createdBy
type: Property
domain: Jobtitle
the hydra core vocabulary: createdBy
range: string

Jobtitle/updatedBy
type: Property
domain: Jobtitle
the hydra core vocabulary: updatedBy
range: string

Message
type: Class
title: Message
supported property: SupportedProperty
  property: Message/origin
  title: origin
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/channel
  title: channel
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/content
  title: content
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/retry
  title: retry
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/maxRetry
  title: maxRetry
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/itRepliable
  title: itRepliable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/itReplied
  title: itReplied
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/status
  title: status
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/sendAt
  title: sendAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Message/repliedAt
  title: repliedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Message resource.
  method: GET
  returns: Message
  title: getMessage
supported operation: Operation
  description: Updates the Message resource.
  expects: Message
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Message
  title: patchMessage
supported operation: Operation
  type: DeleteAction
  description: Deletes the Message resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteMessage

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

Message/channel
type: Property
domain: Message
the hydra core vocabulary: channel
range: string

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

Message/email
type: Property
domain: Message
the hydra core vocabulary: email
range: string

Message/content
type: Property
domain: Message
the hydra core vocabulary: content
range: string

Message/retry
type: Property
domain: Message
the hydra core vocabulary: retry
range: integer

Message/maxRetry
type: Property
domain: Message
the hydra core vocabulary: maxRetry
range: integer

Message/itRepliable
type: Property
domain: Message
the hydra core vocabulary: itRepliable
range: boolean

Message/itReplied
type: Property
domain: Message
the hydra core vocabulary: itReplied
range: boolean

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

Message/sendAt
type: Property
domain: Message
the hydra core vocabulary: sendAt
range: dateTime

Message/repliedAt
type: Property
domain: Message
the hydra core vocabulary: repliedAt
range: dateTime

Apikey
type: Class
title: Apikey
supported property: SupportedProperty
  property: Apikey/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/apikey
  title: apikey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/expiresAt
  title: expiresAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/owner
  title: owner
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Apikey resource.
  method: GET
  returns: Apikey
  title: getApikey
supported operation: Operation
  description: Updates the Apikey resource.
  expects: Apikey
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Apikey
  title: patchApikey
supported operation: Operation
  type: DeleteAction
  description: Deletes the Apikey resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteApikey

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

Apikey/apikey
type: Property
domain: Apikey
the hydra core vocabulary: apikey
range: string

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

Apikey/expiresAt
type: Property
domain: Apikey
the hydra core vocabulary: expiresAt
range: dateTime

Apikey/owner
type: Link
domain: Apikey
the hydra core vocabulary: owner
max cardinality: 1
range: User

Apikey/itLocked
type: Property
domain: Apikey
the hydra core vocabulary: itLocked
range: boolean

Apikey/itHidden
type: Property
domain: Apikey
the hydra core vocabulary: itHidden
range: boolean

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

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

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

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

Apikey/createdBy
type: Property
domain: Apikey
the hydra core vocabulary: createdBy
range: string

Apikey/updatedBy
type: Property
domain: Apikey
the hydra core vocabulary: updatedBy
range: string

Attribution
type: Class
title: Attribution
supported property: SupportedProperty
  property: Attribution/user
  title: user
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/role
  title: role
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Attribution/roleData
  title: roleData
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Attribution resource.
  method: GET
  returns: Attribution
  title: getAttribution
supported operation: Operation
  type: DeleteAction
  description: Deletes the Attribution resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteAttribution

Attribution/user
type: Link
domain: Attribution
the hydra core vocabulary: user
max cardinality: 1
range: User

Attribution/role
type: Link
domain: Attribution
the hydra core vocabulary: role
max cardinality: 1
range: Role

Attribution/itLocked
type: Property
domain: Attribution
the hydra core vocabulary: itLocked
range: boolean

Attribution/itHidden
type: Property
domain: Attribution
the hydra core vocabulary: itHidden
range: boolean

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

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

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

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

Attribution/createdBy
type: Property
domain: Attribution
the hydra core vocabulary: createdBy
range: string

Attribution/updatedBy
type: Property
domain: Attribution
the hydra core vocabulary: updatedBy
range: string

Attribution/roleData
type: Property
domain: Attribution
the hydra core vocabulary: roleData

Category
type: Class
title: Category
supported property: SupportedProperty
  property: Category/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Category resource.
  method: GET
  returns: Category
  title: getCategory
supported operation: Operation
  description: Updates the Category resource.
  expects: Category
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Category
  title: patchCategory

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

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

Category/itLocked
type: Property
domain: Category
the hydra core vocabulary: itLocked
range: boolean

Category/itHidden
type: Property
domain: Category
the hydra core vocabulary: itHidden
range: boolean

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

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

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

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

Category/createdBy
type: Property
domain: Category
the hydra core vocabulary: createdBy
range: string

Category/updatedBy
type: Property
domain: Category
the hydra core vocabulary: updatedBy
range: string

Composing
type: Class
title: Composing
supported property: SupportedProperty
  property: Composing/parentRole
  title: parentRole
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/role
  title: role
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Composing/parentRoleData
  title: parentRoleData
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Composing/roleData
  title: roleData
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Composing resource.
  method: GET
  returns: Composing
  title: getComposing
supported operation: Operation
  description: Updates the Composing resource.
  expects: Composing
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Composing
  title: patchComposing
supported operation: Operation
  type: DeleteAction
  description: Deletes the Composing resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteComposing

Composing/parentRole
type: Link
domain: Composing
the hydra core vocabulary: parentRole
max cardinality: 1
range: Role

Composing/role
type: Link
domain: Composing
the hydra core vocabulary: role
max cardinality: 1
range: Role

Composing/itLocked
type: Property
domain: Composing
the hydra core vocabulary: itLocked
range: boolean

Composing/itHidden
type: Property
domain: Composing
the hydra core vocabulary: itHidden
range: boolean

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

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

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

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

Composing/createdBy
type: Property
domain: Composing
the hydra core vocabulary: createdBy
range: string

Composing/updatedBy
type: Property
domain: Composing
the hydra core vocabulary: updatedBy
range: string

Composing/parentRoleData
type: Property
domain: Composing
the hydra core vocabulary: parentRoleData

Composing/roleData
type: Property
domain: Composing
the hydra core vocabulary: roleData

Role
type: Class
title: Role
supported property: SupportedProperty
  property: Role/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/role
  title: role
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/itComposite
  title: itComposite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/lastSyncedAt
  title: lastSyncedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/keycloakId
  title: keycloakId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/composings
  title: composings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Role/composition
  title: composition
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Role resource.
  method: GET
  returns: Role
  title: getRole
supported operation: Operation
  description: Updates the Role resource.
  expects: Role
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Role
  title: patchRole

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

Role/role
type: Property
domain: Role
the hydra core vocabulary: role
range: string

Role/itComposite
type: Property
domain: Role
the hydra core vocabulary: itComposite
range: boolean

Role/lastSyncedAt
type: Property
domain: Role
the hydra core vocabulary: lastSyncedAt
range: dateTime

Role/keycloakId
type: Property
domain: Role
the hydra core vocabulary: keycloakId

Role/category
type: Link
domain: Role
the hydra core vocabulary: category
max cardinality: 1
range: Category

Role/composings
type: Link
domain: Role
the hydra core vocabulary: composings
range: Composing

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

Role/itLocked
type: Property
domain: Role
the hydra core vocabulary: itLocked
range: boolean

Role/itHidden
type: Property
domain: Role
the hydra core vocabulary: itHidden
range: boolean

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

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

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

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

Role/createdBy
type: Property
domain: Role
the hydra core vocabulary: createdBy
range: string

Role/updatedBy
type: Property
domain: Role
the hydra core vocabulary: updatedBy
range: string

Role/composition
type: Property
domain: Role
the hydra core vocabulary: composition

User
type: Class
title: User
supported property: SupportedProperty
  property: User/username
  title: username
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/phone
  title: phone
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/givenName
  title: givenName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/familyName
  title: familyName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/gender
  title: gender
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/level
  title: level
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/itAgent
  title: itAgent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/itPayer
  title: itPayer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastSyncedAt
  title: lastSyncedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/keycloakId
  title: keycloakId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/profileId
  title: profileId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/region
  title: region
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/regie
  title: regie
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/city
  title: city
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/township
  title: township
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/center
  title: center
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/jobtitle
  title: jobtitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/attributions
  title: attributions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/apiKeys
  title: apiKeys
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/details
  title: details
  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/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
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
  method: PATCH
  returns: User
  title: patchUser

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

User/jobtitle
type: Link
domain: User
the hydra core vocabulary: jobtitle
max cardinality: 1
range: Jobtitle

User/attributions
type: Link
domain: User
the hydra core vocabulary: attributions
range: Attribution

User/apiKeys
type: Link
domain: User
the hydra core vocabulary: apiKeys
range: Apikey

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

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

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

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

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

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

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

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

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/jobtitle
  title: getJobtitleCollection
  description: The collection of Jobtitle resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/message
  title: getMessageCollection
  description: The collection of Message resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/apikey
  title: getApikeyCollection
  description: The collection of Apikey resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/attribution
  title: getAttributionCollection
  description: The collection of Attribution resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/category
  title: getCategoryCollection
  description: The collection of Category resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/composing
  title: getComposingCollection
  description: The collection of Composing resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/role
  title: getRoleCollection
  description: The collection of Role 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/jobtitle
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Jobtitle
supported operation: Operation
  type: CreateAction
  description: Creates a Jobtitle resource.
  expects: Jobtitle
  method: POST
  returns: Jobtitle
  title: postJobtitle
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Jobtitle resources.
  method: GET
  returns: Collection
  title: getJobtitleCollection

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

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

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

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

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

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

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

Operation
type: DeleteAction
description: Deletes the User resource.
method: DELETE
returns: owl:Nothing
title: deleteUser