docs.jsonld
type: ApiDocumentation
title: AroundLink API
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: ApiAuthToken
supported class: Exchange
supported class: ExchangeAffectation
supported class: StudentFile
supported class: LearningAgreement
supported class: StudentProfile
supported class: StudentRating
supported class: StudentUser
supported class: TranscriptOfRecord
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/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/description
  title: description
  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/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

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

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

ApiAuthToken
type: Class
title: ApiAuthToken
supported property: SupportedProperty
  property: ApiAuthToken/token
  title: token
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApiAuthToken/expireIn
  title: expireIn
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ApiAuthToken resource.
  method: GET
  returns: ApiAuthToken
  title: getApiAuthToken
description: Access to JWT tokens

ApiAuthToken/token
type: Property
domain: ApiAuthToken
the hydra core vocabulary: token
range: string

ApiAuthToken/expireIn
type: Property
domain: ApiAuthToken
the hydra core vocabulary: expireIn
range: integer

Exchange
type: Class
title: Exchange
supported operation: Operation
  type: FindAction
  description: Retrieves a Exchange resource.
  method: GET
  returns: Exchange
  title: getExchange

ExchangeAffectation
type: Class
title: ExchangeAffectation
supported operation: Operation
  type: FindAction
  description: Retrieves a ExchangeAffectation resource.
  method: GET
  returns: ExchangeAffectation
  title: getExchangeAffectation
supported operation: Operation
  description: Updates the ExchangeAffectation resource.
  expects: ExchangeAffectation
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: ExchangeAffectation
  title: patchExchangeAffectation

StudentFile
type: Class
title: StudentFile
supported operation: Operation
  type: FindAction
  description: Retrieves a StudentFile resource.
  method: GET
  returns: StudentFile
  title: getStudentFile

LearningAgreement
type: Class
title: LearningAgreement
supported operation: Operation
  type: FindAction
  description: Retrieves a LearningAgreement resource.
  method: GET
  returns: LearningAgreement
  title: getLearningAgreement

StudentProfile
type: Class
title: StudentProfile
supported operation: Operation
  type: FindAction
  description: Retrieves a StudentProfile resource.
  method: GET
  returns: StudentProfile
  title: getStudentProfile

StudentRating
type: Class
title: StudentRating
supported operation: Operation
  type: FindAction
  description: Retrieves a StudentRating resource.
  method: GET
  returns: StudentRating
  title: getStudentRating

StudentUser
type: Class
title: StudentUser
supported property: SupportedProperty
  property: StudentUser/studentNumber
  title: studentNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/INE
  title: INE
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/ESI
  title: ESI
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/birthDate
  title: birthDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/birthPlace
  title: birthPlace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/nationality
  title: nationality
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/birthCountry
  title: birthCountry
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/personalEmail
  title: personalEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/emergencyNumber
  title: emergencyNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: StudentUser/gender
  title: gender
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a StudentUser resource.
  method: GET
  returns: StudentUser
  title: getStudentUser

StudentUser/studentNumber
type: Property
domain: StudentUser
the hydra core vocabulary: studentNumber
range: string

StudentUser/INE
type: Property
domain: StudentUser
the hydra core vocabulary: INE
range: string

StudentUser/ESI
type: Property
domain: StudentUser
the hydra core vocabulary: ESI
range: string

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

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

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

StudentUser/birthCountry
type: Property
domain: StudentUser
the hydra core vocabulary: birthCountry
range: string

StudentUser/personalEmail
type: Property
domain: StudentUser
the hydra core vocabulary: personalEmail
range: string

StudentUser/emergencyNumber
type: Property
domain: StudentUser
the hydra core vocabulary: emergencyNumber
range: string

StudentUser/gender
type: Property
domain: StudentUser
the hydra core vocabulary: gender

TranscriptOfRecord
type: Class
title: TranscriptOfRecord
supported operation: Operation
  type: FindAction
  description: Retrieves a TranscriptOfRecord resource.
  method: GET
  returns: TranscriptOfRecord
  title: getTranscriptOfRecord

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/exchangeAffectation
  title: getExchangeAffectationCollection
  description: The collection of ExchangeAffectation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/studentFile
  title: getStudentFileCollection
  description: The collection of StudentFile resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/learningAgreement
  title: getLearningAgreementCollection
  description: The collection of LearningAgreement resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/studentRating
  title: getStudentRatingCollection
  description: The collection of StudentRating resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/studentUser
  title: getStudentUserCollection
  description: The collection of StudentUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/transcriptOfRecord
  title: getTranscriptOfRecordCollection
  description: The collection of TranscriptOfRecord resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

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

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

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

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

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

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

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