Operators
Endpoints to work with the operators of a partner.
Get operators
GET /api/internal/v1/partners/:partner_id/operators
Get the operators of a partner.
An authenticated user with permission operators.read and partner access is required.
Path Parameters
partner_id
integer
The id of the partner.
Query Parameters
page
integer
The page to display.
per_page
integer
How many operators to return per page.
search
string
Filter operators by their name or email address.
Get all operators simplified
GET /api/internal/v1/partners/:partner_id/operators/simplified
Path Parameters
partner_id
integer
The ID of the partner.
Get operator
GET /api/internal/v1/partners/:partner_id/operators/:operator_id
Get operator by id.
An authenticated user with permission operators.read and partner access is required.
Path Parameters
operator_id
integer
The id of the operator that should be retrieved.
partner_id
integer
The id of the partner.
Create operator
POST /api/internal/v1/partners/:partner_id/operators
Create a new operator.
An authenticated user with permission operators.created and partner access is required.
Path Parameters
partner_id
integer
The id of the partner.
Update operator
PUT /api/internal/v1/partners/:partner_id/operators/:operator_id
Update the given operator.
An authenticated user with permission operators.update and partner access is required.
Path Parameters
operator_id
integer
The id of the operator that should be updated.
partner_id
integer
The id of the partner.
Request Body
name
string
The name of the operator.
string
The email address of the operator.
website
string
The operator website address.
fiscal_details.uid
string
Operator UID.
fiscal_details.fn
string
Operator FN.
fiscal_details.zvr
string
Operator ZVR.
fiscal_details.dvr
string
Operator DVR.
phone_number.prefix
number
The prefix of the phone number. Required if the phone_number.number is present.
phone_number.number
number
The number of the phone number. Required if the phone_number.prefix is present.
fax_number.prefix
number
The prefix of the fax number. Required if fax_number.number if present.
fax_number.number
number
The number of the fax number. Required if fax_number.prefix is present.
contact_person.first_name
string
The first name of the contact person. Required if any of the following are present: contact_person.last_name, contact_person.email.
contact_person.last_name
string
The last name of the contact person. Required if any of the following are present: contact_person.first_name, contact_person.email.
contact_person.email
string
The email address of the contact person. Required if any of the following are present: contact_person.first_name, contact_person.last_name.
contact_person.gender
number
The gender of the contact person. Allowed values: 0, 1, and 2. For more info: https://en.wikipedia.org/wiki/ISO/IEC_5218
contact_person.phone_number.prefix
number
The prefix of the contact person's phone number. Required if contact_person.phone_number.number is present.
contact_person.phone_number.number
number
The number of the contact person's phone number. Required if contact_person.phone_number.prefix is present.
address.country_id
integer
The id of the address country. Required if any of the following are present: address.state_id, address.post_code, address.street_name, address.street_number, address.additional_information
address.state_id
integer
The id of the address state. Required if any of the following are present: address.country_id, address.post_code, address.street_name, address.street_number, address.additional_information
address.city
string
The city of the address. Required if any of the following are present: address.country_id, address.state_id, address.post_code, address.street_name, address.street_number, address.additional_information
address.post_code
string
The post code of the address. Required if any of the following are present: address.country_id, address.state_id, address.city, address.street_name, address.street_number, address.additional_information
address.street_name
string
The street name of the address. Required if any of the following are present: address.country_id, address.street_number, address.post_code, address.city, address.state_id, address.country_id
address.street_number
string
The street number of the address.
address.additional_information
string
String with additional information about the address location.
PUT /api/internal/v1/partners/:partner_id/operators/:operator_id
Request Body
address.street_name
string
address.country_id, address.street_number, address.post_code, address.city, address.state_id, address.country_id
Delete operator
DELETE /api/internal/v1/partners/:partner_id/operators/:operator_id
Delete the given operator.
Path Parameters
partner_id
integer
The ID of the partner.
operator_id
integer
The ID of the operator being deleted.
Last updated
Was this helpful?