find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/x-road-global:x-road-global-member-classes-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: X Road Global Member Classes API
  contact:
    email: info@niis.org
    name: Nordic Institute for Interoperability Solutions (NIIS)
    url: https://github.com/nordic-institute/X-Road-development/#enhancement-requests-and-error-reports
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: '1.0'
  description: 'Operations tagged member-classes across 4 of this provider''s published API definitions: central-server-admin-openapi.yaml, security-server-admin-openapi.yaml, x-road-global-central-server-admin-openapi.yml, x-road-global-security-server-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: basepath for API v1
  url: /api/v1
security:
- ApiKeyAuth: []
tags:
- name: member-classes
  description: resources related to Central Server's member classes
paths:
  /member-classes:
    get:
      description: CS Administrator lists member classes.
      operationId: getMemberClasses
      responses:
        '200':
          content:
            application/json:
              schema:
                description: array of member classes
                items:
                  $ref: '#/components/schemas/MemberClass'
                type: array
                uniqueItems: false
          description: array of member classes
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List member classes
      tags:
      - member-classes
    post:
      description: 'CS Administrator adds a new member class.


        The member class will be validated and if the validation fails a validation error is returned.'
      operationId: addMemberClass
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberClass'
        description: new additional member class to add
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberClass'
          description: the added member class
        '400':
          content:
            application/json:
              examples:
                error_response:
                  $ref: '#/components/examples/ErrorExample'
                validation_errors_response:
                  $ref: '#/components/examples/ValidationErrorsExample'
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: there are errors in the request
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: add a new member class
      tags:
      - member-classes
    servers:
    - description: basepath for API v1
      url: /api/v1
  /member-classes/{code}:
    parameters:
    - description: code of the member class
      in: path
      name: code
      required: true
      schema:
        format: text
        maxLength: 255
        minLength: 1
        type: string
    delete:
      description: CS Administrator deletes a member class.
      operationId: deleteMemberClass
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: delete a member class
      tags:
      - member-classes
    patch:
      tags:
      - member-classes
      summary: Update member class
      operationId: updateMemberClass
      description: CS Administrator updates a member class description.
      requestBody:
        description: the new description of the member class
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberClassDescription'
      responses:
        '200':
          description: updated member class
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberClass'
        '400':
          description: request was invalid
        '401':
          description: authentication credentials are missing
        '403':
          description: request has been refused
        '404':
          description: resource requested does not exists
        '406':
          description: request specified an invalid format
        '500':
          description: internal server error
    servers:
    - description: basepath for API v1
      url: /api/v1
  /member-classes/{id}:
    get:
      tags:
      - member-classes
      summary: get list of known member classes for a given instance
      operationId: getMemberClassesForInstance
      description: Administrator lists member classes for a given instance.
      parameters:
      - in: path
        name: id
        description: instance id
        required: true
        schema:
          type: string
          format: text
          minLength: 1
          maxLength: 255
      responses:
        '200':
          description: array of member classes
          content:
            application/json:
              schema:
                type: array
                description: array of member classes
                uniqueItems: true
                items:
                  type: string
                  format: text
                  minLength: 1
                  maxLength: 255
        '400':
          description: request was invalid
        '401':
          description: authentication credentials are missing
        '403':
          description: request has been refused
        '404':
          description: resource requested does not exists
        '406':
          description: request specified an invalid format
        '500':
          description: internal server error
    servers:
    - url: /api/v1
      description: basepath for API v1
components:
  responses:
    NotFound:
      description: resource requested does not exists
    NoContent:
      description: request was successful
    Forbidden:
      description: request has been refused
    Unauthorized:
      description: authentication credentials are missing
    Conflict:
      description: an existing item already exists
    InternalServerError:
      description: internal server error
    BadRequest:
      description: request was invalid
  examples:
    ErrorExample:
      $ref: ../../../../../common/common-admin-api/src/main/resources/common-openapi-definition.yaml#/components/examples/ErrorExample
    ValidationErrorsExample:
      summary: Validation errors response body example
      value:
        error:
          code: validation_failure
          validation_errors:
            initialServerConfDto.instanceIdentifier:
            - IdentifierChars
        status: 400
  schemas:
    MemberClassDescription:
      description: Central server's member class description
      properties:
        description:
          description: member class description
          example: Non-profit organisations
          format: text
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z0-9-_,.;:!? ]*$
          type: string
      required:
      - description
      type: object
    ErrorInfo:
      $ref: ../../../../../common/common-admin-api/src/main/resources/common-openapi-definition.yaml#/components/schemas/ErrorInfo
    MemberClass:
      allOf:
      - $ref: '#/components/schemas/MemberClassDescription'
      description: Central server's member classes
      properties:
        code:
          description: member class code
          example: ORG
          format: text
          maxLength: 255
          minLength: 1
          type: string
      required:
      - code
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: X-Road-ApiKey token=<api key>
      in: header
      name: Authorization
      type: apiKey
x-refined-from:
- central-server-admin-openapi.yaml
- security-server-admin-openapi.yaml
- x-road-global-central-server-admin-openapi.yml
- x-road-global-security-server-admin-openapi.yml