swagger: '2.0'
info:
  x-ibm-name: ndis-participant-plan-type
  title: NDIS Participant Plan Type
  version: 4.0.0
  description: Digital Partners are able to determine the participant's plan type. The plan type will either be Existing Plan or PACE Plan
  contact:
    name: NDIA Support Team
    email: api.support@ndis.gov.au
schemes:
  - https
host: api.ndis.gov.au
basePath: /sharedservices/ndis-api/ndis/4.0/determine-participant-plan
consumes:
  - application/json
produces:
  - application/json
security:
  - clientIdHeader: []
securityDefinitions:
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: 'apiKey provided during registration. Max Length(64). example: aa111aa-11a1-1a11-111a-1a1a11aa111a'
x-ibm-configuration:
  testable: true
  enforced: true
  cors:
    enabled: true
  phase: realized
  type: rest
  servers:
    - url: https://api.ndis.gov.au/sharedservices/ndis-api/ndis/4.0/determine-participant-plan
      description: ''
      type:
        - production
        - development
    - url: https://api.ndis.gov.au/sharedservices/ndis-api/ndis/4.0/determine-participant-plan
      description: ''
      type:
        - production
        - development
paths:
  /:
    get:
      responses:
        '200':
          description: 'Success: The request was successful'
          schema:
            $ref: '#/definitions/getaparticipanttype_response'
        '400':
          description: 'Bad Request: A validation resulted in the request being rejected.'
          schema:
            $ref: '#/definitions/http_error'
        '401':
          description: 'Unauthorised: No authentication credentials provided or authentication has failed.'
          schema:
            $ref: '#/definitions/http_error'
        '404':
          description: The URI path or the requested record was not found.
          schema:
            $ref: '#/definitions/http_error'
        '500':
          description: 'Internal Server Error: An internal error has occurred and the server is unable to respond.'
          schema:
            $ref: '#/definitions/http_error'
      tags:
        - GET
      operationId: getParticipantType
      summary: This operation will determine the Participant Plan Type and retrieve the appropriate response.
      description: "\nThis API operation will determine whether the Participant Type is a Existing Plan or a PACE plan, and retrieve the Participant Type response field details accordingly.\n\nIf the Participant Type is a Existing plan.</br>\nExample: \"is_pace_plan: False\"\n\nIf the Particpant Type is a PACE plan.</br>\nExample: \"is_pace_plan: True\"\n\nIf the Provider has no relationship with the PACE Participant.</br>\nExample: \"success\": false, \"errors\": [ \"Provider / Requestor has no authority to access the plan\"]\n\nTo get the successful response, the provider needs below details:\n1. Participant ID\n2. Participant_Surname\n3. Participant date_of_birth <br></br>\n<b>Note:</b> \n* For PACE participants, Determine Participant Plan Type will be based on Provider relationship. <br></br>\t"
    parameters:
      - $ref: '#/parameters/participant'
      - $ref: '#/parameters/participant_surname'
      - $ref: '#/parameters/date_of_birth'
      - $ref: '#/parameters/authorization'
parameters:
  authorization:
    name: authorization
    type: string
    required: true
    in: header
    description: Bearer token
    x-example: valid Authorizaton Token
  participant:
    description: NDIS number of Participant
    format: int32
    in: query
    maxLength: 10
    name: participant
    required: true
    type: integer
    x-example: 430111111
  participant_surname:
    name: participant_surname
    type: string
    required: true
    in: query
    description: Participant surname
    x-example: surname
  date_of_birth:
    name: date_of_birth
    type: string
    required: true
    in: query
    description: Participant DOB
    format: date
definitions:
  getaparticipanttype_response:
    description: Response for Geting a participant type
    properties:
      success:
        type: boolean
        example: true
      result:
        $ref: '#/definitions/getparticipanttype_list_item'
      errors:
        $ref: '#/definitions/errors'
    additionalProperties: false
    required:
      - success
  getparticipanttype_list:
    description: Participant Type list
    type: array
    items:
      $ref: '#/definitions/getparticipanttype_list_item'
  getparticipanttype_list_item:
    properties:
      is_pace_plan:
        type: boolean
        description: Is PACE plan status
        example: true
      plan_first_start_date:
        type: string
        description: Pace - Plan First Start Date  YYYY-MM-DD
        example: '2019-06-03'
        format: date
    additionalProperties: false
  errors:
    description: A set of errors
    type: array
    items:
      type: string
      example: error
  http_error:
    description: A single HTTP response
    properties:
      http_code:
        type: string
        example: 400
        description: HTTP status code
      http_message:
        type: string
        example: Bad Request
        description: HTTP Message
      more_information:
        type: string
        example: One or more required API parameters are missing.
        description: Additional information
    additionalProperties: false
tags: []