swagger: '2.0' info: x-ibm-name: ndis-products title: NDIS Products version: 3.0.0 description: Digital Partners can look up a specific product summary contact: name: NDIA Support Team email: api.support@ndis.gov.au schemes: - https host: api.ndis.gov.au basePath: /sharedservices/ndis-api/ndis/3.0/products 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/3.0/products description: '' type: - production - development - url: https://api.ndis.gov.au/sharedservices/ndis-api/ndis/3.0/products description: '' type: - production - development paths: /{product_name}: get: responses: '200': description: 200 OK schema: $ref: '#/definitions/product_list_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' summary: Query NDIA product summary description: |- This operation will retrieve the details of a Support Item, its unit of measure and validity time frame In order to get a successful response, Digital Partners will require a valid product category item or product category item short text. In order to retrieve the acceptable product_category_item and product category item short text values, please use NDIS Reference Data API, GET /{attribute_name} operation, and supply product_category_item in the path as the attribute_name. The key and the value retrieved as part of Reference Data can be passed to the GET/{product_name} endpoint. For example, supplying either the key '05_123906171_0113_1_2' or value 'Assistive Products for Electronic Orientation', as displayed in the Reference Data API to the GET/{product_name} endpoint, will result in a successful response. Please note that support items retrieved using the Products API or the Plan Budget API (in CIT and Production) may not always match the latest NDIS Pricing Arrangements and Price Limit Guide or Support Catalogue. The reasons for the above are as below: 1. The NDIS Pricing Arrangements and Price Limit Guide is a subset of the Support Catalogue, and only contains active support items that are NOT end dated. See below an example of a support item "01_134_0117_8_1" that features in the latest NDIS Pricing Arrangements and Price Limit Guide. This item is not currently end dated as it is valid through to "9999-12-31". This item is also available in the 'Current Support Items' tab of the Support Catalogue spreadsheet, published on the NDIS website. 2. End dated support items are not published in the NDIS Pricing Arrangements and Price Limits; in order to slowly phase out old or obsolete support items. These items however are still active, and therefore will be displayed through the Products and Plan Budget API. Please see below a screenshot of one such support item, "01_001_0101_1_1" that is available via the Products API but not in the NDIS Pricing Arrangements and Price Limit Guide. This item has a end date of "2022-03-09", after which it will become inactive. This item is also available in the 'Legacy Support Items' tab of the Support Catalogue spreadsheet, published on the NDIS website. operationId: productlist parameters: - $ref: '#/parameters/authorization' - $ref: '#/parameters/product_name' parameters: authorization: name: authorization type: string required: true in: header description: Bearer token x-example: valid Authorizaton Token product_name: name: product_name type: string required: true in: path description: String to be searched from the value of the Reference Data attributes product_category_item or product_category_itm_short_txt x-example: product_name definitions: product_list_response: properties: success: type: boolean description: success status of call example: true result: $ref: '#/definitions/product_list' description: result object errors: $ref: '#/definitions/errors' additionalProperties: false required: - success product_list: type: array items: $ref: '#/definitions/product_list_item' product_list_item: properties: product_category_item: type: string description: Support Category Item Number maxLength: 40 example: 09 27 09 03 product_category_itm_short_txt: type: string description: Product Description maxLength: 80 example: washable incontinence products for children unit_of_measure: type: string description: Product Unit of Measure maxLength: 3 example: EA unit_description: type: string description: Product Unit Description maxLength: 10 example: each support_category: type: string description: Support Category Code of the Product maxLength: 50 example: CONSUMABLES support_category_text: type: string description: Support Category Text maxLength: 60 example: Consumables item_valid_from: type: string description: 'date, Start date of Product Validity ' example: '2013-06-10' item_valid_to: type: string description: date, End date of Product Validity example: '2018-06-30' rego_group: type: string description: Registration Group maxLength: 40 example: Development-Life Skills 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: []