Trove Contributor API

openapi: 3.2.0
info:
  title: Trove Contributor API
  version: 3.0.0
  termsOfService: https://trove.nla.gov.au/about/create-something/using-api/trove-api-terms-use
  description: 'Operations tagged Contributor across 2 of this provider''s published API definitions: trove-api-v3.yaml, trove-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
security:
- ApiKey: []
tags:
- name: Contributor
  description: Contributors
paths:
  /v3/contributor:
    get:
      operationId: findContributors
      tags:
      - Contributor
      description: Search for Contributors
      responses:
        '200':
          description: The Contributor search was successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contributorSearchResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/contributorSearchResult'
        default:
          description: Any unsuccessful response will be returned as an error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
            application/xml:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - name: q
        description: The search query.
        in: query
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/reclevel'
      - $ref: '#/components/parameters/encoding'
      externalDocs:
        url: https://trove.nla.gov.au/about/create-something/using-api/v3/api-technical-guide#contrib
      summary: Find contributors
      x-summary-source: derived
    servers:
    - url: /
  /v3/contributor/{id}:
    get:
      operationId: getContributor
      tags:
      - Contributor
      description: Retrieves a specific Contributor
      responses:
        '200':
          description: The Contributor was successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contributor'
            application/xml:
              schema:
                $ref: '#/components/schemas/contributor'
        default:
          description: Any unsuccessful response will be returned as an error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
            application/xml:
              schema:
                $ref: '#/components/schemas/error'
      parameters:
      - name: id
        description: The ID of the contributor to retrieve
        required: true
        in: path
        schema:
          type: string
      - $ref: '#/components/parameters/reclevel'
      - $ref: '#/components/parameters/encoding'
      externalDocs:
        url: https://trove.nla.gov.au/about/create-something/using-api/v3/api-technical-guide#get-information-about-one-contributor
      summary: Get contributor
      x-summary-source: derived
    servers:
    - url: /
components:
  schemas:
    contributor:
      xml:
        name: contributor
      type: object
      properties:
        id:
          type: string
          description: Either the contributor's NUC or a numeric id.
          example: ANL
          xml:
            attribute: true
        url:
          type: string
          description: The contributor's Trove API url
          example: https://api.trove.nla.gov.au/v3/contributor/ANL
          xml:
            attribute: true
        name:
          type: string
          description: The contributor's name
          example: National Library of Australia
        nuc:
          type: string
          description: The contributor's NUC
          example: ANL
        shortname:
          type: string
          description: A shorter version of the contributor's name
          example: NLA
        totalholdings:
          type: integer
          description: The total number of holders the contributor has
          example: 123
        accesspolicy:
          type: string
          description: The contributor's access conditions
          example: Open to the public
        homepage:
          type: string
          description: The contributor's web page
          example: https://nla.gov.au
        algentry:
          type: string
          description: The url to contributor's ALG entry
        parent:
          type: object
          description: The contributor's parent institution, if there is one
          properties:
            id:
              type: string
              description: The identifier of the parent institution.
              xml:
                attribute: true
            url:
              type: string
              description: The parent institution's Trove API url.
              xml:
                attribute: true
            name:
              type: string
              description: The parent institution's name.
        children:
          type: array
          description: The contributor's child institutions, if there are any
          items:
            $ref: '#/components/schemas/contributor'
    contributorSearchResult:
      xml:
        name: response
      type: object
      properties:
        total:
          type: integer
          description: The number of matching Contributors.
          xml:
            attribute: true
        contributor:
          type: array
          description: The list of matching Contributors.
          items:
            $ref: '#/components/schemas/contributor'
    recLevel:
      type: string
      enum:
      - full
      - brief
      default: brief
    error:
      type: object
      xml:
        name: error
      properties:
        statusCode:
          type: integer
          description: The HTTP status code.
          example: 404
        statusText:
          type: string
          description: The HTTP status reason phrase.
          example: Not Found
        description:
          type: string
          description: A brief description of the error.
          example: A matching record could not be found.
  parameters:
    encoding:
      name: encoding
      in: query
      description: Get the response in xml (default) or json. Alternately, specify a HTTP accept content type of application/xml or application/json.
      required: false
      schema:
        type: string
        enum:
        - json
        - xml
        default: xml
    reclevel:
      name: reclevel
      in: query
      description: Indicates whether to return a full or brief metadata record.
      required: false
      schema:
        $ref: '#/components/schemas/recLevel'
  securitySchemes:
    ApiKey:
      type: apiKey
      name: X-API-KEY
      in: header
      description: Enter your Trove API key to execute a call
externalDocs:
  description: View the full Trove API documentation.
  url: https://trove.nla.gov.au/about/create-something/using-api
x-refined-from:
- trove-api-v3.yaml
- trove-openapi.yml