docs.jsonld
type: ApiDocumentation
title: SocioLink API Main
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: City
supported class: Country
supported class: Quarter
supported class: Region
supported class: Street
supported class: Township
supported class: Ward
supported class: Language
supported class: Tribe
supported class: TribeSpace
supported class: Apikey
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

City
type: Class
title: City
supported property: SupportedProperty
  property: City/code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/fullName
  title: fullName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/alpha3
  title: alpha3
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/area
  title: area
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/region
  title: region
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/townships
  title: townships
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/quarters
  title: quarters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: City/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a City resource.
  method: GET
  returns: City
  title: getCity
supported operation: Operation
  description: Updates the City resource.
  expects: City
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: City
  title: patchCity

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

City/fullName
type: Property
domain: City
the hydra core vocabulary: fullName
range: string

City/alpha3
type: Property
domain: City
the hydra core vocabulary: alpha3
range: string

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

City/area
type: Property
domain: City
the hydra core vocabulary: area
range: string

City/region
type: Link
domain: City
the hydra core vocabulary: region
max cardinality: 1
range: Region

City/country
type: Link
domain: City
the hydra core vocabulary: country
max cardinality: 1
range: Country

City/townships
type: Link
domain: City
the hydra core vocabulary: townships
range: Township

City/quarters
type: Link
domain: City
the hydra core vocabulary: quarters
range: Quarter

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

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

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

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

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

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

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

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

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

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

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

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

Country
type: Class
title: Country
supported property: SupportedProperty
  property: Country/code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/fullName
  title: fullName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/shortName
  title: shortName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/nationality
  title: nationality
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/alpha2
  title: alpha2
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/alpha3
  title: alpha3
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/area
  title: area
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/itCurrent
  title: itCurrent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/regions
  title: regions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/cities
  title: cities
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/townships
  title: townships
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/quarters
  title: quarters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Country/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Country resource.
  method: GET
  returns: Country
  title: getCountry
supported operation: Operation
  description: Updates the Country resource.
  expects: Country
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Country
  title: patchCountry

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

Country/fullName
type: Property
domain: Country
the hydra core vocabulary: fullName
range: string

Country/shortName
type: Property
domain: Country
the hydra core vocabulary: shortName
range: string

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

Country/alpha2
type: Property
domain: Country
the hydra core vocabulary: alpha2
range: string

Country/alpha3
type: Property
domain: Country
the hydra core vocabulary: alpha3
range: string

Country/area
type: Property
domain: Country
the hydra core vocabulary: area
range: string

Country/itCurrent
type: Property
domain: Country
the hydra core vocabulary: itCurrent
range: boolean

Country/regions
type: Link
domain: Country
the hydra core vocabulary: regions
range: Region

Country/cities
type: Link
domain: Country
the hydra core vocabulary: cities
range: City

Country/townships
type: Link
domain: Country
the hydra core vocabulary: townships
range: Township

Country/quarters
type: Link
domain: Country
the hydra core vocabulary: quarters
range: Quarter

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Quarter/fullName
type: Property
domain: Quarter
the hydra core vocabulary: fullName
range: string

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

Quarter/area
type: Property
domain: Quarter
the hydra core vocabulary: area
range: string

Quarter/township
type: Link
domain: Quarter
the hydra core vocabulary: township
max cardinality: 1
range: Township

Quarter/city
type: Link
domain: Quarter
the hydra core vocabulary: city
max cardinality: 1
range: City

Quarter/region
type: Link
domain: Quarter
the hydra core vocabulary: region
max cardinality: 1
range: Region

Quarter/country
type: Link
domain: Quarter
the hydra core vocabulary: country
max cardinality: 1
range: Country

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

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

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

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

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

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

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

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

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

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

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

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

Region
type: Class
title: Region
supported property: SupportedProperty
  property: Region/code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/fullName
  title: fullName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/alpha2
  title: alpha2
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/alpha3
  title: alpha3
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/area
  title: area
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/cities
  title: cities
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/townships
  title: townships
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/quarters
  title: quarters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Region/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Region resource.
  method: GET
  returns: Region
  title: getRegion
supported operation: Operation
  description: Updates the Region resource.
  expects: Region
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Region
  title: patchRegion

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

Region/fullName
type: Property
domain: Region
the hydra core vocabulary: fullName
range: string

Region/alpha2
type: Property
domain: Region
the hydra core vocabulary: alpha2
range: string

Region/alpha3
type: Property
domain: Region
the hydra core vocabulary: alpha3
range: string

Region/area
type: Property
domain: Region
the hydra core vocabulary: area
range: string

Region/country
type: Link
domain: Region
the hydra core vocabulary: country
max cardinality: 1
range: Country

Region/cities
type: Link
domain: Region
the hydra core vocabulary: cities
range: City

Region/townships
type: Link
domain: Region
the hydra core vocabulary: townships
range: Township

Region/quarters
type: Link
domain: Region
the hydra core vocabulary: quarters
range: Quarter

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

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

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

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

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

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

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

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

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

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

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

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

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

Street/fullName
type: Property
domain: Street
the hydra core vocabulary: fullName
range: string

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

Street/township
type: Link
domain: Street
the hydra core vocabulary: township
max cardinality: 1
range: Township

Street/city
type: Link
domain: Street
the hydra core vocabulary: city
max cardinality: 1
range: City

Street/region
type: Link
domain: Street
the hydra core vocabulary: region
max cardinality: 1
range: Region

