openapi: 3.1.0
info:
  title: MLB MLB v3 Headshots NHL v3 Headshots API
  version: '1.0'
  description: MLB API - OpenAPI 3.1 Specification
servers:
- url: https://api.sportsdata.io
  description: Production server
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: NHL v3 Headshots
paths:
  /v3/nhl/headshots/{format}/Headshots:
    get:
      description: Headshots
      operationId: nhl_v3_headshots_headshots
      summary: Headshots
      parameters:
      - name: format
        in: path
        description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
        required: true
        schema:
          type: string
          enum:
          - JSON
          - XML
          default: JSON
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Headshot'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
      tags:
      - NHL v3 Headshots
components:
  schemas:
    Unauthorized:
      properties:
        HttpStatusCode:
          type: integer
        Code:
          type: integer
        Description:
          type: string
        Help:
          type: string
    Headshot:
      properties:
        PlayerID:
          type: integer
          description: 'The player''s unique PlayerID as assigned by SportsDataIO. Note: this ID will stay with the player throughout their entire career'
        Name:
          type:
          - string
          - 'null'
          description: The player's full name
        TeamID:
          type:
          - integer
          - 'null'
          description: The unique ID of the team
        Team:
          type:
          - string
          - 'null'
          description: The abbreviation [Key] of the team the player belongs to
        Position:
          type:
          - string
          - 'null'
          description: 'The player''s primary position. Possible values: C; RW; LW; D; or G.'
        PreferredHostedHeadshotUrl:
          type:
          - string
          - 'null'
          description: The player's preferred hosted headshot URL. This returns the headshot with transparent background, if available.
        PreferredHostedHeadshotUpdated:
          type:
          - string
          - 'null'
          description: The last updated date of the player's preferred hosted headshot.
        HostedHeadshotWithBackgroundUrl:
          type:
          - string
          - 'null'
          description: The player's hosted headshot URL
        HostedHeadshotWithBackgroundUpdated:
          type:
          - string
          - 'null'
          description: The last updated date of the player's hosted headshot
        HostedHeadshotNoBackgroundUrl:
          type:
          - string
          - 'null'
          description: The player's transparent background hosted headshot URL
        HostedHeadshotNoBackgroundUpdated:
          type:
          - string
          - 'null'
          description: The last updated date of the player's transparent background hosted headshot
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: key
      in: query