/v1/staff/view
Testing
GET
https://uat-api.wellnessliving.io/v1/staff/view
Request
id_region
(integer): The ID of the region for which the staff information is being retrieved.k_business
(integer): The ID of the business for which the staff information is being retrieved.k_staff
(integer): The ID of the staff for which the information is being retrieved.Response
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"a_class_day": {
"type": "array",
"description": "An empty array that might be used to store class schedule details in the future."
},
"a_result_list": {
"type": "object",
"description": "A dictionary mapping staff IDs to their respective class-related data.",
"additionalProperties": {
"type": "object",
"properties": {
"a_class_day": {
"type": "array",
"description": "An empty array, likely reserved for future class day information."
},
"a_staff": {
"type": "object",
"description": "Contains staff details related to their work locations, photos, and schedule.",
"properties": {
"a_location_work": {
"type": "array",
"description": "List of location IDs where the staff member works.",
"items": {
"type": "integer"
}
},
"a_photo": {
"type": "object",
"description": "Photo-related details for the staff member.",
"additionalProperties": {
"type": "object",
"properties": {
"id_gender": {
"type": "integer",
"description": "Gender ID of the staff member."
},
"k_staff": {
"type": "string",
"description": "Unique identifier for the staff member."
},
"text_name": {
"type": "string",
"description": "Name of the staff member."
},
"uid": {
"type": "string",
"description": "Unique user identifier."
},
"s_link_business": {
"type": "string",
"description": "Business-specific image link."
},
"s_link_wide": {
"type": "string",
"description": "Wide version of the image link."
},
"i_height": {
"type": "integer",
"description": "Image height in pixels."
},
"i_width": {
"type": "integer",
"description": "Image width in pixels."
},
"is_empty": {
"type": "boolean",
"description": "Indicates if the image is empty or not."
},
"s_url": {
"type": "string",
"description": "URL of the staff member's image."
}
},
"required": ["id_gender", "k_staff", "text_name", "uid", "s_url"]
}
},
"html_biography": {
"type": "string",
"description": "HTML-formatted biography of the staff member."
},
"html_first": {
"type": "string",
"description": "First name of the staff member in HTML format."
},
"html_last": {
"type": "string",
"description": "Last name of the staff member in HTML format."
},
"html_location_title": {
"type": "string",
"description": "HTML-formatted location title."
},
"id_gender": {
"type": "integer",
"description": "Gender ID of the staff member."
},
"is_classes_events": {
"type": "boolean",
"description": "Indicates if the staff member is associated with classes and events."
},
"is_publish_business_page": {
"type": "boolean",
"description": "Indicates if the staff member's profile is published on the business page."
},
"is_schedule_enabled": {
"type": "boolean",
"description": "Indicates if scheduling is enabled for this staff member."
},
"k_location": {
"type": ["string", "null"],
"description": "Unique identifier for the staff member's location."
},
"k_staff": {
"type": "string",
"description": "Unique identifier for the staff member."
},
"s_biography": {
"type": "string",
"description": "Staff member's biography in HTML format."
},
"s_family": {
"type": "string",
"description": "Staff member's family name or last name."
},
"s_name": {
"type": "string",
"description": "First name of the staff member."
},
"s_position": {
"type": "string",
"description": "Staff member's position or job title."
},
"text_business_role": {
"type": "string",
"description": "Business role of the staff member."
},
"text_full_name": {
"type": "string",
"description": "Full name of the staff member."
},
"uid": {
"type": "string",
"description": "Unique user identifier for the staff member."
},
"url_schedule": {
"type": "string",
"description": "URL to the staff member's schedule."
}
},
"required": ["k_staff", "s_name", "text_full_name", "uid"]
}
}
}
},
"a_staff": {
"type": "object",
"description": "Contains staff member details outside the class context.",
"properties": {
"a_location_work": {
"type": "array",
"description": "List of location IDs where the staff member works.",
"items": {
"type": "integer"
}
},
"a_photo": {
"type": "object",
"description": "Photo-related details for the staff member.",
"additionalProperties": {
"type": "object",
"properties": {
"id_gender": {
"type": "integer",
"description": "Gender ID of the staff member."
},
"k_staff": {
"type": "string",
"description": "Unique identifier for the staff member."
},
"text_name": {
"type": "string",
"description": "Name of the staff member."
},
"uid": {
"type": "string",
"description": "Unique user identifier."
},
"s_link_business": {
"type": "string",
"description": "Business-specific image link."
},
"s_link_wide": {
"type": "string",
"description": "Wide version of the image link."
},
"i_height": {
"type": "integer",
"description": "Image height in pixels."
},
"i_width": {
"type": "integer",
"description": "Image width in pixels."
},
"is_empty": {
"type": "boolean",
"description": "Indicates if the image is empty or not."
},
"s_url": {
"type": "string",
"description": "URL of the staff member's image."
}
},
"required": ["id_gender", "k_staff", "text_name", "uid", "s_url"]
}
},
"html_biography": {
"type": "string",
"description": "HTML-formatted biography of the staff member."
},
"html_first": {
"type": "string",
"description": "First name of the staff member in HTML format."
},
"html_last": {
"type": "string",
"description": "Last name of the staff member in HTML format."
},
"html_location_title": {
"type": "string",
"description": "HTML-formatted location title."
},
"id_gender": {
"type": "integer",
"description": "Gender ID of the staff member."
},
"is_classes_events": {
"type": "boolean",
"description": "Indicates if the staff member is associated with classes and events."
},
"is_publish_business_page": {
"type": "boolean",
"description": "Indicates if the staff member's profile is published on the business page."
},
"is_schedule_enabled": {
"type": "boolean",
"description": "Indicates if scheduling is enabled for this staff member."
},
"k_location": {
"type": ["string", "null"],
"description": "Unique identifier for the staff member's location."
},
"k_staff": {
"type": "string",
"description": "Unique identifier for the staff member."
},
"s_biography": {
"type": "string",
"description": "Staff member's biography in HTML format."
},
"s_family": {
"type": "string",
"description": "Staff member's family name or last name."
},
"s_name": {
"type": "string",
"description": "First name of the staff member."
},
"s_position": {
"type": "string",
"description": "Staff member's position or job title."
},
"text_business_role": {
"type": "string",
"description": "Business role of the staff member."
},
"text_full_name": {
"type": "string",
"description": "Full name of the staff member."
},
"uid": {
"type": "string",
"description": "Unique user identifier for the staff member."
},
"url_schedule": {
"type": "string",
"description": "URL to the staff member's schedule."
}
},
"required": ["k_staff", "s_name", "text_full_name", "uid"]
},
"status": {
"type": "string",
"enum": ["ok"],
"description": "Status of the response."
},
"s_version": {
"type": "string",
"description": "Version identifier for the response format."
}
},
"required": ["status", "s_version"]
}
Request
Query Params
id_region
stringÂ
required
Example:
2
k_business
stringÂ
required
Example:
49197
k_staff
stringÂ
required
Example:
479469