Street/country
type: Link
domain: Street
the hydra core vocabulary: country
max cardinality: 1
range: Country

Street/wards
type: Link
domain: Street
the hydra core vocabulary: wards
range: Ward

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

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

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

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

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

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

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

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

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

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

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

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

Township
type: Class
title: Township
supported property: SupportedProperty
  property: Township/code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/fullName
  title: fullName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/area
  title: area
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/city
  title: city
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/region
  title: region
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/quarters
  title: quarters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/streets
  title: streets
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/itDeleted
  title: itDeleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/deletedBy
  title: deletedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/itErased
  title: itErased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/erasedAt
  title: erasedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Township/erasedBy
  title: erasedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Township resource.
  method: GET
  returns: Township
  title: getTownship
supported operation: Operation
  description: Updates the Township resource.
  expects: Township
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Township
  title: patchTownship

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

Township/fullName
type: Property
domain: Township
the hydra core vocabulary: fullName
range: string

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

Township/area
type: Property
domain: Township
the hydra core vocabulary: area
range: string

Township/city
type: Link
domain: Township
the hydra core vocabulary: city
max cardinality: 1
range: City

Township/region
type: Link
domain: Township
the hydra core vocabulary: region
max cardinality: 1
range: Region

Township/country
type: Link
domain: Township
the hydra core vocabulary: country
max cardinality: 1
range: Country

Township/quarters
type: Link
domain: Township
the hydra core vocabulary: quarters
range: Quarter

Township/streets
type: Link
domain: Township
the hydra core vocabulary: streets
range: Street

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

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

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

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

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

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

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

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

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

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

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

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

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

Ward/latitude
type: Property
domain: Ward
the hydra core vocabulary: latitude
range: string

Ward/longitude
type: Property
domain: Ward
the hydra core vocabulary: longitude
range: string

Ward/plotNumber
type: Property
domain: Ward
the hydra core vocabulary: plotNumber
range: string

Ward/street
type: Link
domain: Ward
the hydra core vocabulary: street
max cardinality: 1
range: Street

Ward/quarter
type: Link
domain: Ward
the hydra core vocabulary: quarter
max cardinality: 1
range: Quarter

Ward/township
type: Link
domain: Ward
the hydra core vocabulary: township
max cardinality: 1
range: Township

Ward/city
type: Link
domain: Ward
the hydra core vocabulary: city
max cardinality: 1
range: City

Ward/region
type: Link
domain: Ward
the hydra core vocabulary: region
max cardinality: 1
range: Region

Ward/country
type: Link
domain: Ward
the hydra core vocabulary: country
max cardinality: 1
range: Country

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

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

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

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

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

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

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

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

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

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

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

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

Language
type: Class
title: Language
supported property: SupportedProperty
  property: Language/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/iso
  title: iso
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Language/country
  title: country
  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/headLine
type: Property
domain: Language
the hydra core vocabulary: headLine
range: string

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

Language/country
type: Link
domain: Language
the hydra core vocabulary: country
max cardinality: 1
range: Country

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

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

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

Tribe/regions
type: Link
domain: Tribe
the hydra core vocabulary: regions
range: TribeSpace

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TribeSpace/tribe
type: Link
domain: TribeSpace
the hydra core vocabulary: tribe
max cardinality: 1
range: Tribe

TribeSpace/region
type: Link
domain: TribeSpace
the hydra core vocabulary: region
max cardinality: 1
range: Region

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

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

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

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

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

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

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

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

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

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

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

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

Apikey
type: Class
title: Apikey
supported property: SupportedProperty
  property: Apikey/name
  title: name
  required: false
  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/enabled
  title: enabled
  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/expiresAt
  title: expiresAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Apikey/owner
  title: owner
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Apikey resource.
  method: GET
  returns: Apikey
  title: getApikey

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/enabled
type: Property
domain: Apikey
the hydra core vocabulary: enabled
range: boolean

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

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

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

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

User
type: Class
title: User
supported property: SupportedProperty
  property: User/username
  title: username
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/category
  title: category
  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/enabled
  title: enabled
  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/profile
  title: profile
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/apikeys
  title: apikeys
  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/reference
type: Property
domain: User
the hydra core vocabulary: reference
range: string

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

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

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

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

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

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

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

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/city
  title: getCityCollection
  description: The collection of City resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/country
  title: getCountryCollection
  description: The collection of Country resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/quarter
  title: getQuarterCollection
  description: The collection of Quarter resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/region
  title: getRegionCollection
  description: The collection of Region resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/street
  title: getStreetCollection
  description: The collection of Street resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/township
  title: getTownshipCollection
  description: The collection of Township resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/ward
  title: getWardCollection
  description: The collection of Ward 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/tribe
  title: getTribeCollection
  description: The collection of Tribe resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/tribeSpace
  title: getTribeSpaceCollection
  description: The collection of TribeSpace 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/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/city
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: City
supported operation: Operation
  type: CreateAction
  description: Creates a City resource.
  expects: City
  method: POST
  returns: City
  title: postCity
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of City resources.
  method: GET
  returns: Collection
  title: getCityCollection

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

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

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

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

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

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

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/tribe
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Tribe
supported operation: Operation
  type: CreateAction
  description: Creates a Tribe resource.
  expects: Tribe
  method: POST
  returns: Tribe
  title: postTribe
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Tribe resources.
  method: GET
  returns: Collection
  title: getTribeCollection

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

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/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