Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
executable file 6910 lines (6909 sloc) 198 KB
swagger: '2.0'
info:
title: "Human Services Data API"
description: "This is a specification describing the Human Services Data API, using the Human Services Data Specification (HSDS). This has been extracted from the Ohana API deployment, but will be standardized to refer to the universal standard that will apply to any HSDS/A compliant API."
termsOfService: "https://openreferral.org/documentation/"
contact:
name: Open Referral
url: https://openreferral.org/
email: info@openreferral.org
license:
name: Creative Commons Attribution Share-Alike 4.0
url: https://creativecommons.org/licenses/by-sa/4.0/
version: v1.2
host: example.com
basePath: /
schemes:
- http
produces:
- application/json
- application/xml
- text/csv
paths:
/contacts/:
get:
summary: Get all contacts
description: Returns a list of all registered contacts with filtering support
operationId: listContacts
parameters:
- in: query
type: string
name: query
description: A query to filter list by (up to provider to determine what to search)
- in: query
type: string
name: queries
description: A comma separate list of queries with specific fields.
- in: query
type: number
name: page
default: 0
description: The particular page of results.
- in: query
type: number
name: per_page
default: 25
description: Number of records to return per page, up to 100.
- in: query
type: string
name: sort_by
default: name
description: Which field to sort by.
- in: query
type: string
name: order
default: asc
description: Which order to sort by (asc,desc).
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
post:
summary: Add contact
description: Creates a new named contact entry for services or organizations
operationId: addContact
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/contact'
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
/contacts/complete/:
get:
summary: Get all contacts with full details
description: Returns a list of contacts with full details and filtering support
operationId: listContactsComplete
parameters:
- in: query
type: string
name: query
description: A query to filter list by (up to provider to determine what to search)
- in: query
type: string
name: queries
description: A comma separate list of queries with specific fields.
- in: query
type: number
name: page
default: 0
description: The particular page of results.
- in: query
type: number
name: per_page
default: 25
description: Number of records to return per page, up to 100.
- in: query
type: string
name: sort_by
default: name
description: Which field to sort by.
- in: query
type: string
name: order
default: asc
description: Which order to sort by (asc,desc).
responses:
'200':
description: Contact Complete Response
schema:
type: array
items:
$ref: "#/definitions/contact_complete"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
post:
summary: Add contact with full details
description: Creates a new contact entry with full details
operationId: addContactsComplete
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/contact_complete'
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Complete Response
schema:
type: array
items:
$ref: "#/definitions/contact_complete"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
/contacts/complete/{contact_id}/:
get:
summary: Get contact with full details
description: Returns a contact entry with full details
operationId: getContactComplete
parameters:
- in: path
required: true
type: string
name: contact_id
description: The contact id.
responses:
'200':
description: Contact Complete Response
schema:
type: array
items:
$ref: "#/definitions/contact_complete"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
put:
summary: Update contact with full details
description: Updates a contact entry with full details
operationId: updateContactsComplete
parameters:
- in: path
required: true
type: string
name: contact_id
description: The contact id.
- in: body
name: body
schema:
$ref: '#/definitions/contact_complete'
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Complete Response
schema:
type: array
items:
$ref: "#/definitions/contact_complete"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
delete:
summary: Delete contact with full details
description: Deletes a contact entry with full details
operationId: deleteContact
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The contact id.'
tags:
- Contacts
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
/contacts/{contact_id}/:
get:
summary: Get contact
description: Returns a contact entry by its Id
operationId: getContact
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The contact id.'
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
put:
summary: Update a contact
description: Updates an existing contact by Id
operationId: updateContact
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The contact id.'
- in: body
name: body
schema:
$ref: '#/definitions/contact'
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
delete:
summary: Delete contact
description: Deletes a contact by Id
operationId: deleteContactComplete
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The contact id.'
tags:
- Contacts
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
/contacts/{contact_id}/phones/:
get:
summary: Get all phones for contact
description: Returns a list of phones associated with a specific contact
operationId: listContactPhones
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The unique contact id.'
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
post:
summary: Add phone for contact
description: Adds a new phone that is associated with a specific contact Id
operationId: addContactPhone
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The unique contact id.'
- in: body
name: body
schema:
$ref: '#/definitions/phone'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
/contacts/{contact_id}/phones/{phone_id}/:
get:
summary: Get phone for contact
description: Returns the specific phone entity associated with a specific contact
operationId: getContactPhone
parameters:
- in: path
required: true
type: string
name: contact_id
description: The unique contact id.
- in: path
required: true
type: string
name: phone_id
description: The unique phone id.
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
put:
summary: Update phone for contact
description: Updates an existing contact's phone entry
operationId: updateContactPhone
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The unique contact id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
- in: body
name: body
schema:
$ref: '#/definitions/phone'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
delete:
summary: Delete phone for contact
description: Deletes a specific phone instance associated with a specific contact Id
operationId: deleteContactPhone
parameters:
- in: path
required: true
type: string
name: contact_id
description: 'The unique contact id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Contacts
/locations/:
get:
summary: Get all locations
description: Returns a list of locations with filtering support
operationId: listLocations
parameters:
- in: query
type: string
name: query
description: A query to filter list by (up to provider to determine what to search)
- in: query
type: string
name: queries
description: A comma separate list of queries with specific fields.
- in: query
type: number
name: page
default: 0
description: The particular page of results.
- in: query
type: number
name: per_page
default: 25
description: Amount of locations to return per page, up to 100.
- in: query
type: string
name: sort_by
default: name
description: Which field to sort by.
- in: query
type: string
name: order
default: asc
description: Which order to sort by (asc,desc).
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add location
description: Creates a new location entry
operationId: addLocation
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/location'
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/complete/:
get:
summary: Get all locations with full details
description: Returns a list of locations with full details and filtering support
operationId: listLocationsComplete
parameters:
- in: query
type: string
name: query
description: A query to filter list by (up to provider to determine what to search)
- in: query
type: string
name: queries
description: A comma separate list of queries with specific fields.
- in: query
type: number
name: page
default: 0
description: The particular page of results.
- in: query
type: number
name: per_page
default: 25
description: Number of records to return per page, up to 100.
- in: query
type: string
name: sort_by
default: name
description: Which field to sort by.
- in: query
type: string
name: order
default: asc
description: Which order to sort by (asc,desc).
responses:
'200':
description: Location Complete Response
schema:
type: array
items:
$ref: "#/definitions/location_complete"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add location with full details
description: Creates a new location entry with full details
operationId: addLocationsComplete
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/location_complete'
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Complete Response
schema:
type: array
items:
$ref: "#/definitions/location_complete"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/complete/{location_id}/:
get:
summary: Get location with full details
description: Returns a location entry with full details
operationId: getLocationComplete
parameters:
- in: path
required: true
type: string
name: location_id
description: The location id.
responses:
'200':
description: Location Complete Response
schema:
type: array
items:
$ref: "#/definitions/location_complete"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update location with full details
description: Updates a location entry with full details
operationId: updateLocationsComplete
parameters:
- in: path
required: true
type: string
name: location_id
description: The location id.
- in: body
name: body
schema:
$ref: '#/definitions/location_complete'
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Complete Response
schema:
type: array
items:
$ref: "#/definitions/location_complete"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/:
get:
summary: Get location
description: Returns a location entry by Id
operationId: getLocation
parameters:
- in: path
required: true
type: string
name: location_id
description: The location id.
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update location
description: Updates a location entry
operationId: updateLocation
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/location'
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete location
description: Deletes a location entry
operationId: deleteLocationComplete
parameters:
- in: path
required: true
type: string
name: location_id
description: The location id.
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/holiday-schedule/:
get:
summary: Get all holiday schedules for a location
description: Returns the list of holiday schedules for a specific location
operationId: listLocationHolidaySchedules
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Holiday Schedule Response
schema:
type: array
items:
$ref: "#/definitions/holiday_schedule"
'404':
description: Not Found Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add holiday schedule for location
description: Creates a new holiday schedule entry for a location
operationId: addLocationHolidaySchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/holiday_schedule'
security:
- appid: []
- appkey: []
responses:
'200':
description: Holiday Schedule Response
schema:
type: array
items:
$ref: "#/definitions/holiday_schedule"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/holiday-schedule/{holiday_schedule_id}/:
get:
summary: Get holiday schedule for location
description: Returns a specific holiday schedule for a location by Id
operationId: getLocationHolidaySchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: holiday_schedule_id
description: 'The unique holiday schedule id.'
responses:
'200':
description: Holiday Schedule Response
schema:
type: array
items:
$ref: "#/definitions/holiday_schedule"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update holiday schedule for location
description: Updates a holiday schedule entry for a location
operationId: updateLocationHolidaySchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: holiday_schedule_id
description: 'The unique holiday schedule id.'
- in: body
name: body
schema:
$ref: '#/definitions/holiday_schedule'
security:
- appid: []
- appkey: []
responses:
'200':
description: Holiday Schedule Response
schema:
type: array
items:
$ref: "#/definitions/holiday_schedule"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete holiday schedule for location
description: Deletes a holiday schedule entry for a location
operationId: deleteLocationHolidaySchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: holiday_schedule_id
description: 'The unique holiday schdule id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Holiday Schedule Response
schema:
type: array
items:
$ref: "#/definitions/holiday_schedule"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/languages/:
get:
summary: Get all languages for a location
description: Returns a list of all languages supported by a location
operationId: listLocationLanguages
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Language Response
schema:
type: array
items:
$ref: "#/definitions/language"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add language for location
description: Adds a new language entry for a location
operationId: addLocationLanguages
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/language'
security:
- appid: []
- appkey: []
responses:
'200':
description: Language Response
schema:
type: array
items:
$ref: "#/definitions/language"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/languages/{language_id}/:
get:
summary: Get language for location
description: Returns a specific language entry for a specific location by Id
operationId: getLocationLanguages
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: language_id
description: 'The unique language id.'
responses:
'200':
description: Language Response
schema:
type: array
items:
$ref: "#/definitions/language"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update a language for a location
description: Updates a language entry for a specific location
operationId: updateLocationLanguages
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: language_id
description: 'The unique language id.'
- in: body
name: body
schema:
$ref: '#/definitions/language'
security:
- appid: []
- appkey: []
responses:
'200':
description: Language Response
schema:
type: array
items:
$ref: "#/definitions/language"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete language for location
description: Deletes a language entry for a specific location
operationId: deleteLocationLanguages
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: language_id
description: 'The unique language id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Language Response
schema:
type: array
items:
$ref: "#/definitions/language"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/postal-address/:
get:
summary: Get all postal addresses of a location
description: Returns a list of postal addresses for a location
operationId: listLocationPostalAddresses
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add postal address for location
description: Creates a new postal address for a specific location
operationId: addLocationPostalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/postal_address'
security:
- appid: []
- appkey: []
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/postal-address/{postal_address_id}/:
get:
summary: Get postal address for location
description: Returns a postal address entry for a specific location
operationId: getLocationPostalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: postal_address_id
description: 'The unique postal address id.'
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update postal address for location
description: Updates a postal address entry for a specific location
operationId: updateLocationPostalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: postal_address_id
description: 'The unique postal address id.'
- in: body
name: body
schema:
$ref: '#/definitions/postal_address'
security:
- appid: []
- appkey: []
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete postal address for location
description: Deletes a postal adress entry for a specific location
operationId: deleteLocationPostalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: postal_address_id
description: 'The unique postal address id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/physical-address/:
get:
summary: Get physical addresses for location
description: Returns a list of physical addresses for a specific location
operationId: listLocationPhysicalAddresses
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add physical address for location
description: Creates a new phsycial address entry for a specific location
operationId: addLocationPhysicalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/postal_address'
security:
- appid: []
- appkey: []
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/physical-address/{postal_address_id}/:
get:
summary: Get physical address for location
description: Returns a physical address entry for a specific location
operationId: getLocationPhysicalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: postal_address_id
description: 'The unique postal address id.'
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update physical address for location
description: Updates a physical address entry for a specific location
operationId: updateLocationPhysicalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: postal_address_id
description: 'The unique postal address id.'
- in: body
name: body
schema:
$ref: '#/definitions/postal_address'
security:
- appid: []
- appkey: []
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete a physical address for a location
description: Deletes a phsysical address entry for a specific location
operationId: deleteLocationPhysicalAddress
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: postal_address_id
description: 'The unique postal address id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Postal Address Response
schema:
type: array
items:
$ref: "#/definitions/postal_address"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/phones/:
get:
summary: Get all phones for a location
description: Returns a list of all phones for a location
operationId: listLocationPhones
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add phone for location
description: Creates a new phone entry for a specific location
operationId: addLocationPhone
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/phone'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/phones/{phone_id}/:
get:
summary: Get phone for location
description: Returns a phone entry for a specific location
operationId: getLocationPhone
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update phone for location
description: Updates a phone entry for a location
operationId: updateLocationPhone
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
- in: body
name: body
schema:
$ref: '#/definitions/phone'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete phone for location
description: Deletes a phone entry for a location
operationId: deleteLocationPhone
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/regular-schedule/:
get:
summary: Get all regular schedules for a location
description: Returns a list of regular schedules for a specific location
operationId: listLocationRegularSchedules
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Regular Schedule Response
schema:
type: array
items:
$ref: "#/definitions/regular_schedule"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add regular schedule for location
description: Creates a regular schedule entry for a specific location
operationId: addLocationRegularSchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/regular_schedule'
security:
- appid: []
- appkey: []
responses:
'200':
description: Regular Schedule Response
schema:
type: array
items:
$ref: "#/definitions/regular_schedule"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/regular-schedule/{regular_schedule_id}/:
get:
summary: Get regular schedule for location
description: Returns a regular schedule entry for a specific location
operationId: getLocationRegularSchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: regular_schedule_id
description: 'The unique regular schedule id.'
responses:
'200':
description: Regular Schedule Response
schema:
type: array
items:
$ref: "#/definitions/regular_schedule"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update regular schedule for location
description: Updates a regular schedule entry for a location
operationId: updateLocationRegularSchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: regular_schedule_id
description: 'The unique regular schedule id.'
- in: body
name: body
schema:
$ref: '#/definitions/regular_schedule'
security:
- appid: []
- appkey: []
responses:
'200':
description: Regular Schedule Response
schema:
type: array
items:
$ref: "#/definitions/regular_schedule"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete regular schedule for location
description: Deletes a regular schedule entry for a location
operationId: deleteLocationRegularSchedule
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: regular_schedule_id
description: 'The unique regular schedule id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Regular Schedule Response
schema:
type: array
items:
$ref: "#/definitions/regular_schedule"
tags:
- Locations
/locations/{location_id}/services/:
get:
summary: Get all services for location
description: Returns a list of all services for a location
operationId: listLocationServices
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add service for location
description: Creates a new service entry for a specific location
operationId: addLocationService
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/service'
security:
- appid: []
- appkey: []
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/services/{service_id}/:
get:
summary: Get service for location
description: Returns a service entry for a specific location
operationId: getLocationService
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: service_id
description: 'The unique service id.'
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update service for location
description: Updates a service entry for a specific location
operationId: updateLocationService
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: service_id
description: 'The unique service id.'
- in: body
name: body
schema:
$ref: '#/definitions/service'
security:
- appid: []
- appkey: []
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete service for location
description: Deletes a service entry for a specific location
operationId: deleteLocationService
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: service_id
description: 'The unique service id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/accessibility/:
get:
summary: Get list of accessibility for disabilities for location
description: Returns a list of all accessibility for disabilities for a specific location
operationId: listLocationAccessibilityForDisabilities
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Accessibility For Disabilities Response
schema:
type: array
items:
$ref: "#/definitions/accessibility_for_disabilities"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
post:
summary: Add accessibility for disabilities for location
description: Creates a new accessibility for disabilities entry for a specific location
operationId: addLocationAccessibilityForDisabilities
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/accessibility_for_disabilities'
security:
- appid: []
- appkey: []
responses:
'200':
description: Accessibility For Disabilities Response
schema:
type: array
items:
$ref: "#/definitions/accessibility_for_disabilities"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/locations/{location_id}/accessibility/{accessibility_id}/:
get:
summary: Get accessibility for disabilities for location
description: Returns an accessibility for disabilities entry for a specific location
operationId: getLocationAccessibilityForDisabilities
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: accessibility_id
description: 'The unique accessibility for disabilities id.'
responses:
'200':
description: Accessibility For Disabilities Response
schema:
type: array
items:
$ref: "#/definitions/accessibility_for_disabilities"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
put:
summary: Update accessibility for disabilities for location
description: Updates an existing accessibility for disabilities for a specific location
operationId: updateLocationAccessibilityForDisabilities
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: accessibility_id
description: 'The unique accessibility for disabilities id.'
- in: body
name: body
schema:
$ref: '#/definitions/accessibility_for_disabilities'
security:
- appid: []
- appkey: []
responses:
'200':
description: Accessibility For Disabilities Response
schema:
type: array
items:
$ref: "#/definitions/accessibility_for_disabilities"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
delete:
summary: Delete accessibility for disabilities for location
description: Deletes an accessibility for disabilities entry for a specific location
operationId: deleteLocationAccessibilityForDisabilities
parameters:
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: path
required: true
type: string
name: accessibility_id
description: 'The unique accessibility for disabilities id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Accessibility For Disabilities Response
schema:
type: array
items:
$ref: "#/definitions/accessibility_for_disabilities"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Locations
/organizations/:
get:
summary: Get list of organizations
description: Returns a list of all organizations with filtering support
operationId: listOrganizations
parameters:
- in: query
type: string
name: query
description: A query to filter list by (up to provider to determine what to search)
- in: query
type: string
name: queries
description: A comma separate list of queries with specific fields.
- in: query
type: number
name: page
default: 0
description: The particular page of results.
- in: query
type: number
name: per_page
default: 25
description: Number of records to return per page, up to 100.
- in: query
type: string
name: sort_by
default: name
description: Which field to sort by.
- in: query
type: string
name: order
default: asc
description: Which order to sort by (asc,desc).
responses:
'200':
description: Organization Response
schema:
type: array
items:
$ref: "#/definitions/organization"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add organization
description: Creates a new organization entry
operationId: addOrganization
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/organization'
security:
- appid: []
- appkey: []
responses:
'200':
description: Organization Response
schema:
type: array
items:
$ref: "#/definitions/organization"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/complete/:
get:
summary: Get list of organizations with full details
description: Returns a list of organizations with full schema and filtering support
operationId: listOrganizationsComplete
parameters:
- in: query
type: string
name: query
description: A query to filter list by (up to provider to determine what to search)
- in: query
type: string
name: queries
description: A comma separate list of queries with specific fields.
- in: query
type: number
name: page
default: 0
description: The particular page of results.
- in: query
type: number
name: per_page
default: 25
description: Number of records to return per page, up to 100.
- in: query
type: string
name: sort_by
default: name
description: Which field to sort by.
- in: query
type: string
name: order
default: asc
description: Which order to sort by (asc,desc).
responses:
'200':
description: Organization Complete Response
schema:
type: array
items:
$ref: "#/definitions/organization_complete"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add organization with full details
description: Creates a new organization entry with full details
operationId: addOrganizationsComplete
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/organization_complete'
security:
- appid: []
- appkey: []
responses:
'200':
description: Organization Complete Response
schema:
type: array
items:
$ref: "#/definitions/organization_complete"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/complete/{organization_id}/:
get:
summary: Get organization with full details
description: Returns an organization entry with full details by Id
operationId: getOrganizationComplete
parameters:
- in: path
required: true
type: string
name: organization_id
description: The organization id.
responses:
'200':
description: Organization Complete Response
schema:
type: array
items:
$ref: "#/definitions/organization_complete"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update organization with full details
description: Updates an organization entry with full details
operationId: updateOrganizationsComplete
parameters:
- in: path
required: true
type: string
name: organization_id
description: The organization id.
- in: body
name: body
schema:
$ref: '#/definitions/organization_complete'
security:
- appid: []
- appkey: []
responses:
'200':
description: Organization Complete Response
schema:
type: array
items:
$ref: "#/definitions/organization_complete"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/:
get:
summary: Get organization
description: Returns a specific organization entry by Id
operationId: getOrganization
parameters:
- in: path
required: true
type: string
name: organization_id
description: The organization id.
responses:
'200':
description: Organization Response
schema:
type: array
items:
$ref: "#/definitions/organization"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update organization
description: Updates an organization entry
operationId: updateOrganization
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: body
name: body
schema:
$ref: '#/definitions/organization'
security:
- appid: []
- appkey: []
responses:
'200':
description: Organization Response
schema:
type: array
items:
$ref: "#/definitions/organization"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
delete:
summary: Delete organization
description: Deletes an organization entry
operationId: deleteOrganizationComplete
parameters:
- in: path
required: true
type: string
name: organization_id
description: The organization id.
tags:
- Organizations
security:
- appid: []
- appkey: []
responses:
'200':
description: Organization Response
schema:
type: array
items:
$ref: "#/definitions/organization"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
/organizations/{organization_id}/contacts/:
get:
summary: Get all contacts for organization
description: Returns a full list of contacts for a specific organization
operationId: listOrganizationContacts
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add contact for organization
description: Creates a new contact entry to a specific organization
operationId: addOrganizationContact
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: body
name: body
schema:
$ref: '#/definitions/contact'
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/contacts/{contact_id}/:
get:
summary: Get contact for organization
description: Returns a contact entry for a specific organization
operationId: getOrganizationContact
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: contact_id
description: 'The unique contact id.'
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update contact for organization
description: Updates a contact entry for an organization
operationId: updateOrganizationContact
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: contact_id
description: 'The unique contact id.'
- in: body
name: body
schema:
$ref: '#/definitions/contact'
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
delete:
summary: Delete contact for organization
description: Deletes a contact entry for a specific organization
operationId: deleteOrganizationContact
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: contact_id
description: 'The unique contact id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Contact Response
schema:
type: array
items:
$ref: "#/definitions/contact"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/funding/:
get:
summary: Get funding for organization
description: Returns a full list of funding entries for a specific organization
operationId: listOrganizationFundings
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
responses:
'200':
description: Funding Response
schema:
type: array
items:
$ref: "#/definitions/funding"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add funding for organization
description: Creates a new funding entry for a specific organization
operationId: addOrganizationFunding
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: body
name: body
schema:
$ref: '#/definitions/funding'
security:
- appid: []
- appkey: []
responses:
'200':
description: Funding Response
schema:
type: array
items:
$ref: "#/definitions/funding"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/funding/{funding_id}/:
get:
summary: Get funding for organization
description: Returns a funding entry for a specific organization
operationId: getOrganizationFunding
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: funding_id
description: 'The unique funding id.'
responses:
'200':
description: Funding Response
schema:
type: array
items:
$ref: "#/definitions/funding"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update funding for organization
description: Updates a funding entry for a specific organization
operationId: updateOrganizationFunding
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: funding_id
description: 'The unique funding id.'
- in: body
name: body
schema:
$ref: '#/definitions/funding'
security:
- appid: []
- appkey: []
responses:
'200':
description: Funding Response
schema:
type: array
items:
$ref: "#/definitions/funding"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
delete:
summary: Delete funding for organization
description: Deletes a funding entry for a specific organization
operationId: deleteOrganizationFunding
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: funding_id
description: 'The unique funding id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Funding Response
schema:
type: array
items:
$ref: "#/definitions/funding"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/locations/:
get:
summary: Get all locations for organization
description: Returns a full list of locations for a specific organization
operationId: listOrganizationLocations
parameters:
- in: path
required: true
type: string
name: organization_id
description: The id for the organization.
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add location for organization
description: Creates a new location entry for a specific organization
operationId: addOrganizationLocation
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: body
name: body
schema:
$ref: '#/definitions/location'
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/locations/{location_id}/:
get:
summary: Get location for organization
description: Returns a location entry for a specific organization
operationId: getOrganizationLocation
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update location for organization
description: Updates a location entry for a specific organization
operationId: updateOrganizationLocation
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
- in: body
name: body
schema:
$ref: '#/definitions/location'
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
delete:
summary: Delete location for organization
description: Deletes a location entry for a specific location
operationId: deleteOrganizationLocation
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: location_id
description: 'The unique location id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Location Response
schema:
type: array
items:
$ref: "#/definitions/location"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/phones/:
get:
summary: Get all phones for organization
description: Returns a full list of phones for a specific organization
operationId: listOrganizationPhones
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add phone for an organization
description: Creates a new phone entry for a specific organization
operationId: addOrganizationPhone
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: body
name: body
schema:
$ref: '#/definitions/phone'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/phones/{phone_id}/:
get:
summary: Get phone for organization
description: Returns a phone entry for a specific organization
operationId: getOrganizationPhone
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update phone for organization
description: Updates a phone entry for a specific organization
operationId: updateOrganizationPhone
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
- in: body
name: body
schema:
$ref: '#/definitions/phone'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
delete:
summary: Delete phone for organization
description: Deletes a phone entry for an organization
operationId: deleteOrganizationPhone
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: phone_id
description: 'The unique phone id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Phone Response
schema:
type: array
items:
$ref: "#/definitions/phone"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/programs/:
get:
summary: Get all programs for organization
description: Returns a full list of programs for a specific organization
operationId: listOrganizationPrograms
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
responses:
'200':
description: Program Response
schema:
type: array
items:
$ref: "#/definitions/program"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add program for organization
description: Creates a new program entry for a specific organization
operationId: addOrganizationProgram
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: body
name: body
schema:
$ref: '#/definitions/program'
security:
- appid: []
- appkey: []
responses:
'200':
description: Program Response
schema:
type: array
items:
$ref: "#/definitions/program"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/programs/{program_id}/:
get:
summary: Get program for organization
description: Returns a program entry for a specific organization
operationId: getOrganizationProgram
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
responses:
'200':
description: Program Response
schema:
type: array
items:
$ref: "#/definitions/program"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update program for organization
description: Updates a program entry for a specific organization
operationId: updateOrganizationProgram
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
- in: body
name: body
schema:
$ref: '#/definitions/program'
security:
- appid: []
- appkey: []
responses:
'200':
description: Program Response
schema:
type: array
items:
$ref: "#/definitions/program"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
delete:
summary: Delete program for organization
description: Deletes a program entry for a specific organization
operationId: deleteOrganizationProgram
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Program Response
schema:
type: array
items:
$ref: "#/definitions/program"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/programs/{program_id}/services/:
get:
summary: Get all services for a specific program within an organization
description: Returns a full list of services for a specific program in a specific organization
operationId: listProgramServices
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add service for a program within an organization
description: Creates a new service entry for a specific program within an organization
operationId: addProgramService
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
- in: body
name: body
schema:
$ref: '#/definitions/service'
security:
- appid: []
- appkey: []
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/programs/{program_id}/services/{service_id}/:
get:
summary: Get service from a specific program within an organization
description: Returns a service entry from a specific program within an organization
operationId: getProgramService
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
- in: path
required: true
type: string
name: service_id
description: 'The unique service id.'
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
put:
summary: Update service for a specific program within an organization
description: Updates a service from a specific program within an organization
operationId: updateProgramService
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
- in: path
required: true
type: string
name: service_id
description: 'The unique service id.'
- in: body
name: body
schema:
$ref: '#/definitions/service'
security:
- appid: []
- appkey: []
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
delete:
summary: Delete service for a specific program within an organization
description: Deletes a service from a specific program within an organization
operationId: deleteProgramService
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: path
required: true
type: string
name: program_id
description: 'The unique program id.'
- in: path
required: true
type: string
name: service_id
description: 'The unique service id.'
security:
- appid: []
- appkey: []
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
/organizations/{organization_id}/services/:
get:
summary: Get all services for organization
description: Returns a full list of services for a specific organization
operationId: listOrganizationServices
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
tags:
- Organizations
post:
summary: Add service for organization
description: Creates a new service entry for an organization
operationId: addOrganizationService
parameters:
- in: path
required: true
type: string
name: organization_id
description: 'The unique organization id.'
- in: body
name: body
schema:
$ref: '#/definitions/service'
security:
- appid: []
- appkey: []
responses:
'200':
description: Service Response
schema:
type: array
items:
$ref: "#/definitions/service"
'403':
description: No Access Response
schema:
type: array
items:
$ref: "#/definitions/error_response"
'500':
description: Error Response
schema:
type: array
items:
$ref: "#/definitions/error_response"