idMatchPartial.yaml

openapi: 3.0.0
# Added by API Auto Mocking Plugin
servers:
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/TIER_API_and_Schema/IdMatch/1.0.0
info:
  version: "1.0.0"
  title: IdMatch
  description: >-
    API used by a System of Record to obtain an enterprise identifier for a person new to them; Handles different cases (unique determination, multiple candidates, etc.)
security:
  - accessCode:
      - read
      - write
paths:
  /people/{SorId}/{personId}:
    put:
      summary: Attempt match for an SoR person
      operationId: Reference Identifier Request
      parameters:
        - in: path
          name: SorId
          schema:
            type: string
          required: true
          description: Identifier of the System of Record
        - in: path
          name: personId
          schema:
            type: string
          required: true
      description: SoR's identifier for the person
      responses:
        '200':
          description: OK
    get:
      summary: Attempt match for an SoR person
      operationId: Request Search Only
      parameters:
        - in: path
          name: SorId
          schema:
            type: string
          required: true
          description: Identifier of the System of Record
        - in: path
          name: personId
          schema:
            type: string
          required: true
          description: SoR's identifier for the person
      security: []
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    accessCode:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: 'http://example.com/oauth/auth'
          tokenUrl: 'http://example.com/oauth/token'
          scopes:
            write: allows modifying resources
            read: allows reading resources