Discovery needs no key. Ratings and market analysis are Pro.
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.
openapi: 3.2.0
info:
version: 1.1.0
title: AlayaCare Services Service Forms API
description: '**External IDs:**
The following terms are used to reference ids that identify resources in
systems external to AlayaCare:
- client_id
- employee_id
- service_id
- funder_id
- visit_id
- facility_id
External IDs are required to be unique.
No other assumptions are made regarding their format; they are treated as
strings.
**AlayaCare IDs:**
The following terms are used to reference ids that identify resources in
AlayaCare:
- alayacare_client_id
- alayacare_employee_id
- alayacare_service_id
- alayacare_funder_id
- alayacare_visit_id
- alayacare_facility_id
**Remarks**
- All dates must be in ISO 8601 format with timezone data
'
servers:
- url: https://homecare.alayacare.ca/ext/api/v2/scheduler
- url: https://homecare.uat.alayacare.ca/ext/api/v2/scheduler
- url: https://homecare.staging.alayacare.ca/ext/api/v2/scheduler
security:
- basicAuth: []
tags:
- name: Service Forms
paths:
/services/forms:
parameters:
- name: name
description: Filter by the name of the form
in: query
required: false
schema:
type: string
- name: branch_id
description: Filter by the branch_id of the form
in: query
required: false
schema:
type: string
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/count'
get:
tags:
- Service Forms
summary: Get list of forms that can be attached to services
description: 'Get a list of forms
'
responses:
'200':
description: The list of forms
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceFormList'
'401':
$ref: '#/components/responses/ErrorResponseAuthentication'
components:
schemas:
ServiceForm:
description: Details of forms
type: object
properties:
branch:
$ref: '#/components/schemas/Branch'
id:
type: integer
minimum: 1
description: Service code id
example: 1
name:
type: string
description: Service Code name
example: SC1
status:
type: string
description: service form status
example: active
version:
type: string
description: service form version
example: 1
ErrorResponse:
description: Error response
type: object
properties:
code:
type: integer
example: 400
description: Response code
message:
type: string
example: Invalid request
description: Detailed error message
required:
- code
- message
ServiceFormList:
allOf:
- $ref: '#/components/schemas/PaginatedList'
description: Paginated list of forms
properties:
items:
type: array
items:
$ref: '#/components/schemas/ServiceForm'
PaginatedList:
description: Base model of all paginated lists
type: object
properties:
count:
type: integer
description: Number of items in the response
example: 1
page:
type: integer
description: Current page number
example: 1
total_pages:
type: integer
description: Total number of pages availbale
example: 1
items:
type: array
items:
type: object
required:
- count
- page
- total_pages
- items
Branch:
description: AlayaCare branch
type: object
properties:
id:
type: integer
minimum: 1
description: Branch ID
example: 1000
name:
type: string
description: Branch name
example: Toronto branch
parameters:
page:
description: Filter by page number.
name: page
in: query
required: false
schema:
default: 1
type: integer
minimum: 1
count:
description: Number of items per page.
name: count
in: query
required: false
schema:
default: 100
type: integer
minimum: 0
responses:
ErrorResponseAuthentication:
description: Authorization required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: 401
message: Authorization required.
securitySchemes:
basicAuth:
type: http
scheme: basic