Hong Kong Baptist University person API

openapi: 3.0.1
info:
  title: Pure activity person API
  description: The Pure API provides a secure and complete web services API for using and managing research information data in Pure. The API enables a broad range of use-cases for interacting with research information, from anonymous Open Data scenarios to enabling the next generation Pure admin.
  termsOfService: ''
  contact:
    name: ''
    url: ''
    email: pure-support@elsevier.com
  license:
    name: ''
    url: ''
  version: 5.35.0
servers:
- url: https://scholars.hkbu.edu.hk/ws/api
security:
- api-key: []
tags:
- name: person
paths:
  /persons:
    get:
      tags:
      - person
      summary: Lists all persons
      description: Lists all persons in the Pure instance. If you need to filter the persons returned, see the POST version which supports additional filtering.
      operationId: person_list_1
      parameters:
      - name: size
        in: query
        description: Number of returned persons per request.
        schema:
          maximum: 1000
          type: integer
          format: int32
          default: 10
      - name: offset
        in: query
        description: The offset for the returned list. 0 or null value is from the start
        schema:
          type: integer
          format: int32
          default: 0
      - name: order
        in: query
        description: The order of the list, must be a value from /persons/orderings
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonListResult'
    put:
      tags:
      - person
      summary: Create person
      description: Create person
      operationId: person_create_1
      requestBody:
        description: The content to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Person'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Person'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /persons/allowed-academic-qualification-types:
    get:
      tags:
      - person
      summary: A list of allowed academic qualification types for persons
      description: Get a list of allowed academic qualification types for persons
      operationId: person_getAllowedAcademicQualificationsTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-academic-qualifications-distinctions:
    get:
      tags:
      - person
      summary: A list of the allowed values for education distinction
      description: Get a list of classifications that can be used for the 'academicQualifications.distinction' attribute of persons
      operationId: person_getAllowedAcademicQualificationsDistinctions_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-academic-qualifications-field-of-studies:
    get:
      tags:
      - person
      summary: A list of the allowed values for field of study
      description: Get a list of classifications that can be used for the 'academicQualifications.fieldOfStudy' attribute of persons
      operationId: person_getAllowedAcademicQualificationsFieldOfStudies_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-address-countries:
    get:
      tags:
      - person
      summary: A list of allowed address countries
      description: Get a list of allowed countries that can be used for the 'addresses.country' attribute of persons
      operationId: person_getAllowedAddressCountries_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-address-subdivisions:
    get:
      tags:
      - person
      summary: A list of allowed subdivisions
      description: Get a list of allowed subdivisions can be used for the 'subdivision' attribute of person organization associations
      operationId: person_getAllowedAddressSubdivisions_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-address-types:
    get:
      tags:
      - person
      summary: A list of allowed address types
      description: Get a list of allowed address types that can be used for the 'addresses.type' attribute of persons
      operationId: person_getAllowedAddressTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-classified-identifier-types:
    get:
      tags:
      - person
      summary: A list of allowed classified identifier types
      description: Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of persons
      operationId: person_getAllowedClassifiedIdentifierTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-custom-defined-field-values/{propertyName}/classifications:
    get:
      tags:
      - person
      summary: Get allowed classifications for the custom-defined field associated with the person
      description: Get allowed classifications for the custom-defined field associated with the person.
      operationId: person_getAllowedCustomDefinedFieldClassifications_1
      parameters:
      - name: propertyName
        in: path
        description: PropertyName for the desired custom-defined field
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Resource not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /persons/allowed-document-licenses:
    get:
      tags:
      - person
      summary: A list of allowed document licenses
      description: Get a list of allowed licenses for documents on persons
      operationId: person_getAllowedDocumentLicenses_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-document-types:
    get:
      tags:
      - person
      summary: A list of allowed document types
      description: Get a list of allowed types for documents on persons
      operationId: person_getAllowedDocumentTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-external-positions-appointments:
    get:
      tags:
      - person
      summary: A list of the allowed values for appointments
      description: Get a list of classifications that can be used for the 'externalPositions.appointment' attribute of persons
      operationId: person_getAllowedExternalPositionsAppointments_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-genders:
    get:
      tags:
      - person
      summary: A list of allowed classifications for the gender property
      description: Get a list of classifications that can be used when submitting the person gender property.
      operationId: person_getAllowedGenders_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-keyword-group-configurations:
    get:
      tags:
      - person
      summary: A list of keyword group configurations
      description: Get a list of allowed keyword group configurations that can be used when submitting keyword groups.
      operationId: person_getAllowedKeywordGroupConfigurations_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowedKeywordGroupConfigurationList'
  /persons/allowed-keyword-group-configurations/{id}/classifications:
    get:
      tags:
      - person
      summary: A list of allowed classifications for the specified keyword group
      description: Get a list of allowed classifications that can be used when submitting a specified keyword group.
      operationId: person_getAllowedKeywordGroupConfigurationClassifications_1
      parameters:
      - name: id
        in: path
        description: Pure id of the keyword group configuration
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-leave-of-absense:
    get:
      tags:
      - person
      summary: A list of allowed classifications for the leave of absence property
      description: Get a list of classifications that can be used when submitting the leaveOfAbsence property.
      operationId: person_getAllowedLeavesOfAbsenceClassifications_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-link-types:
    get:
      tags:
      - person
      summary: A list of allowed link types
      description: Get a list of allowed link types that can be used for the 'links.linkType' attribute of persons
      operationId: person_getAllowedLinkTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-locales:
    get:
      tags:
      - person
      summary: A list of allowed locales in localized strings
      description: Get a list of allowed locales that can be used when submitting localized string entities.
      operationId: person_getAllowedLocales_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesList'
  /persons/allowed-main-research-areas:
    get:
      tags:
      - person
      summary: A list of allowed main research areas
      description: Get a list of allowed main research areas associated with the person
      operationId: person_getAllowedMainResearchAreas_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-metric-collections:
    get:
      tags:
      - person
      summary: A list of allowed metric collections
      description: Get a list of metric collections allowed on persons
      operationId: person_getAllowedMetricCollections_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCollectionDefinitionList'
  /persons/allowed-names-types:
    get:
      tags:
      - person
      summary: A list of allowed classifications for classified names
      description: Get a list of allowed classifications that can be used when submitting a classified name.
      operationId: person_getAllowedNamesTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-nationalities:
    get:
      tags:
      - person
      summary: A list of allowed classifications for the nationalities property
      description: Get a list of classifications that can be used when submitting the nationality property.
      operationId: person_getAllowedNationalities_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-person-organization-associations-email-types:
    get:
      tags:
      - person
      summary: A list of allowed email types
      description: Get a list of allowed email types for person organization associations on persons
      operationId: person_getAllowedPersonOrganizationAssociationsEmailTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-person-organization-associations-employment-types:
    get:
      tags:
      - person
      summary: A list of allowed employment types
      description: Get a list of allowed employment types for person organization associations on persons
      operationId: person_getAllowedPersonOrganizationAssociationsEmploymentTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-person-organization-associations-job-titles:
    get:
      tags:
      - person
      summary: A list of allowed job titles
      description: Get a list of allowed job titles for person organization associations on persons
      operationId: person_getAllowedPersonOrganizationAssociationsJobTitles_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-person-organization-associations-phonenumber-types:
    get:
      tags:
      - person
      summary: A list of allowed phone number types
      description: Get a list of allowed phone numbers types for person organization associations on persons
      operationId: person_getAllowedPersonOrganizationAssociationsPhoneNumberTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-person-organization-associations-supervisor-roles:
    get:
      tags:
      - person
      summary: A list of allowed supervisor roles
      description: Get a list of allowed supervisor roles for person organization associations on persons
      operationId: person_getAllowedPersonOrganizationAssociationsSupervisorRoles_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-person-organization-associations-webaddress-types:
    get:
      tags:
      - person
      summary: A list of allowed web address types
      description: Get a list of allowed web address types for person organization associations on persons
      operationId: person_getAllowedPersonOrganizationAssociationsWebAddressTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-private-address-countries:
    get:
      tags:
      - person
      summary: DEPRECATED - use 'allowed-address-countries' - A list of allowed country classifications for private address
      description: DEPRECATED - use 'allowed-address-countries' - Get a list of allowed country classifications for private address on persons
      operationId: person_getAllowedPrivateAddressCountries_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
      deprecated: true
  /persons/allowed-profile-information-types:
    get:
      tags:
      - person
      summary: A list of allowed classifications for the profile information property
      description: Get a list of classifications that can be used when submitting an entry in profile information.
      operationId: person_getAllowedProfileInformationTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-profile-photo-types:
    get:
      tags:
      - person
      summary: A list of allowed photo types
      description: Get a list of allowed photo types that can be used for the 'profilePhotos.type' attribute of persons
      operationId: person_getAllowedProfilePhotoTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-staff-organization-associations-contract-types:
    get:
      tags:
      - person
      summary: A list of allowed contract types
      description: Get a list of allowed contract types for staff organization associations on persons
      operationId: person_getAllowedStaffOrganizationAssociationsContractTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-staff-organization-associations-staff-types:
    get:
      tags:
      - person
      summary: A list of allowed staff types
      description: Get a list of allowed staff types for staff organization associations on persons
      operationId: person_getAllowedStaffOrganizationAssociationsStaffTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-student-organization-associations-attendance-status-types:
    get:
      tags:
      - person
      summary: A list of allowed student attendance status types
      description: Get a list of allowed student attendance status types for student organization associations on persons
      operationId: person_getAllowedStudentOrganizationAssociationsAttendanceStatus_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-student-organization-associations-country-of-domicile-types:
    get:
      tags:
      - person
      summary: A list of allowed student country of domicile types
      description: Get a list of allowed student country of domicile types for student organization associations on persons
      operationId: person_getAllowedStudentOrganizationAssociationsGetStudentCountryOfDomiciles_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-student-organization-associations-employment-types:
    get:
      tags:
      - person
      summary: A list of allowed employment types
      description: Get a list of allowed employment types for student organization associations on persons
      operationId: person_getAllowedStudentAssociationsEmploymentTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-student-organization-associations-nationality-types:
    get:
      tags:
      - person
      summary: A list of allowed student nationality types
      description: Get a list of allowed student nationality types for student organization associations on persons
      operationId: person_getAllowedStudentOrganizationAssociationsGetStudentNationalities_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-student-organization-associations-type-description-types:
    get:
      tags:
      - person
      summary: A list of allowed student type description types
      description: Get a list of allowed student type description types for student organization associations on persons
      operationId: person_getAllowedStudentOrganizationAssociationsStudentTypeDescriptions_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-titles-types:
    get:
      tags:
      - person
      summary: A list of allowed classifications for the titles property
      description: Get a list of classifications that can be used when submitting a title.
      operationId: person_getAllowedTitlesTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-visiting-scholar-organization-associations-employment-types:
    get:
      tags:
      - person
      summary: A list of allowed employment types
      description: Get a list of allowed employment types for visiting scholar organization associations on persons
      operationId: person_getAllowedVisitingScholarAssociationsEmploymentTypes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationRefList'
  /persons/allowed-workflow-steps:
    get:
      tags:
      - person
      summary: A list of allowed workflow steps
      description: Get a list of allowed workflow steps that can be used for the 'workflow' attribute of persons
      operationId: person_getAllowedWorkflowSteps_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResult'
  /persons/disciplines/allowed-discipline-schemes:
    get:
      tags:
      - person
      summary: A list of allowed discipline schemes
      description: Get a list fo a allowed discipline schemes for persons
      operationId: person_getAllowedDisciplineSchemes_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisciplinesDisciplineSchemeListResult'
  /persons/disciplines/{discipline-scheme}/allowed-disciplines:
    get:
      tags:
      - person
      summary: A list of allowed disciplines for a specific discipline scheme
      description: Get a list of a allowed disciplines for specific discipline scheme for persons
      operationId: person_getAllowedDisciplines_1
      parameters:
      - name: discipline-scheme
        in: path
        description: Identifier for the discipline scheme for persons
        required: true
        schema:
          type: string
      - name: size
        in: query
        description: Number of returned disciplines per request
        schema:
          maximum: 1000
          type: integer
          format: int32
          default: 10
      - name: offset
        in: query
        description: The offset for the returned list. 0 or null value is from the start
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisciplinesDisciplineListResult'
  /persons/disciplines/{discipline-scheme}/search:
    post:
      tags:
      - person
      summary: Query operation for disciplines associated with persons
      description: Lists disciplines from the discipline scheme associated with persons in the Pure instance that matches the provided query.
      operationId: person_listDisciplineAssociations_1
      parameters:
      - name: discipline-scheme
        in: path
        description: Identifier for the discipline scheme
        required: true
        schema:
          type: string
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisciplinesAssociationsQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisciplinesAssociationListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /persons/file-uploads:
    put:
      tags:
      - person
      summary: Upload file to a specific person
      description: Uploads file for the person
      operationId: person_fileUploads_1
      parameters:
      - name: Content-Type
        in: header
        description: Set the mime type for the file
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              format: binary
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadedFile'
            application/xml:
              schema:
                $ref: '#/components/schemas/UploadedFile'
  /persons/orderings:
    get:
      tags:
      - person
      summary: Lists available orderings
      description: Lists all orderings available to the person endpoint. These values can be used by the order parameter.
      operationId: person_getOrderings_1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderingsList'
  /persons/search:
    post:
      tags:
      - person
      summary: Query operation for persons
      description: Lists persons in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options.
      operationId: person_query_1
      requestBody:
        description: The query to perform
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonsQuery'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonListResult'
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /persons/{uuid}:
    get:
      tags:
      - person
      summary: Get person
      description: Get person with specific UUID.
      operationId: person_get_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the desired person
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Person'
        '301':
          description: The requested content have changed UUID
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - person
      summary: Update person
      description: Update person with specific UUID.
      operationId: person_update_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the person to update
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      requestBody:
        description: The content to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Person'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Person'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Resource not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Version conflict
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ConflictProblemDetails'
    delete:
      tags:
      - person
      summary: Delete person
      description: Delete person with specific UUID.
      operationId: person_delete_1
      parameters:
      - name: uuid
        in: path
        description: UUID of the person
        required: true
        schema:
          pattern: .+
          type: string
          format: uuid
      responses:
        '204':
          description: Successful operation
        '404':
          description

# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hong-kong-baptist-university/refs/heads/main/openapi/hong-kong-baptist-university-person-api-openapi.yml