Facilities
Endpoints to work with the facilities of a partner.
Get a simplified version of all facilities
GET /api/internal/v1/partners/:partner_id/facilities/simplified
Get the facilities of an operator.
The action must be performed by an authenticated user with permission facilities.read and partner access.
Path Parameters
partner_id
integer
The id of the partner.
Get facility
GET /api/internal/v1/partners/:partner_id/facilities/:facility_id
Get a facility by its id.
The action must be performed by an authenticated user with permission facilities.read and partner access.
Path Parameters
facility_id
integer
The id of the facility.
partner_id
integer
The id of the partner.
Update facility
PUT /api/internal/v1/partners/:partner_id/facilities/:facility_id
Update a facility by its id.
Path Parameters
facility_id
integer
The id of the facility.
partner_id
integer
The id of the partner.
Request Body
opening_times
string
Array with all the opening times. See the screenshot below to better understand the format.
opening_times.*
string
Array with the opening times of a day. For the moment it will have a single entry. In the future, we will have support for multiple entries per day.
opening_times.*.day
string
The day targeted by the opening time. Allowed values are from 1 (Monday) to 7 (Sunday).
opening_times.*.times.*.open_time
string
The open time. The allowed format is H:i
opening_times.*.times.*.close_time
string
The close time. The allowed format is H:i
name
string
The name of the facility.
short_name
string
The short name of the facility.
address.country_id
integer
The ID of the address country.
address.state_id
integer
The ID of the address state.
address.city
string
The address city.
address.post_code
string
The address post code.
address.street_name
string
The address street name.
address.street_number
string
The address street number.
address.additional_information
string
Additional information about the address.
contact_person.title
string
The title of the contact person.
contact_person.first_name
string
The first name of the contact person.
contact_person.last_name
string
The last name of the contact person.
contact_person.gender
integer
The gender of the contact person. Allowed values: 0, 1 and 2.
contact_person.email
string
The email address of the contact person.
contact_person.phone_number.prefix
string
The phone number prefix of the contact person.
contact_person.phone_number.number
string
The phone number of the contact person.
contact_person.fax_number.prefix
string
The fax number prefix of the contact person.
contact_person.fax_number.number
string
The fax number of the contact person.
service_ids
array
The IDs of the services available for this facility.
For the moment, the times array should have a single entry. In the future, we will add support for multiple entries per day.
Last updated
Was this helpful?
