{ "name": "Mediterranean Co-Production Lab", "description": "Mediterranean Co-Production Lab", "url": "https:\/\/medsocialinnovationlab.org", "home": "https:\/\/medsocialinnovationlab.org\/en_gb", "gmt_offset": 2, "timezone_string": "Europe\/Madrid", "page_for_posts": 0, "page_on_front": 43327, "show_on_front": "page", "namespaces": [ "ithemes-security\/rpc", "ithemes-security\/v1", "wp\/v2", "oembed\/1.0", "code-snippets\/v1", "contact-form-7\/v1", "essential-blocks\/v1", "litespeed\/v1", "litespeed\/v3", "post-smtp\/v1", "post-smtp\/v2", "psd\/v1", "wc\/v3", "wc\/v1", "wc\/pos\/v1\/catalog", "wordfence\/v1", "yoast\/v1", "ldlms\/v1", "ldlms\/v2", "tribe\/tickets\/v1", "tribe\/event-aggregator\/v1", "tribe\/events\/v1", "tribe\/views\/v2", "jetpack\/v4", "elementor\/v1", "wc-admin", "wc-analytics", "wc\/store", "wc\/store\/v1", "wc\/private", "wc\/v2", "redux\/descriptors\/v1", "google-site-kit\/v1", "jet-engine\/v2", "elementor\/v1\/documents", "elementor-ai\/v1", "elementor-pro\/v1", "woocommerce-email-editor\/v1", "wc-admin-email", "wc-telemetry", "wccom-site\/v3", "mailpoet\/v1", "wp-abilities\/v1", "buddyboss\/v1", "wp-site-health\/v1", "wp-block-editor\/v1" ], "authentication": [], "routes": { "\/": { "namespace": "", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/" } ] } }, "\/batch\/v1": { "namespace": "", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "validation": { "type": "string", "enum": [ "require-all-validate", "normal" ], "default": "normal", "required": false }, "requests": { "type": "array", "maxItems": 25, "items": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH", "DELETE" ], "default": "POST" }, "path": { "type": "string", "required": true }, "body": { "type": "object", "properties": [], "additionalProperties": true }, "headers": { "type": "object", "properties": [], "additionalProperties": { "type": [ "string", "array" ], "items": { "type": "string" } } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/batch\/v1" } ] } }, "\/ithemes-security\/rpc": { "namespace": "ithemes-security\/rpc", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "ithemes-security\/rpc", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc" } ] } }, "\/ithemes-security\/rpc\/ban-users\/add-many": { "namespace": "ithemes-security\/rpc", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "bans": { "title": "IPs to Ban", "description": "Enter one IP address per-line. Optionally, include a note by ending the line with a # sign.", "type": "array", "items": { "type": "string", "default": "" }, "minItems": 1, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/ban-users\/add-many" } ] } }, "\/ithemes-security\/rpc\/file-change\/file-tree": { "namespace": "ithemes-security\/rpc", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "directory": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/file-change\/file-tree" } ] } }, "\/ithemes-security\/rpc\/global\/detect-ip": { "namespace": "ithemes-security\/rpc", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "proxy": { "type": "string", "enum": [ "automatic", "security-check", "manual", "disabled" ], "required": true }, "args": { "type": "object", "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/global\/detect-ip" } ] } }, "\/ithemes-security\/rpc\/notification-center\/notifications": { "namespace": "ithemes-security\/rpc", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/notification-center\/notifications" } ] } }, "\/ithemes-security\/rpc\/notification-center\/available-users-roles": { "namespace": "ithemes-security\/rpc", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/notification-center\/available-users-roles" } ] } }, "\/ithemes-security\/rpc\/file-writing\/get-config-rules": { "namespace": "ithemes-security\/rpc", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/file-writing\/get-config-rules" } ] } }, "\/ithemes-security\/v1": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "ithemes-security\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1" } ] } }, "\/ithemes-security\/v1\/bans": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "actor_type": { "title": "Actor Type", "description": "The type of actor that created the ban.", "type": "string", "enum": [ "user", "lockout_module" ], "required": false }, "actor_id": { "title": "Actor Identifier", "description": "The particular actor that caused the ban.", "type": "string", "required": false }, "created_after": { "title": "Banned After", "description": "Limit to bans added after the given date.", "type": "string", "format": "date-time", "required": false }, "created_before": { "title": "Banned Before", "description": "Limit to bans added before the given date.", "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/bans" } ] } }, "\/ithemes-security\/v1\/bans\/(?Pdatabase)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "actor_type": { "title": "Actor Type", "description": "The type of actor that created the ban.", "type": "string", "enum": [ "user", "lockout_module" ], "required": false }, "actor_id": { "title": "Actor Identifier", "description": "The particular actor that caused the ban.", "type": "string", "required": false }, "created_after": { "title": "Banned After", "description": "Limit to bans added after the given date.", "type": "string", "format": "date-time", "required": false }, "created_before": { "title": "Banned Before", "description": "Limit to bans added before the given date.", "type": "string", "format": "date-time", "required": false } } }, { "methods": [ "POST" ], "args": { "host": { "title": "IP", "description": "The IP address to ban.", "type": "string", "required": false }, "created_by": { "title": "Created By", "description": "The actor who added the ban.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "lockout_module" ], "description": "The type of the actor." }, "id": { "type": "string", "description": "The identifier for the actor." } }, "required": true }, "comment": { "title": "Notes", "description": "A comment describing the ban.", "type": "string", "maxLength": 255, "required": false } } } ] }, "\/ithemes-security\/v1\/bans\/(?Pdatabase)\/(?P\\d+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "required": false } } }, { "methods": [ "PUT" ], "args": { "id": { "type": "integer", "required": false }, "comment": { "title": "Notes", "description": "A comment describing the ban.", "type": "string", "maxLength": 255, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "required": false } } } ] }, "\/ithemes-security\/v1\/modules": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "status": { "type": "string", "enum": [ "active", "inactive" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/modules" } ] } }, "\/ithemes-security\/v1\/modules\/(?P[\\w-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "PUT" ], "allow_batch": { "v1": true }, "args": { "status": { "title": "Module Status", "type": "object", "properties": { "selected": { "type": "string", "enum": [ "active", "inactive" ], "context": [ "view", "edit", "embed" ] }, "default": { "type": "string", "enum": [ "always-active", "default-active", "default-inactive" ], "context": [ "edit" ], "readonly": true } }, "required": false }, "tools": { "title": "Module Tools", "type": "object", "additionalProperties": { "type": "object" }, "required": false } } } ] }, "\/ithemes-security\/v1\/settings": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "modules": { "oneOf": [ { "type": "string", "enum": [ ":all", ":active" ] }, { "type": "array", "items": { "type": "string" } } ], "default": ":all", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/settings" } ] } }, "\/ithemes-security\/v1\/settings\/(?P[\\w-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "PUT" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "PATCH" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": [] } ] }, "\/ithemes-security\/v1\/site-types": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/site-types" } ] } }, "\/ithemes-security\/v1\/site-types\/(?P[\\w-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "PUT" ], "args": { "answers": { "description": "The list of answers.", "type": "array", "items": { "type": "object", "properties": { "question": { "description": "The question id.", "type": "string" }, "answer": { "description": "The user provided answer.", "type": [ "array", "object", "boolean", "number", "integer", "string" ] }, "modules": { "type": "array", "readonly": true, "items": { "type": "string" } }, "disabled": { "type": "array", "readonly": true, "items": { "type": "string" } }, "settings": { "type": "object", "readonly": true }, "user_groups": { "type": "array", "readonly": true, "items": { "type": "object" } }, "user_groups_settings": { "type": "object", "readonly": true, "additionalProperties": { "type": "object" } }, "canonical_group_substitutions": { "type": "object", "readonly": true, "additionalProperties": { "type": "string" } } } }, "required": false } } } ] }, "\/ithemes-security\/v1\/tools": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/tools" } ] } }, "\/ithemes-security\/v1\/tools\/(?P[\\w\\-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "PUT" ], "args": { "enabled": { "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": [] } ] }, "\/ithemes-security\/v1\/user-actions": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "users": { "type": "array", "items": { "type": "integer" }, "required": false }, "query": { "type": "object", "properties": [], "required": false }, "actions": { "type": "object", "properties": { "force-logout": { "type": "boolean", "enum": [ true ] }, "reset-password": { "type": "boolean", "enum": [ true ] }, "add-user-groups": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "minProperties": 1, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/user-actions" } ] } }, "\/ithemes-security\/v1\/logs": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "before": { "type": "string", "format": "date-time", "required": false }, "after": { "type": "string", "format": "date-time", "required": false }, "module": { "type": "array", "items": { "type": "string" }, "required": false }, "code": { "type": "array", "items": { "type": "string" }, "required": false }, "type": { "type": "array", "items": { "type": "string", "oneOf": [ { "enum": [ "critical-issue" ], "title": "Critical Issue" }, { "enum": [ "action" ], "title": "Action" }, { "enum": [ "fatal" ], "title": "Fatal Error" }, { "enum": [ "error" ], "title": "Error" }, { "enum": [ "warning" ], "title": "Warning" }, { "enum": [ "notice" ], "title": "Notice" }, { "enum": [ "debug" ], "title": "Debug" }, { "enum": [ "process-start" ], "title": "Process" }, { "enum": [ "process-update" ], "title": "Process Update" }, { "enum": [ "process-stop" ], "title": "Process Stop" } ] }, "required": false }, "user": { "type": "array", "items": { "type": "integer" }, "required": false }, "ip": { "type": "array", "items": { "type": "string", "format": "ip" }, "required": false }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "required": false }, "orderby": { "type": "string", "enum": [ "created_at", "id", "module", "code", "type", "request_started_at", "user", "site" ], "default": "created_at", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/logs" } ] } }, "\/ithemes-security\/v1\/logs\/(?P[\\d]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ] }, "\/ithemes-security\/v1\/geolocate\/(?P.+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "ip": { "type": "string", "format": "ip", "required": false } } } ] }, "\/ithemes-security\/rpc\/lockout-stats\/top-blocked-ips": { "namespace": "ithemes-security\/rpc", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "period": { "default": "30-days", "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time", "required": true }, "end": { "type": "string", "format": "date-time", "required": true } } }, { "type": "string", "enum": [ "24-hours", "week", "30-days" ] } ], "required": false }, "number": { "type": "integer", "minimum": 0, "maximum": 10, "default": 5, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/lockout-stats\/top-blocked-ips" } ] } }, "\/ithemes-security\/v1\/lockouts": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/lockouts" } ] } }, "\/ithemes-security\/v1\/lockouts\/(?P[\\d]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "required": false } } } ] }, "\/ithemes-security\/v1\/lockouts\/(?P[\\d]+)\/release-lockout": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "type": "integer", "required": false } } } ] }, "\/ithemes-security\/v1\/lockouts\/(?P[\\d]+)\/ban-lockout": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "type": "integer", "required": false } } } ] }, "\/ithemes-security\/rpc\/discover": { "namespace": "ithemes-security\/rpc", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "url": { "type": "string", "format": "uri", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/rpc\/discover" } ] } }, "\/wp\/v2": { "namespace": "wp\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wp\/v2", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2" } ] } }, "\/wp\/v2\/gamipress-user-earnings": { "namespace": "wp\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "user_earning_id", "enum": [ "user_earning_id", "title", "user_id", "post_id", "post_type", "points", "points_type", "date", "include", "relevance" ], "required": false }, "user_id": { "description": "Limit result set to earnings assigned to specific users.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "post_id": { "description": "Limit result set to earnings assigned to specific posts.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "post_type": { "description": "Limit result set to earnings assigned to specific post types.", "type": "array", "items": { "type": "string" }, "default": [], "required": false }, "points_type": { "description": "Limit result set to earnings assigned to specific points types.", "type": "array", "items": { "type": "string" }, "default": [], "required": false }, "force_types": { "description": "Setting it to true will force to limit results of the same post_type and points_type.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "after": { "description": "Limit response to user earnings after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to user earnings before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false } } }, { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": [], "required": false }, "title": { "description": "The title for the object.", "type": "string", "required": false }, "user_id": { "description": "The ID for the user of the object.", "type": "integer", "required": false }, "post_id": { "description": "The ID for the post of the object.", "type": "integer", "required": false }, "post_type": { "description": "The type for the post of the object.", "type": "string", "required": false }, "points": { "description": "The points amount of the object.", "type": "integer", "required": false }, "points_type": { "description": "The type for the points amount of the object.", "type": "string", "required": false }, "date": { "description": "The date the object was created, in the site's timezone.", "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/gamipress-user-earnings" } ] } }, "\/wp\/v2\/gamipress-user-earnings\/(?P[\\d]+)": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": [], "required": false }, "title": { "description": "The title for the object.", "type": "string", "required": false }, "user_id": { "description": "The ID for the user of the object.", "type": "integer", "required": false }, "post_id": { "description": "The ID for the post of the object.", "type": "integer", "required": false }, "post_type": { "description": "The type for the post of the object.", "type": "string", "required": false }, "points": { "description": "The points amount of the object.", "type": "integer", "required": false }, "points_type": { "description": "The type for the points amount of the object.", "type": "string", "required": false }, "date": { "description": "The date the object was created, in the site's timezone.", "type": "string", "format": "date-time", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false } } } ] }, "\/wp\/v2\/gamipress-logs": { "namespace": "wp\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "log_id", "enum": [ "log_id", "title", "type", "trigger_type", "access", "user_id", "date", "include", "relevance" ], "required": false }, "type": { "description": "Limit result set to logs with a specific type.", "type": "string", "default": "", "enum": [ "", "event_trigger", "achievement_earn", "achievement_award", "points_earn", "points_deduct", "points_expend", "points_award", "points_revoke", "rank_earn", "rank_award", "points_exchange", "gateway_error" ], "required": false }, "trigger_type": { "description": "Limit result set to logs with a specific trigger.", "type": "array", "items": { "type": "string" }, "default": [], "required": false }, "access": { "description": "Limit result set to logs with a specific access.", "type": "string", "default": "", "enum": [ "", "public", "private" ], "required": false }, "user_id": { "description": "Limit result set to logs assigned to specific users.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "after": { "description": "Limit response to logs after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to logs before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false } } }, { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": [], "required": false }, "title": { "description": "The title for the object.", "type": "string", "required": false }, "type": { "description": "Type of log for the object.", "type": "string", "required": false }, "trigger_type": { "description": "Trigger of log for the object.", "type": "string", "required": false }, "access": { "description": "Access of log for the object.", "type": "string", "required": false }, "user_id": { "description": "The ID for the user of the object.", "type": "integer", "required": false }, "date": { "description": "The date the object was created, in the site's timezone.", "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/gamipress-logs" } ] } }, "\/wp\/v2\/gamipress-logs\/(?P[\\d]+)": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": [], "required": false }, "title": { "description": "The title for the object.", "type": "string", "required": false }, "type": { "description": "Type of log for the object.", "type": "string", "required": false }, "trigger_type": { "description": "Trigger of log for the object.", "type": "string", "required": false }, "access": { "description": "Access of log for the object.", "type": "string", "required": false }, "user_id": { "description": "The ID for the user of the object.", "type": "integer", "required": false }, "date": { "description": "The date the object was created, in the site's timezone.", "type": "string", "format": "date-time", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false } } } ] }, "\/oembed\/1.0": { "namespace": "oembed\/1.0", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "oembed\/1.0", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/oembed\/1.0" } ] } }, "\/oembed\/1.0\/embed": { "namespace": "oembed\/1.0", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "url": { "description": "The URL of the resource for which to fetch oEmbed data.", "type": "string", "format": "uri", "required": true }, "format": { "default": "json", "required": false }, "maxwidth": { "default": 600, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/oembed\/1.0\/embed" } ] } }, "\/oembed\/1.0\/proxy": { "namespace": "oembed\/1.0", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "url": { "description": "The URL of the resource for which to fetch oEmbed data.", "type": "string", "format": "uri", "required": true }, "format": { "description": "The oEmbed format to use.", "type": "string", "default": "json", "enum": [ "json", "xml" ], "required": false }, "maxwidth": { "description": "The maximum width of the embed frame in pixels.", "type": "integer", "default": 600, "required": false }, "maxheight": { "description": "The maximum height of the embed frame in pixels.", "type": "integer", "required": false }, "discover": { "description": "Whether to perform an oEmbed discovery request for unsanctioned providers.", "type": "boolean", "default": true, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/oembed\/1.0\/proxy" } ] } }, "\/code-snippets\/v1": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "code-snippets\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1" } ] } }, "\/code-snippets\/v1\/snippets": { "namespace": "code-snippets\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Descriptive title for the snippet.", "type": "string", "required": false }, "desc": { "description": "Descriptive text associated with snippet.", "type": "string", "required": false }, "code": { "description": "Executable snippet code.", "type": "string", "required": false }, "tags": { "description": "List of tag categories the snippet belongs to.", "type": "array", "items": { "type": "string" }, "required": false }, "scope": { "description": "Context in which the snippet is executable.", "type": "string", "required": false }, "condition_id": { "description": "Identifier of condition linked to this snippet.", "type": "integer", "required": false }, "active": { "description": "Snippet activation status.", "type": "boolean", "required": false }, "priority": { "description": "Relative priority in which the snippet is executed.", "type": "integer", "required": false }, "network": { "description": "Whether the snippet is network-wide instead of site-wide.", "type": [ "boolean", "null" ], "required": false }, "shared_network": { "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide.", "type": [ "boolean", "null" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/snippets" } ] } }, "\/code-snippets\/v1\/snippets\/(?P[\\d]+)": { "namespace": "code-snippets\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Descriptive title for the snippet.", "type": "string", "required": false }, "desc": { "description": "Descriptive text associated with snippet.", "type": "string", "required": false }, "code": { "description": "Executable snippet code.", "type": "string", "required": false }, "tags": { "description": "List of tag categories the snippet belongs to.", "type": "array", "items": { "type": "string" }, "required": false }, "scope": { "description": "Context in which the snippet is executable.", "type": "string", "required": false }, "condition_id": { "description": "Identifier of condition linked to this snippet.", "type": "integer", "required": false }, "active": { "description": "Snippet activation status.", "type": "boolean", "required": false }, "priority": { "description": "Relative priority in which the snippet is executed.", "type": "integer", "required": false }, "network": { "description": "Whether the snippet is network-wide instead of site-wide.", "type": [ "boolean", "null" ], "required": false }, "shared_network": { "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide.", "type": [ "boolean", "null" ], "required": false } } }, { "methods": [ "DELETE" ], "args": [] } ] }, "\/code-snippets\/v1\/snippets\/schema": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/snippets\/schema" } ] } }, "\/code-snippets\/v1\/snippets\/(?P[\\d]+)\/activate": { "namespace": "code-snippets\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/code-snippets\/v1\/snippets\/(?P[\\d]+)\/deactivate": { "namespace": "code-snippets\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/code-snippets\/v1\/snippets\/(?P[\\d]+)\/export": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/code-snippets\/v1\/snippets\/(?P[\\d]+)\/export-code": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/code-snippets\/v1\/insert-headers-and-footers": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/insert-headers-and-footers" } ] } }, "\/code-snippets\/v1\/insert-headers-and-footers\/import": { "namespace": "code-snippets\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "ids": { "type": "array", "required": false }, "network": { "type": "boolean", "required": false }, "auto_add_tags": { "type": "boolean", "required": false }, "tag_value": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/insert-headers-and-footers\/import" } ] } }, "\/code-snippets\/v1\/header-footer-code-manager": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/header-footer-code-manager" } ] } }, "\/code-snippets\/v1\/header-footer-code-manager\/import": { "namespace": "code-snippets\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "ids": { "type": "array", "required": false }, "network": { "type": "boolean", "required": false }, "auto_add_tags": { "type": "boolean", "required": false }, "tag_value": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/header-footer-code-manager\/import" } ] } }, "\/code-snippets\/v1\/insert-php-code-snippet": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/insert-php-code-snippet" } ] } }, "\/code-snippets\/v1\/insert-php-code-snippet\/import": { "namespace": "code-snippets\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "ids": { "type": "array", "required": false }, "network": { "type": "boolean", "required": false }, "auto_add_tags": { "type": "boolean", "required": false }, "tag_value": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/insert-php-code-snippet\/import" } ] } }, "\/code-snippets\/v1\/importers": { "namespace": "code-snippets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/importers" } ] } }, "\/code-snippets\/v1\/file-upload\/parse": { "namespace": "code-snippets\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/file-upload\/parse" } ] } }, "\/code-snippets\/v1\/file-upload\/import": { "namespace": "code-snippets\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "snippets": { "description": "Array of snippet data to import", "type": "array", "required": true }, "duplicate_action": { "description": "Action to take when duplicate snippets are found", "type": "string", "enum": [ "ignore", "replace", "skip" ], "default": "ignore", "required": false }, "network": { "description": "Whether to import to network table", "type": "boolean", "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/code-snippets\/v1\/file-upload\/import" } ] } }, "\/contact-form-7\/v1": { "namespace": "contact-form-7\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "contact-form-7\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/contact-form-7\/v1" } ] } }, "\/contact-form-7\/v1\/contact-forms": { "namespace": "contact-form-7\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/contact-form-7\/v1\/contact-forms" } ] } }, "\/contact-form-7\/v1\/contact-forms\/(?P\\d+)": { "namespace": "contact-form-7\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] }, { "methods": [ "DELETE" ], "args": [] } ] }, "\/contact-form-7\/v1\/contact-forms\/(?P\\d+)\/feedback": { "namespace": "contact-form-7\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/contact-form-7\/v1\/contact-forms\/(?P\\d+)\/feedback\/schema": { "namespace": "contact-form-7\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/contact-form-7\/v1\/contact-forms\/(?P\\d+)\/refill": { "namespace": "contact-form-7\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/essential-blocks\/v1": { "namespace": "essential-blocks\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "essential-blocks\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/essential-blocks\/v1" } ] } }, "\/essential-blocks\/v1\/products": { "namespace": "essential-blocks\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_by": { "required": false }, "order": { "required": false }, "per_page": { "required": false }, "offset": { "required": false }, "categories": { "required": false }, "tags": { "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/essential-blocks\/v1\/products" } ] } }, "\/essential-blocks\/v1\/queries": { "namespace": "essential-blocks\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/essential-blocks\/v1\/queries" } ] } }, "\/essential-blocks\/v1\/roles": { "namespace": "essential-blocks\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/essential-blocks\/v1\/roles" } ] } }, "\/wp\/v2\/gamipress-posts": { "namespace": "wp\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "default": [], "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific ids.", "type": "array", "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "default": [], "required": false }, "menu_order": { "description": "Limit result set to resources with a specific menu_order value.", "type": "integer", "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent ids.", "type": "array", "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent id.", "type": "array", "default": [], "required": false }, "slug": { "description": "Limit result set to posts with a specific slug.", "type": "string", "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned a specific status.", "type": "string", "required": false }, "filter": { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorization.", "required": false }, "categories": { "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", "type": "array", "default": [], "required": false }, "tags": { "description": "Limit result set to all items that have the specified term assigned in the tags taxonomy.", "type": "array", "default": [], "required": false }, "menus": { "description": "Limit result set to all items that have the specified term assigned in the menus taxonomy.", "type": "array", "default": [], "required": false }, "wp_pattern_category": { "description": "Limit result set to all items that have the specified term assigned in the wp_pattern_category taxonomy.", "type": "array", "default": [], "required": false }, "topic-tag": { "description": "Limit result set to all items that have the specified term assigned in the topic-tag taxonomy.", "type": "array", "default": [], "required": false }, "product_brand": { "description": "Limit result set to all items that have the specified term assigned in the product_brand taxonomy.", "type": "array", "default": [], "required": false }, "product_cat": { "description": "Limit result set to all items that have the specified term assigned in the product_cat taxonomy.", "type": "array", "default": [], "required": false }, "product_tag": { "description": "Limit result set to all items that have the specified term assigned in the product_tag taxonomy.", "type": "array", "default": [], "required": false }, "tribe_events_cat": { "description": "Limit result set to all items that have the specified term assigned in the tribe_events_cat taxonomy.", "type": "array", "default": [], "required": false }, "ld_course_category": { "description": "Limit result set to all items that have the specified term assigned in the ld_course_category taxonomy.", "type": "array", "default": [], "required": false }, "ld_course_tag": { "description": "Limit result set to all items that have the specified term assigned in the ld_course_tag taxonomy.", "type": "array", "default": [], "required": false }, "ld_lesson_category": { "description": "Limit result set to all items that have the specified term assigned in the ld_lesson_category taxonomy.", "type": "array", "default": [], "required": false }, "ld_lesson_tag": { "description": "Limit result set to all items that have the specified term assigned in the ld_lesson_tag taxonomy.", "type": "array", "default": [], "required": false }, "ld_topic_category": { "description": "Limit result set to all items that have the specified term assigned in the ld_topic_category taxonomy.", "type": "array", "default": [], "required": false }, "ld_topic_tag": { "description": "Limit result set to all items that have the specified term assigned in the ld_topic_tag taxonomy.", "type": "array", "default": [], "required": false }, "ld_group_category": { "description": "Limit result set to all items that have the specified term assigned in the ld_group_category taxonomy.", "type": "array", "default": [], "required": false }, "ld_group_tag": { "description": "Limit result set to all items that have the specified term assigned in the ld_group_tag taxonomy.", "type": "array", "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/gamipress-posts" } ] } }, "\/litespeed\/v1": { "namespace": "litespeed\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "litespeed\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1" } ] } }, "\/litespeed\/v1\/toggle_crawler_state": { "namespace": "litespeed\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/toggle_crawler_state" } ] } }, "\/litespeed\/v1\/tool\/check_ip": { "namespace": "litespeed\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/tool\/check_ip" } ] } }, "\/litespeed\/v1\/guest\/sync": { "namespace": "litespeed\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/guest\/sync" } ] } }, "\/litespeed\/v3": { "namespace": "litespeed\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "litespeed\/v3", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v3" } ] } }, "\/litespeed\/v3\/ip_validate": { "namespace": "litespeed\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v3\/ip_validate" } ] } }, "\/litespeed\/v3\/wp_rest_echo": { "namespace": "litespeed\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v3\/wp_rest_echo" } ] } }, "\/litespeed\/v3\/ping": { "namespace": "litespeed\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v3\/ping" } ] } }, "\/litespeed\/v3\/cdn_status": { "namespace": "litespeed\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v3\/cdn_status" } ] } }, "\/litespeed\/v1\/notify_img": { "namespace": "litespeed\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/notify_img" } ] } }, "\/litespeed\/v1\/notify_ccss": { "namespace": "litespeed\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/notify_ccss" } ] } }, "\/litespeed\/v1\/notify_ucss": { "namespace": "litespeed\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/notify_ucss" } ] } }, "\/litespeed\/v1\/notify_vpi": { "namespace": "litespeed\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/notify_vpi" } ] } }, "\/litespeed\/v3\/err_domains": { "namespace": "litespeed\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v3\/err_domains" } ] } }, "\/litespeed\/v1\/check_img": { "namespace": "litespeed\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/litespeed\/v1\/check_img" } ] } }, "\/post-smtp\/v1": { "namespace": "post-smtp\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "post-smtp\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v1" } ] } }, "\/post-smtp\/v1\/connect-app": { "namespace": "post-smtp\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v1\/connect-app" } ] } }, "\/post-smtp\/v1\/get-logs": { "namespace": "post-smtp\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v1\/get-logs" } ] } }, "\/post-smtp\/v1\/disconnect-site": { "namespace": "post-smtp\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v1\/disconnect-site" } ] } }, "\/post-smtp\/v1\/get-log": { "namespace": "post-smtp\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v1\/get-log" } ] } }, "\/post-smtp\/v1\/resend-email": { "namespace": "post-smtp\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v1\/resend-email" } ] } }, "\/post-smtp\/v2": { "namespace": "post-smtp\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "post-smtp\/v2", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v2" } ] } }, "\/post-smtp\/v2\/get-logs": { "namespace": "post-smtp\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v2\/get-logs" } ] } }, "\/post-smtp\/v2\/validate-license": { "namespace": "post-smtp\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/post-smtp\/v2\/validate-license" } ] } }, "\/psd\/v1": { "namespace": "psd\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "psd\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1" } ] } }, "\/psd\/v1\/get-logs": { "namespace": "psd\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/get-logs" } ] } }, "\/psd\/v1\/get-details": { "namespace": "psd\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/get-details" } ] } }, "\/psd\/v1\/resend-email": { "namespace": "psd\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/resend-email" } ] } }, "\/psd\/v1\/email-count": { "namespace": "psd\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/email-count" } ] } }, "\/psd\/v1\/minimize-maximize-ad": { "namespace": "psd\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/minimize-maximize-ad" } ] } }, "\/psd\/v1\/get-failed-logs": { "namespace": "psd\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/get-failed-logs" } ] } }, "\/psd\/v1\/open-notification": { "namespace": "psd\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/open-notification" } ] } }, "\/psd\/v1\/remove-notification": { "namespace": "psd\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/psd\/v1\/remove-notification" } ] } }, "\/wc\/v3": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc\/v3", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3" } ] } }, "\/wc\/v3\/marketplace\/featured": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/featured" } ] } }, "\/wc\/v1": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1" } ] } }, "\/wc\/v1\/marketplace\/product-preview": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/marketplace\/product-preview" } ] } }, "\/wc\/v3\/marketplace\/refresh": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/refresh" } ] } }, "\/wc\/v3\/marketplace\/subscriptions": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/subscriptions" } ] } }, "\/wc\/v3\/marketplace\/subscriptions\/connect": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "product_key": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/subscriptions\/connect" } ] } }, "\/wc\/v3\/marketplace\/subscriptions\/activate-plugin": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "product_key": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/subscriptions\/activate-plugin" } ] } }, "\/wc\/v3\/marketplace\/subscriptions\/disconnect": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "product_key": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/subscriptions\/disconnect" } ] } }, "\/wc\/v3\/marketplace\/subscriptions\/activate": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "product_key": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/subscriptions\/activate" } ] } }, "\/wc\/v3\/marketplace\/subscriptions\/install-url": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_key": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/subscriptions\/install-url" } ] } }, "\/wc\/v3\/marketplace\/create-order": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "product_id": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/marketplace\/create-order" } ] } }, "\/wc\/pos\/v1\/catalog": { "namespace": "wc\/pos\/v1\/catalog", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc\/pos\/v1\/catalog", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/pos\/v1\/catalog" } ] } }, "\/wc\/pos\/v1\/catalog\/create": { "namespace": "wc\/pos\/v1\/catalog", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "force": { "type": "boolean", "default": false, "description": "Force regeneration of the feed. NOOP if generation is in progress.", "required": false }, "_product_fields": { "type": "string", "description": "Comma-separated list of fields to include for non-variable products.", "required": false }, "_variation_fields": { "type": "string", "description": "Comma-separated list of fields to include for variations.", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/pos\/v1\/catalog\/create" } ] } }, "\/wordfence\/v1": { "namespace": "wordfence\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wordfence\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1" } ] } }, "\/wordfence\/v1\/authenticate": { "namespace": "wordfence\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/authenticate" } ] } }, "\/wordfence\/v1\/authenticate-premium": { "namespace": "wordfence\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/authenticate-premium" } ] } }, "\/wordfence\/v1\/config": { "namespace": "wordfence\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/config" } ] } }, "\/wordfence\/v1\/disconnect": { "namespace": "wordfence\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/disconnect" } ] } }, "\/wordfence\/v1\/premium-connect": { "namespace": "wordfence\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/premium-connect" } ] } }, "\/wordfence\/v1\/scan\/issues": { "namespace": "wordfence\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/scan\/issues" } ] } }, "\/wordfence\/v1\/scan": { "namespace": "wordfence\/v1", "methods": [ "POST", "DELETE" ], "endpoints": [ { "methods": [ "POST" ], "args": [] }, { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/scan" } ] } }, "\/wordfence\/v1\/scan\/issue": { "namespace": "wordfence\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wordfence\/v1\/scan\/issue" } ] } }, "\/yoast\/v1": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "yoast\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1" } ] } }, "\/yoast\/v1\/file_size": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "url": { "type": "string", "description": "The url to retrieve", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/file_size" } ] } }, "\/yoast\/v1\/statistics": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/statistics" } ] } }, "\/yoast\/v1\/new-content-type-visibility\/dismiss-post-type": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "postTypeName": { "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/new-content-type-visibility\/dismiss-post-type" } ] } }, "\/yoast\/v1\/new-content-type-visibility\/dismiss-taxonomy": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "taxonomyName": { "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/new-content-type-visibility\/dismiss-taxonomy" } ] } }, "\/yoast\/v1\/site_kit_configuration_permanent_dismissal": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "is_dismissed": { "type": "bool", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/site_kit_configuration_permanent_dismissal" } ] } }, "\/yoast\/v1\/site_kit_manage_consent": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "consent": { "type": "bool", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/site_kit_manage_consent" } ] } }, "\/yoast\/v1\/readability_scores": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "contentType": { "type": "string", "required": true }, "taxonomy": { "type": "string", "default": "", "required": false }, "term": { "type": "integer", "default": null, "required": false }, "troubleshooting": { "type": "bool", "default": null, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/readability_scores" } ] } }, "\/yoast\/v1\/seo_scores": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "contentType": { "type": "string", "required": true }, "taxonomy": { "type": "string", "default": "", "required": false }, "term": { "type": "integer", "default": null, "required": false }, "troubleshooting": { "type": "bool", "default": null, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/seo_scores" } ] } }, "\/yoast\/v1\/time_based_seo_metrics": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "limit": { "type": "int", "default": 5, "required": false }, "options": { "type": "object", "properties": { "widget": { "type": "string", "required": true, "sanitize_callback": "sanitize_text_field" } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/time_based_seo_metrics" } ] } }, "\/yoast\/v1\/setup_steps_tracking": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "setup_widget_loaded": { "type": "string", "enum": [ "yes", "no" ], "required": false }, "first_interaction_stage": { "type": "string", "enum": [ "install", "activate", "setup", "grantConsent", "successfullyConnected" ], "required": false }, "last_interaction_stage": { "type": "string", "enum": [ "install", "activate", "setup", "grantConsent", "successfullyConnected" ], "required": false }, "setup_widget_temporarily_dismissed": { "type": "string", "enum": [ "yes", "no" ], "required": false }, "setup_widget_permanently_dismissed": { "type": "string", "enum": [ "yes", "no" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/setup_steps_tracking" } ] } }, "\/yoast\/v1\/introductions\/(?P[\\w-]+)\/seen": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "introduction_id": { "type": "string", "required": true }, "is_seen": { "type": "bool", "default": true, "required": false } } } ] }, "\/yoast\/v1\/wistia_embed_permission": { "namespace": "yoast\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "value": { "type": "bool", "default": true, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wistia_embed_permission" } ] } }, "\/yoast\/v1\/available_posts": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "search": { "type": "string", "default": "", "required": false }, "postType": { "type": "string", "default": "page", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/available_posts" } ] } }, "\/yoast\/v1\/alerts\/dismiss": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "key": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/alerts\/dismiss" } ] } }, "\/yoast\/v1\/configuration\/site_representation": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "company_or_person": { "type": "string", "enum": [ "company", "person" ], "required": true }, "company_name": { "type": "string", "required": false }, "company_logo": { "type": "string", "required": false }, "company_logo_id": { "type": "integer", "required": false }, "person_logo": { "type": "string", "required": false }, "person_logo_id": { "type": "integer", "required": false }, "company_or_person_user_id": { "type": "integer", "required": false }, "description": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/configuration\/site_representation" } ] } }, "\/yoast\/v1\/configuration\/social_profiles": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "facebook_site": { "type": "string", "required": false }, "twitter_site": { "type": "string", "required": false }, "other_social_urls": { "type": "array", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/configuration\/social_profiles" } ] } }, "\/yoast\/v1\/configuration\/check_capability": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "user_id": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/configuration\/check_capability" } ] } }, "\/yoast\/v1\/configuration\/enable_tracking": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "tracking": { "type": "boolean", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/configuration\/enable_tracking" } ] } }, "\/yoast\/v1\/configuration\/save_configuration_state": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "finishedSteps": { "type": "array", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/configuration\/save_configuration_state" } ] } }, "\/yoast\/v1\/configuration\/get_configuration_state": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/configuration\/get_configuration_state" } ] } }, "\/yoast\/v1\/import\/(?P[\\w-]+)\/(?P[\\w-]+)": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/yoast\/v1\/get_head": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "url": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/get_head" } ] } }, "\/yoast\/v1\/indexing\/posts": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/indexing\/posts" } ] } }, "\/yoast\/v1\/indexing\/terms": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/indexing\/terms" } ] } }, "\/yoast\/v1\/indexing\/post-type-archives": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/indexing\/post-type-archives" } ] } }, "\/yoast\/v1\/indexing\/general": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/indexing\/general" } ] } }, "\/yoast\/v1\/indexing\/prepare": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/indexing\/prepare" } ] } }, "\/yoast\/v1\/indexing\/indexables-complete": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/indexing\/indexables-complete" } ] } }, "\/yoast\/v1\/indexing\/complete": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/indexing\/complete" } ] } }, "\/yoast\/v1\/link-indexing\/posts": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/link-indexing\/posts" } ] } }, "\/yoast\/v1\/link-indexing\/terms": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/link-indexing\/terms" } ] } }, "\/yoast\/v1\/integrations\/set_active": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "active": { "type": "boolean", "required": true }, "integration": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/integrations\/set_active" } ] } }, "\/yoast\/v1\/meta\/search": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/meta\/search" } ] } }, "\/yoast\/v1\/semrush\/authenticate": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "code": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/semrush\/authenticate" } ] } }, "\/yoast\/v1\/semrush\/country_code": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "country_code": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/semrush\/country_code" } ] } }, "\/yoast\/v1\/semrush\/related_keyphrases": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "keyphrase": { "required": true }, "country_code": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/semrush\/related_keyphrases" } ] } }, "\/yoast\/v1\/wincher\/authorization-url": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wincher\/authorization-url" } ] } }, "\/yoast\/v1\/wincher\/authenticate": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "code": { "required": true }, "websiteId": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wincher\/authenticate" } ] } }, "\/yoast\/v1\/wincher\/keyphrases\/track": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "keyphrases": { "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wincher\/keyphrases\/track" } ] } }, "\/yoast\/v1\/wincher\/keyphrases": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "keyphrases": { "required": false }, "permalink": { "required": false }, "startAt": { "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wincher\/keyphrases" } ] } }, "\/yoast\/v1\/wincher\/keyphrases\/untrack": { "namespace": "yoast\/v1", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wincher\/keyphrases\/untrack" } ] } }, "\/yoast\/v1\/wincher\/account\/limit": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wincher\/account\/limit" } ] } }, "\/yoast\/v1\/wincher\/account\/upgrade-campaign": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/wincher\/account\/upgrade-campaign" } ] } }, "\/yoast\/v1\/workouts": { "namespace": "yoast\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/workouts" } ] } }, "\/yoast\/v1\/complete_task": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "options": { "type": "object", "properties": { "task": { "type": "string", "required": true, "sanitize_callback": "sanitize_text_field" } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/complete_task" } ] } }, "\/yoast\/v1\/get_tasks": { "namespace": "yoast\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "options": { "type": "object", "properties": { "filter": { "type": "string", "required": false, "sanitize_callback": "sanitize_text_field" }, "limit": { "type": "int", "required": false, "sanitize_callback": "absint" } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/get_tasks" } ] } }, "\/yoast\/v1\/action_tracking": { "namespace": "yoast\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "action": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/yoast\/v1\/action_tracking" } ] } }, "\/ithemes-security\/v1\/dashboard-available-cards": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/dashboard-available-cards" } ] } }, "\/ithemes-security\/v1\/dashboard-available-cards\/(?P[\\w_-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/ithemes-security\/v1\/dashboard-static": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "period": { "default": "30-days", "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time", "required": true }, "end": { "type": "string", "format": "date-time", "required": true } } }, { "type": "string", "enum": [ "24-hours", "week", "30-days" ] } ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/dashboard-static" } ] } }, "\/ithemes-security\/v1\/dashboard\/events": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "period": { "default": "30-days", "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "start": { "type": "string", "format": "date-time", "required": true }, "end": { "type": "string", "format": "date-time", "required": true } } }, { "type": "string", "enum": [ "24-hours", "week", "30-days" ] } ], "required": false }, "events": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "minItems": 1, "maxItems": 10, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/dashboard\/events" } ] } }, "\/ithemes-security\/v1\/admin-notices": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/admin-notices" } ] } }, "\/ithemes-security\/v1\/admin-notices\/(?P[\\w\\-\\.]+)\/(?P[\\w\\-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/ithemes-security\/v1\/admin-notices\/settings": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/admin-notices\/settings" } ] } }, "\/ithemes-security\/v1\/actors": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/actors" } ] } }, "\/ithemes-security\/v1\/actors\/(?P[\\w\\-\\_]+)\/search": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/ldlms\/v1": { "namespace": "ldlms\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "ldlms\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1" } ] } }, "\/ldlms\/v1\/echo": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] }, { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1\/echo" } ] } }, "\/wp\/v2\/sfwd-courses": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "GET", "POST", "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_course_category": { "description": "Limit result set to items with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_course_tag": { "description": "Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "course_materials": { "description": "Course Materials", "type": "html", "required": false }, "course_price_type": { "default": "open", "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "buynow", "subscribe" ], "required": false }, "custom_button_label": { "description": "Custom Button Label", "type": "text", "required": false }, "custom_button_url": { "description": "Custom Button URL", "type": "text", "required": false }, "course_price": { "description": "Course Price", "type": "text", "required": false }, "course_prerequisite_enabled": { "default": false, "description": "Enable Course Prerequisites", "type": "boolean", "required": false }, "course_prerequisite": { "default": [], "description": "Course Prerequisites", "type": "array", "required": false }, "course_prerequisite_compare": { "default": "ANY", "description": "Course Prerequisites Compare", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "course_points_enabled": { "description": "Enable Course Points", "type": "boolean", "required": false }, "course_points": { "description": "Course Points", "type": "number", "required": false }, "course_points_access": { "description": "Course Points Access", "type": "number", "required": false }, "course_disable_lesson_progression": { "default": 0, "description": "Disable Lesson Progression", "type": "boolean", "required": false }, "expire_access": { "description": "Expire Access", "type": "boolean", "required": false }, "expire_access_days": { "description": "Expire Access After (days)", "type": "number", "required": false }, "expire_access_delete_progress": { "description": "Delete Course and Quiz Data After Expiration", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/sfwd-courses" } ] } }, "\/wp\/v2\/sfwd-courses\/(?P[\\d]+)": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "course_materials": { "description": "Course Materials", "type": "html", "required": false }, "course_price_type": { "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "buynow", "subscribe" ], "required": false }, "custom_button_label": { "description": "Custom Button Label", "type": "text", "required": false }, "custom_button_url": { "description": "Custom Button URL", "type": "text", "required": false }, "course_price": { "description": "Course Price", "type": "text", "required": false }, "course_prerequisite_enabled": { "description": "Enable Course Prerequisites", "type": "boolean", "required": false }, "course_prerequisite": { "description": "Course Prerequisites", "type": "array", "required": false }, "course_prerequisite_compare": { "description": "Course Prerequisites Compare", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "course_points_enabled": { "description": "Enable Course Points", "type": "boolean", "required": false }, "course_points": { "description": "Course Points", "type": "number", "required": false }, "course_points_access": { "description": "Course Points Access", "type": "number", "required": false }, "course_disable_lesson_progression": { "description": "Disable Lesson Progression", "type": "boolean", "required": false }, "expire_access": { "description": "Expire Access", "type": "boolean", "required": false }, "expire_access_days": { "description": "Expire Access After (days)", "type": "number", "required": false }, "expire_access_delete_progress": { "description": "Delete Course and Quiz Data After Expiration", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "course_materials": { "description": "Course Materials", "type": "html", "required": false }, "course_price_type": { "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "buynow", "subscribe" ], "required": false }, "custom_button_label": { "description": "Custom Button Label", "type": "text", "required": false }, "custom_button_url": { "description": "Custom Button URL", "type": "text", "required": false }, "course_price": { "description": "Course Price", "type": "text", "required": false }, "course_prerequisite_enabled": { "description": "Enable Course Prerequisites", "type": "boolean", "required": false }, "course_prerequisite": { "description": "Course Prerequisites", "type": "array", "required": false }, "course_prerequisite_compare": { "description": "Course Prerequisites Compare", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "course_points_enabled": { "description": "Enable Course Points", "type": "boolean", "required": false }, "course_points": { "description": "Course Points", "type": "number", "required": false }, "course_points_access": { "description": "Course Points Access", "type": "number", "required": false }, "course_disable_lesson_progression": { "description": "Disable Lesson Progression", "type": "boolean", "required": false }, "expire_access": { "description": "Expire Access", "type": "boolean", "required": false }, "expire_access_days": { "description": "Expire Access After (days)", "type": "number", "required": false }, "expire_access_delete_progress": { "description": "Delete Course and Quiz Data After Expiration", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "course_materials": { "description": "Course Materials", "type": "html", "required": false }, "course_price_type": { "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "buynow", "subscribe" ], "required": false }, "custom_button_label": { "description": "Custom Button Label", "type": "text", "required": false }, "custom_button_url": { "description": "Custom Button URL", "type": "text", "required": false }, "course_price": { "description": "Course Price", "type": "text", "required": false }, "course_prerequisite_enabled": { "description": "Enable Course Prerequisites", "type": "boolean", "required": false }, "course_prerequisite": { "description": "Course Prerequisites", "type": "array", "required": false }, "course_prerequisite_compare": { "description": "Course Prerequisites Compare", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "course_points_enabled": { "description": "Enable Course Points", "type": "boolean", "required": false }, "course_points": { "description": "Course Points", "type": "number", "required": false }, "course_points_access": { "description": "Course Points Access", "type": "number", "required": false }, "course_disable_lesson_progression": { "description": "Disable Lesson Progression", "type": "boolean", "required": false }, "expire_access": { "description": "Expire Access", "type": "boolean", "required": false }, "expire_access_days": { "description": "Expire Access After (days)", "type": "number", "required": false }, "expire_access_delete_progress": { "description": "Delete Course and Quiz Data After Expiration", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/sfwd-courses": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_course_category": { "description": "Limit result set to items with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_course_tag": { "description": "Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "course_materials": { "description": "Course Materials", "type": "html", "required": false }, "course_price_type": { "default": "open", "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "buynow", "subscribe" ], "required": false }, "custom_button_label": { "description": "Custom Button Label", "type": "text", "required": false }, "custom_button_url": { "description": "Custom Button URL", "type": "text", "required": false }, "course_price": { "description": "Course Price", "type": "text", "required": false }, "course_prerequisite_enabled": { "default": false, "description": "Enable Course Prerequisites", "type": "boolean", "required": false }, "course_prerequisite": { "default": [], "description": "Course Prerequisites", "type": "array", "required": false }, "course_prerequisite_compare": { "default": "ANY", "description": "Course Prerequisites Compare", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "course_points_enabled": { "description": "Enable Course Points", "type": "boolean", "required": false }, "course_points": { "description": "Course Points", "type": "number", "required": false }, "course_points_access": { "description": "Course Points Access", "type": "number", "required": false }, "course_disable_lesson_progression": { "default": 0, "description": "Disable Lesson Progression", "type": "boolean", "required": false }, "expire_access": { "description": "Expire Access", "type": "boolean", "required": false }, "expire_access_days": { "description": "Expire Access After (days)", "type": "number", "required": false }, "expire_access_delete_progress": { "description": "Delete Course and Quiz Data After Expiration", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1\/sfwd-courses" } ] } }, "\/ldlms\/v1\/sfwd-courses\/(?P[\\d]+)": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": true }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "course_materials": { "description": "Course Materials", "type": "html", "required": false }, "course_price_type": { "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "buynow", "subscribe" ], "required": false }, "custom_button_label": { "description": "Custom Button Label", "type": "text", "required": false }, "custom_button_url": { "description": "Custom Button URL", "type": "text", "required": false }, "course_price": { "description": "Course Price", "type": "text", "required": false }, "course_prerequisite_enabled": { "description": "Enable Course Prerequisites", "type": "boolean", "required": false }, "course_prerequisite": { "description": "Course Prerequisites", "type": "array", "required": false }, "course_prerequisite_compare": { "description": "Course Prerequisites Compare", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "course_points_enabled": { "description": "Enable Course Points", "type": "boolean", "required": false }, "course_points": { "description": "Course Points", "type": "number", "required": false }, "course_points_access": { "description": "Course Points Access", "type": "number", "required": false }, "course_disable_lesson_progression": { "description": "Disable Lesson Progression", "type": "boolean", "required": false }, "expire_access": { "description": "Expire Access", "type": "boolean", "required": false }, "expire_access_days": { "description": "Expire Access After (days)", "type": "number", "required": false }, "expire_access_delete_progress": { "description": "Delete Course and Quiz Data After Expiration", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": true }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/sfwd-courses\/(?P[\\d]+)\/steps": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Course ID to enroll user into.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "type": { "description": "Filter returned results by step type.", "type": "string", "default": "all", "enum": [ "all", "h", "l", "t", "r" ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Course ID to enroll user into.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "type": { "description": "Filter returned results by step type.", "type": "string", "default": "all", "enum": [ "all", "h", "l", "t", "r" ], "required": false } } } ] }, "\/ldlms\/v1\/sfwd-courses\/(?P[\\d]+)\/users": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Course ID.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "fields": { "description": "Returned values.", "type": "string", "default": "ids", "enum": [ "ids", "objects" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "roles": { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "type": "array", "items": { "type": "string" }, "required": false }, "slug": { "description": "Limit result set to users with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Course ID.", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to enroll into course. Limit 50 per request.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Course ID.", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to remove from group. Limit 50 per request.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/wp\/v2\/groups": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "GET", "POST", "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "categories": { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "tags": { "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "ld_group_category": { "description": "Limit result set to items with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_group_tag": { "description": "Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/groups" } ] } }, "\/wp\/v2\/groups\/(?P[\\d]+)": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/sfwd-courses\/(?P[\\d]+)\/groups": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Course ID to enroll into.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "fields": { "description": "Returned values.", "type": "string", "default": "ids", "enum": [ "ids", "objects" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Course ID to enroll into.", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to enroll into Course.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Course ID to enroll into.", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to remove from Course.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/wp\/v2\/sfwd-lessons": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_lesson_category": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_lesson_category": { "description": "The terms assigned to the object in the ld_lesson_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_lesson_tag": { "description": "The terms assigned to the object in the ld_lesson_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "lesson_materials": { "description": "Lesson Materials", "type": "html", "required": false }, "forced_lesson_time": { "default": "", "description": "Forced Lesson Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "default": 0, "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "default": "on", "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "default": "1", "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_deletion_enabled": { "default": 0, "description": "Allow Student to Delete own Assignment(s)", "type": "boolean", "required": false }, "lesson_assignment_points_enabled": { "default": 0, "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "default": 0, "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "default": "", "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "default": "", "description": "Allowed File Size", "type": "text", "required": false }, "visible_after": { "default": 0, "description": "Make Lesson visible X Days After Sign-up", "type": "number", "required": false }, "visible_after_specific_date": { "description": "Make Lesson Visible on Specific Date", "type": "wp_date_selector", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/sfwd-lessons" } ] } }, "\/wp\/v2\/sfwd-lessons\/(?P[\\d]+)": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_lesson_category": { "description": "The terms assigned to the object in the ld_lesson_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_lesson_tag": { "description": "The terms assigned to the object in the ld_lesson_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_lesson_category": { "description": "The terms assigned to the object in the ld_lesson_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_lesson_tag": { "description": "The terms assigned to the object in the ld_lesson_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "lesson_materials": { "description": "Lesson Materials", "type": "html", "required": false }, "forced_lesson_time": { "description": "Forced Lesson Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_deletion_enabled": { "description": "Allow Student to Delete own Assignment(s)", "type": "boolean", "required": false }, "lesson_assignment_points_enabled": { "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "description": "Allowed File Size", "type": "text", "required": false }, "visible_after": { "description": "Make Lesson visible X Days After Sign-up", "type": "number", "required": false }, "visible_after_specific_date": { "description": "Make Lesson Visible on Specific Date", "type": "wp_date_selector", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/sfwd-lessons": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_lesson_category": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_lesson_category": { "description": "The terms assigned to the object in the ld_lesson_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_lesson_tag": { "description": "The terms assigned to the object in the ld_lesson_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "lesson_materials": { "description": "Lesson Materials", "type": "html", "required": false }, "forced_lesson_time": { "default": "", "description": "Forced Lesson Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "default": 0, "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "default": "on", "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "default": "1", "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_deletion_enabled": { "default": 0, "description": "Allow Student to Delete own Assignment(s)", "type": "boolean", "required": false }, "lesson_assignment_points_enabled": { "default": 0, "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "default": 0, "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "default": "", "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "default": "", "description": "Allowed File Size", "type": "text", "required": false }, "visible_after": { "default": 0, "description": "Make Lesson visible X Days After Sign-up", "type": "number", "required": false }, "visible_after_specific_date": { "description": "Make Lesson Visible on Specific Date", "type": "wp_date_selector", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1\/sfwd-lessons" } ] } }, "\/ldlms\/v1\/sfwd-lessons\/(?P[\\d]+)": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_lesson_category": { "description": "The terms assigned to the object in the ld_lesson_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_lesson_tag": { "description": "The terms assigned to the object in the ld_lesson_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "lesson_materials": { "description": "Lesson Materials", "type": "html", "required": false }, "forced_lesson_time": { "description": "Forced Lesson Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_deletion_enabled": { "description": "Allow Student to Delete own Assignment(s)", "type": "boolean", "required": false }, "lesson_assignment_points_enabled": { "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "description": "Allowed File Size", "type": "text", "required": false }, "visible_after": { "description": "Make Lesson visible X Days After Sign-up", "type": "number", "required": false }, "visible_after_specific_date": { "description": "Make Lesson Visible on Specific Date", "type": "wp_date_selector", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/wp\/v2\/sfwd-topic": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_topic_category": { "description": "Limit result set to items with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag": { "description": "Limit result set to items with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_topic_category": { "description": "The terms assigned to the object in the ld_topic_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_topic_tag": { "description": "The terms assigned to the object in the ld_topic_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "topic_materials": { "description": "Topic Materials", "type": "html", "required": false }, "forced_lesson_time": { "default": "", "description": "Forced Topic Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "default": 0, "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "default": "on", "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "default": "1", "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_points_enabled": { "default": 0, "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "default": 0, "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "default": "", "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "default": "", "description": "Allowed File Size", "type": "text", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/sfwd-topic" } ] } }, "\/wp\/v2\/sfwd-topic\/(?P[\\d]+)": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_topic_category": { "description": "The terms assigned to the object in the ld_topic_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_topic_tag": { "description": "The terms assigned to the object in the ld_topic_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_topic_category": { "description": "The terms assigned to the object in the ld_topic_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_topic_tag": { "description": "The terms assigned to the object in the ld_topic_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "topic_materials": { "description": "Topic Materials", "type": "html", "required": false }, "forced_lesson_time": { "description": "Forced Topic Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_points_enabled": { "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "description": "Allowed File Size", "type": "text", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/sfwd-topic": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_topic_category": { "description": "Limit result set to items with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag": { "description": "Limit result set to items with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_topic_category": { "description": "The terms assigned to the object in the ld_topic_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_topic_tag": { "description": "The terms assigned to the object in the ld_topic_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "topic_materials": { "description": "Topic Materials", "type": "html", "required": false }, "forced_lesson_time": { "default": "", "description": "Forced Topic Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "default": 0, "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "default": "on", "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "default": "1", "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_points_enabled": { "default": 0, "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "default": 0, "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "default": "", "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "default": "", "description": "Allowed File Size", "type": "text", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1\/sfwd-topic" } ] } }, "\/ldlms\/v1\/sfwd-topic\/(?P[\\d]+)": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_topic_category": { "description": "The terms assigned to the object in the ld_topic_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_topic_tag": { "description": "The terms assigned to the object in the ld_topic_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "topic_materials": { "description": "Topic Materials", "type": "html", "required": false }, "forced_lesson_time": { "description": "Forced Topic Timer", "type": "text", "required": false }, "lesson_assignment_upload": { "description": "Upload Assignment", "type": "boolean", "required": false }, "auto_approve_assignment": { "description": "Auto Approve Assignment", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "description": "Limit number of uploaded files", "type": "number", "required": false }, "lesson_assignment_points_enabled": { "description": "Award Points for Assignment", "type": "boolean", "required": false }, "lesson_assignment_points_amount": { "description": "Set Number of Points for Assignment", "type": "number", "required": false }, "assignment_upload_limit_extensions": { "description": "Allowed File Extensions", "type": "text", "required": false }, "assignment_upload_limit_size": { "description": "Allowed File Size", "type": "text", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/wp\/v2\/sfwd-quiz": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": [] }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Pass zero to show global Course Quizzes. Must be used with Course parameter.", "type": "integer", "required": false }, "topic": { "description": "Limit results to be within a specific Topic. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "quiz_materials": { "description": "Quiz Materials", "type": "html", "required": false }, "threshold": { "default": "0.8", "description": "Certificate Threshold", "type": "text", "required": false }, "passingpercentage": { "default": "80", "description": "Passing Percentage", "type": "text", "required": false }, "certificate": { "default": "", "description": "Associated Certificate", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp\/v2\/sfwd-quiz" } ] } }, "\/wp\/v2\/sfwd-quiz\/(?P[\\d]+)": { "namespace": "wp\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "quiz_materials": { "description": "Quiz Materials", "type": "html", "required": false }, "threshold": { "description": "Certificate Threshold", "type": "text", "required": false }, "passingpercentage": { "description": "Passing Percentage", "type": "text", "required": false }, "certificate": { "description": "Associated Certificate", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } }, { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "quiz_materials": { "description": "Quiz Materials", "type": "html", "required": false }, "threshold": { "description": "Certificate Threshold", "type": "text", "required": false }, "passingpercentage": { "description": "Passing Percentage", "type": "text", "required": false }, "certificate": { "description": "Associated Certificate", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the post.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/sfwd-quiz": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Pass zero to show global Course Quizzes. Must be used with Course parameter.", "type": "integer", "required": false }, "topic": { "description": "Limit results to be within a specific Topic. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "quiz_materials": { "description": "Quiz Materials", "type": "html", "required": false }, "threshold": { "default": "0.8", "description": "Certificate Threshold", "type": "text", "required": false }, "passingpercentage": { "default": "80", "description": "Passing Percentage", "type": "text", "required": false }, "certificate": { "default": "", "description": "Associated Certificate", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1\/sfwd-quiz" } ] } }, "\/ldlms\/v1\/sfwd-quiz\/(?P[\\d]+)": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the quiz object.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the quiz object.", "type": "integer", "required": false }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "quiz_materials": { "description": "Quiz Materials", "type": "html", "required": false }, "threshold": { "description": "Certificate Threshold", "type": "text", "required": false }, "passingpercentage": { "description": "Passing Percentage", "type": "text", "required": false }, "certificate": { "description": "Associated Certificate", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the quiz object.", "type": "integer", "required": false }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/groups": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "categories": { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "tags": { "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "ld_group_category": { "description": "Limit result set to items with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_group_tag": { "description": "Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1\/groups" } ] } }, "\/ldlms\/v1\/groups\/(?P[\\d]+)": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "password": { "description": "The password for the post if it is password protected.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": true }, "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "integer", "required": true }, "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v1\/groups\/(?P[\\d]+)\/courses": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Group ID to enroll into.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "fields": { "description": "Returned values.", "type": "string", "default": "ids", "enum": [ "ids", "objects" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Group ID to enroll into.", "type": "integer", "required": true }, "course_ids": { "description": "Course IDs to enroll into group.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Group ID to enroll into.", "type": "integer", "required": true }, "course_ids": { "description": "Course IDs to remove from group.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v1\/groups\/(?P[\\d]+)\/leaders": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "group ID to enroll group leader into.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "fields": { "description": "Returned values.", "type": "string", "default": "ids", "enum": [ "ids", "objects" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "roles": { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "type": "array", "items": { "type": "string" }, "required": false }, "slug": { "description": "Limit result set to users with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "group ID to enroll group leader into.", "type": "integer", "required": true }, "user_ids": { "description": "Group Leader User IDs to enroll into Group", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "group ID to enroll group leader into.", "type": "integer", "required": true }, "user_ids": { "description": "Group Leader User IDs to remove from Group", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v1\/groups\/(?P[\\d]+)\/users": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "group ID to enroll group leader into.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "fields": { "description": "Returned values.", "type": "string", "default": "ids", "enum": [ "ids", "objects" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "roles": { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "type": "array", "items": { "type": "string" }, "required": false }, "slug": { "description": "Limit result set to users with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "group ID to enroll group leader into.", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to enroll into Group.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "group ID to enroll group leader into.", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to remove from Group.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v1\/users\/(?P[\\d]+)\/groups": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "fields": { "description": "Returned values.", "type": "string", "default": "ids", "enum": [ "ids", "objects" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to add to User.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to remove from User.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v1\/users\/(?P[\\d]+)\/courses": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID to enroll user into.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "fields": { "description": "Returned values.", "type": "string", "default": "ids", "enum": [ "ids", "objects" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "User ID to enroll user into.", "type": "integer", "required": true }, "course_ids": { "description": "Courses IDs to add to User.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "User ID to enroll user into.", "type": "integer", "required": true }, "course_ids": { "description": "Courses IDs to remove from User.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v1\/sfwd-questions": { "namespace": "ldlms\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v1\/sfwd-questions" } ] } }, "\/ldlms\/v1\/sfwd-questions\/(?P[\\d]+)": { "namespace": "ldlms\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "The question ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "The question ID", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "The question ID", "required": true } } } ] }, "\/ldlms\/v1\/sections\/(?P[\\d]+)": { "namespace": "ldlms\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "required": true } } } ] }, "\/ldlms\/v2": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "ldlms\/v2", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2" } ] } }, "\/ldlms\/v2\/sfwd-courses": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_course_category": { "description": "Limit result set to items with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_course_tag": { "description": "Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "default": false, "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "certificate": { "default": 0, "description": "Course Certificate", "type": "integer", "required": false }, "exam_challenge": { "default": 0, "description": "Challenge Exam Show", "type": "integer", "required": false }, "disable_content_table": { "default": false, "description": "Disable Course Content Table", "type": "boolean", "required": false }, "lessons_per_page": { "default": false, "description": "Custom Pagination", "type": "boolean", "required": false }, "lesson_per_page_custom": { "default": 0, "description": "Lessons per page", "type": "integer", "required": false }, "topic_per_page_custom": { "default": 0, "description": "Topics per page", "type": "integer", "required": false }, "price_type": { "default": "open", "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "paynow", "subscribe" ], "required": false }, "price_type_paynow_price": { "default": "", "description": "Pay Now Course Price", "type": "string", "required": false }, "price_type_paynow_enrollment_url": { "default": "", "description": "Pay Now course Enrollment URL", "type": "string", "required": false }, "price_type_subscribe_price": { "default": "", "description": "Subscribe Course Price", "type": "string", "required": false }, "trial_price": { "default": "", "description": "Course Trial Price", "type": "string", "required": false }, "price_type_subscribe_enrollment_url": { "default": "", "description": "Subscribe course Enrollment URL", "type": "string", "required": false }, "price_type_closed_price": { "default": "", "description": "Closed Course Price", "type": "string", "required": false }, "price_type_closed_custom_button_url": { "default": "", "description": "Closed Course Button URL", "type": "string", "required": false }, "prerequisite_enabled": { "default": false, "description": "Course Prerequisites", "type": "boolean", "required": false }, "prerequisite_compare": { "default": "ANY", "description": "Prerequisite Compare Mode.", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "prerequisites": { "default": [], "description": "Prerequisites.", "type": "array", "items": { "type": "integer" }, "required": false }, "points_enabled": { "default": false, "description": "Course Points", "type": "boolean", "required": false }, "points_access": { "default": 0, "description": "Required for Access", "type": "float", "required": false }, "points_amount": { "default": 0, "description": "Awarded on Completion", "type": "float", "required": false }, "expire_access": { "default": false, "description": "Course Access Expiration", "type": "boolean", "required": false }, "expire_access_days": { "description": "Access Period", "type": "integer", "required": false }, "expire_access_delete_progress": { "default": false, "description": "Data Deletion", "type": "boolean", "required": false }, "progression_disabled": { "default": false, "description": "Course Progression Disabled", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/sfwd-courses" } ] } }, "\/ldlms\/v2\/sfwd-courses\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_course_category": { "description": "Limit result set to items with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_course_tag": { "description": "Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_course_category": { "description": "The terms assigned to the object in the ld_course_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_course_tag": { "description": "The terms assigned to the object in the ld_course_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "certificate": { "description": "Course Certificate", "type": "integer", "required": false }, "exam_challenge": { "description": "Challenge Exam Show", "type": "integer", "required": false }, "disable_content_table": { "description": "Disable Course Content Table", "type": "boolean", "required": false }, "lessons_per_page": { "description": "Custom Pagination", "type": "boolean", "required": false }, "lesson_per_page_custom": { "description": "Lessons per page", "type": "integer", "required": false }, "topic_per_page_custom": { "description": "Topics per page", "type": "integer", "required": false }, "price_type": { "description": "Course Price Type", "type": "string", "enum": [ "open", "closed", "free", "paynow", "subscribe" ], "required": false }, "price_type_paynow_price": { "description": "Pay Now Course Price", "type": "string", "required": false }, "price_type_paynow_enrollment_url": { "description": "Pay Now course Enrollment URL", "type": "string", "required": false }, "price_type_subscribe_price": { "description": "Subscribe Course Price", "type": "string", "required": false }, "trial_price": { "description": "Course Trial Price", "type": "string", "required": false }, "price_type_subscribe_enrollment_url": { "description": "Subscribe course Enrollment URL", "type": "string", "required": false }, "price_type_closed_price": { "description": "Closed Course Price", "type": "string", "required": false }, "price_type_closed_custom_button_url": { "description": "Closed Course Button URL", "type": "string", "required": false }, "prerequisite_enabled": { "description": "Course Prerequisites", "type": "boolean", "required": false }, "prerequisite_compare": { "description": "Prerequisite Compare Mode.", "type": "string", "enum": [ "ANY", "ALL" ], "required": false }, "prerequisites": { "description": "Prerequisites.", "type": "array", "items": { "type": "integer" }, "required": false }, "points_enabled": { "description": "Course Points", "type": "boolean", "required": false }, "points_access": { "description": "Required for Access", "type": "float", "required": false }, "points_amount": { "description": "Awarded on Completion", "type": "float", "required": false }, "expire_access": { "description": "Course Access Expiration", "type": "boolean", "required": false }, "expire_access_days": { "description": "Access Period", "type": "integer", "required": false }, "expire_access_delete_progress": { "description": "Data Deletion", "type": "boolean", "required": false }, "progression_disabled": { "description": "Course Progression Disabled", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-courses\/(?P[\\d]+)\/steps": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Course ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "type": { "description": "Filter returned results by step type.", "type": "string", "default": "all", "enum": [ "all", "h", "l", "t", "r", "co", "sections", "legacy" ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Course ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "type": { "description": "Filter returned results by step type.", "type": "string", "default": "all", "enum": [ "all", "h", "l", "t", "r", "co", "sections", "legacy" ], "required": false } } } ] }, "\/ldlms\/v2\/sfwd-courses\/(?P[\\d]+)\/prerequisites": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Course ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_course_category": { "description": "Limit result set to items with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_course_tag": { "description": "Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } } ] }, "\/ldlms\/v2\/sfwd-courses\/(?P[\\d]+)\/users": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Course ID.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "name", "description": "Sort collection by user attribute.", "enum": [ "id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url" ], "type": "string", "required": false }, "slug": { "description": "Limit result set to users with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "roles": { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "type": "array", "items": { "type": "string" }, "required": false }, "capabilities": { "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", "type": "array", "items": { "type": "string" }, "required": false }, "who": { "description": "Limit result set to users who are considered authors.", "type": "string", "enum": [ "authors" ], "required": false }, "has_published_posts": { "description": "Limit result set to users who have published posts.", "type": [ "boolean", "array" ], "items": { "type": "string", "enum": { "post": "post", "page": "page", "attachment": "attachment", "nav_menu_item": "nav_menu_item", "wp_block": "wp_block", "wp_template": "wp_template", "wp_template_part": "wp_template_part", "wp_global_styles": "wp_global_styles", "wp_navigation": "wp_navigation", "wp_font_family": "wp_font_family", "wp_font_face": "wp_font_face", "elementor_library": "elementor_library", "product": "product", "sfwd-courses": "sfwd-courses", "sfwd-lessons": "sfwd-lessons", "sfwd-topic": "sfwd-topic", "sfwd-quiz": "sfwd-quiz", "sfwd-question": "sfwd-question", "ld-exam": "ld-exam", "sfwd-certificates": "sfwd-certificates", "groups": "groups", "bp-group-type": "bp-group-type", "bp-invite": "bp-invite", "bp-member-type": "bp-member-type", "points-type": "points-type", "points-award": "points-award", "points-deduct": "points-deduct", "achievement-type": "achievement-type", "step": "step", "rank-type": "rank-type", "rank-requirement": "rank-requirement", "bl": "bl", "guru": "guru", "ml": "ml", "pl": "pl", "level-rank": "level-rank", "test": "test", "mailpoet_email": "mailpoet_email", "sfwd-essays": "sfwd-essays", "sfwd-assignment": "sfwd-assignment", "tribe_rsvp_tickets": "tribe_rsvp_tickets", "tribe_tpp_tickets": "tribe_tpp_tickets", "tribe_venue": "tribe_venue", "tribe_organizer": "tribe_organizer", "tribe_events": "tribe_events", "jet-engine": "jet-engine" } }, "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "email", "name", "id", "username", "slug" ], "type": "string" }, "required": false }, "solid_user_groups": { "type": "array", "items": { "type": "string", "format": "uuid" }, "required": false }, "solid_last_seen": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time" }, "before": { "type": "string", "format": "date-time" } }, "required": false }, "solid_password_changed": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time" }, "before": { "type": "string", "format": "date-time" } }, "required": false }, "solid_password_strength": { "type": "array", "items": { "type": "integer", "oneOf": [ { "enum": [ 0 ], "title": "Very Weak" }, { "enum": [ 1 ], "title": "Very Weak" }, { "enum": [ 2 ], "title": "Weak" }, { "enum": [ 3 ], "title": "Medium" }, { "enum": [ 4 ], "title": "Strong" } ] }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Course ID.", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to update in Course. Limit 50 per request.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Course ID.", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to remove from Course. Limit 50 per request.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v2\/sfwd-courses\/(?P[\\d]+)\/groups": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Course ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "categories": { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "tags": { "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "ld_group_category": { "description": "Limit result set to items with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_group_tag": { "description": "Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Course ID", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to enroll into Course.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Course ID", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to remove from Course.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v2\/sfwd-lessons": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_lesson_category": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_lesson_category": { "description": "The terms assigned to the object in the ld_lesson_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_lesson_tag": { "description": "The terms assigned to the object in the ld_lesson_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "default": false, "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "video_enabled": { "default": false, "description": "Lesson Video Progression Enabled", "type": "boolean", "required": false }, "video_url": { "default": "", "description": "Lesson Video Progression URL", "type": "text", "required": false }, "video_shown": { "default": "BEFORE", "description": "Lesson Video Shown before or after sub-steps", "type": "string", "enum": [ "BEFORE", "AFTER" ], "required": false }, "video_auto_complete": { "default": false, "description": "Lesson Video Auto-complete", "type": "boolean", "required": false }, "video_auto_complete_delay": { "default": 0, "description": "Lesson Video Completion Delay (seconds).", "type": "integer", "required": false }, "video_show_complete_button": { "default": false, "description": "Lesson Video Show Mark Complete Button", "type": "boolean", "required": false }, "video_auto_start": { "default": false, "description": "Lesson Video Autostart", "type": "boolean", "required": false }, "video_show_controls": { "default": false, "description": "Lesson Video Controls Display. YouTube and local videos only", "type": "boolean", "required": false }, "video_focus_pause": { "default": false, "description": "Video Pause on Window Unfocused", "type": "boolean", "required": false }, "video_resume": { "default": false, "description": "Video Resume", "type": "boolean", "required": false }, "assignment_upload_enabled": { "default": false, "description": "Lesson Assignment Uploads Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_extensions": { "default": "", "description": "Lesson Assignment Allowed file extensions. Comma separated pdf, xls, zip", "type": "text", "required": false }, "assignment_upload_limit_size": { "default": "", "description": "Lesson Assignment Upload size limit. Max per server is 32M ", "type": "text", "required": false }, "assignment_points_enabled": { "default": false, "description": "Lesson Assignment Points Enabled", "type": "boolean", "required": false }, "assignment_points_amount": { "default": 0, "description": "Lesson Assignment Points Amount", "type": "integer", "required": false }, "assignment_auto_approve": { "default": true, "description": "Lesson Assignment Auto-approve Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "default": 0, "description": "Lesson Assignment Upload Count Limit.", "type": "integer", "required": false }, "assignment_deletion_enabled": { "default": false, "description": "Lesson Assignment Allow File Deletion.", "type": "boolean", "required": false }, "forced_timer_enabled": { "default": false, "description": "Lesson Time Enabled", "type": "boolean", "required": false }, "forced_timer_amount": { "default": 0, "description": "Lesson Timer Amount.", "type": "integer", "required": false }, "course": { "default": 0, "description": "Associated Course", "type": "integer", "required": false }, "is_sample": { "default": false, "description": "Sample Lesson", "type": "boolean", "required": false }, "visible_type": { "default": "", "description": "Available Release Schedule", "type": "string", "enum": [ "", "visible_after", "visible_after_specific_date" ], "required": false }, "visible_after": { "default": 0, "description": "Visible After X day(s)", "type": "integer", "required": false }, "visible_after_specific_date": { "default": "", "description": "Visible After Specific Date (YYYY-MM-DD)", "type": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/sfwd-lessons" } ] } }, "\/ldlms\/v2\/sfwd-lessons\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_lesson_category": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag": { "description": "Limit result set to items with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_lesson_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_lesson_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_lesson_category": { "description": "The terms assigned to the object in the ld_lesson_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_lesson_tag": { "description": "The terms assigned to the object in the ld_lesson_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "video_enabled": { "description": "Lesson Video Progression Enabled", "type": "boolean", "required": false }, "video_url": { "description": "Lesson Video Progression URL", "type": "text", "required": false }, "video_shown": { "description": "Lesson Video Shown before or after sub-steps", "type": "string", "enum": [ "BEFORE", "AFTER" ], "required": false }, "video_auto_complete": { "description": "Lesson Video Auto-complete", "type": "boolean", "required": false }, "video_auto_complete_delay": { "description": "Lesson Video Completion Delay (seconds).", "type": "integer", "required": false }, "video_show_complete_button": { "description": "Lesson Video Show Mark Complete Button", "type": "boolean", "required": false }, "video_auto_start": { "description": "Lesson Video Autostart", "type": "boolean", "required": false }, "video_show_controls": { "description": "Lesson Video Controls Display. YouTube and local videos only", "type": "boolean", "required": false }, "video_focus_pause": { "description": "Video Pause on Window Unfocused", "type": "boolean", "required": false }, "video_resume": { "description": "Video Resume", "type": "boolean", "required": false }, "assignment_upload_enabled": { "description": "Lesson Assignment Uploads Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_extensions": { "description": "Lesson Assignment Allowed file extensions. Comma separated pdf, xls, zip", "type": "text", "required": false }, "assignment_upload_limit_size": { "description": "Lesson Assignment Upload size limit. Max per server is 32M ", "type": "text", "required": false }, "assignment_points_enabled": { "description": "Lesson Assignment Points Enabled", "type": "boolean", "required": false }, "assignment_points_amount": { "description": "Lesson Assignment Points Amount", "type": "integer", "required": false }, "assignment_auto_approve": { "description": "Lesson Assignment Auto-approve Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "description": "Lesson Assignment Upload Count Limit.", "type": "integer", "required": false }, "assignment_deletion_enabled": { "description": "Lesson Assignment Allow File Deletion.", "type": "boolean", "required": false }, "forced_timer_enabled": { "description": "Lesson Time Enabled", "type": "boolean", "required": false }, "forced_timer_amount": { "description": "Lesson Timer Amount.", "type": "integer", "required": false }, "course": { "description": "Associated Course", "type": "integer", "required": false }, "is_sample": { "description": "Sample Lesson", "type": "boolean", "required": false }, "visible_type": { "description": "Available Release Schedule", "type": "string", "enum": [ "", "visible_after", "visible_after_specific_date" ], "required": false }, "visible_after": { "description": "Visible After X day(s)", "type": "integer", "required": false }, "visible_after_specific_date": { "description": "Visible After Specific Date (YYYY-MM-DD)", "type": "date", "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-topic": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_topic_category": { "description": "Limit result set to items with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag": { "description": "Limit result set to items with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_topic_category": { "description": "The terms assigned to the object in the ld_topic_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_topic_tag": { "description": "The terms assigned to the object in the ld_topic_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "default": false, "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "video_enabled": { "default": false, "description": "Topic Video Progression Enabled", "type": "boolean", "required": false }, "video_url": { "default": "", "description": "Topic Video Progression URL", "type": "text", "required": false }, "video_shown": { "default": "BEFORE", "description": "Topic Video Shown before or after sub-steps", "type": "string", "enum": [ "BEFORE", "AFTER" ], "required": false }, "video_auto_complete": { "default": false, "description": "Topic Video Auto-complete", "type": "boolean", "required": false }, "video_auto_complete_delay": { "default": 0, "description": "Topic Video Completion Delay (seconds).", "type": "integer", "required": false }, "video_show_complete_button": { "default": false, "description": "Topic Video Show Mark Complete Button", "type": "boolean", "required": false }, "video_auto_start": { "default": false, "description": "Topic Video Autostart", "type": "boolean", "required": false }, "video_show_controls": { "default": false, "description": "Topic Video Controls Display. YouTube and local videos only", "type": "boolean", "required": false }, "video_focus_pause": { "default": false, "description": "Video Pause on Window Unfocused", "type": "boolean", "required": false }, "video_resume": { "default": false, "description": "Video Resume", "type": "boolean", "required": false }, "assignment_upload_enabled": { "default": false, "description": "Topic Assignment Uploads Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_extensions": { "default": "", "description": "Topic Assignment Allowed file extensions. Comma separated pdf, xls, zip", "type": "text", "required": false }, "assignment_upload_limit_size": { "default": "", "description": "Topic Assignment Upload size limit. Max per server is 32M ", "type": "text", "required": false }, "assignment_points_enabled": { "default": false, "description": "Topic Assignment Points Enabled", "type": "boolean", "required": false }, "assignment_points_amount": { "default": 0, "description": "Topic Assignment Points Amount", "type": "integer", "required": false }, "assignment_auto_approve": { "default": true, "description": "Topic Assignment Auto-approve Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "default": 0, "description": "Topic Assignment Upload Count Limit.", "type": "integer", "required": false }, "assignment_deletion_enabled": { "default": false, "description": "Topic Assignment Allow File Deletion.", "type": "boolean", "required": false }, "forced_timer_enabled": { "default": false, "description": "Topic Time Enabled", "type": "boolean", "required": false }, "forced_timer_amount": { "default": 0, "description": "Topic Timer Amount.", "type": "integer", "required": false }, "course": { "default": 0, "description": "Associated Course", "type": "integer", "required": false }, "lesson": { "default": 0, "description": "Associated Lesson", "type": "integer", "required": false }, "visible_type": { "default": "", "description": "Available Release Schedule", "type": "string", "enum": [ "", "visible_after", "visible_after_specific_date" ], "required": false }, "visible_after": { "default": 0, "description": "Visible After X day(s)", "type": "integer", "required": false }, "visible_after_specific_date": { "default": "", "description": "Visible After Specific Date (YYYY-MM-DD)", "type": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/sfwd-topic" } ] } }, "\/ldlms\/v2\/sfwd-topic\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_topic_category": { "description": "Limit result set to items with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag": { "description": "Limit result set to items with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_topic_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_topic_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "ld_topic_category": { "description": "The terms assigned to the object in the ld_topic_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_topic_tag": { "description": "The terms assigned to the object in the ld_topic_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "video_enabled": { "description": "Topic Video Progression Enabled", "type": "boolean", "required": false }, "video_url": { "description": "Topic Video Progression URL", "type": "text", "required": false }, "video_shown": { "description": "Topic Video Shown before or after sub-steps", "type": "string", "enum": [ "BEFORE", "AFTER" ], "required": false }, "video_auto_complete": { "description": "Topic Video Auto-complete", "type": "boolean", "required": false }, "video_auto_complete_delay": { "description": "Topic Video Completion Delay (seconds).", "type": "integer", "required": false }, "video_show_complete_button": { "description": "Topic Video Show Mark Complete Button", "type": "boolean", "required": false }, "video_auto_start": { "description": "Topic Video Autostart", "type": "boolean", "required": false }, "video_show_controls": { "description": "Topic Video Controls Display. YouTube and local videos only", "type": "boolean", "required": false }, "video_focus_pause": { "description": "Video Pause on Window Unfocused", "type": "boolean", "required": false }, "video_resume": { "description": "Video Resume", "type": "boolean", "required": false }, "assignment_upload_enabled": { "description": "Topic Assignment Uploads Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_extensions": { "description": "Topic Assignment Allowed file extensions. Comma separated pdf, xls, zip", "type": "text", "required": false }, "assignment_upload_limit_size": { "description": "Topic Assignment Upload size limit. Max per server is 32M ", "type": "text", "required": false }, "assignment_points_enabled": { "description": "Topic Assignment Points Enabled", "type": "boolean", "required": false }, "assignment_points_amount": { "description": "Topic Assignment Points Amount", "type": "integer", "required": false }, "assignment_auto_approve": { "description": "Topic Assignment Auto-approve Enabled", "type": "boolean", "required": false }, "assignment_upload_limit_count": { "description": "Topic Assignment Upload Count Limit.", "type": "integer", "required": false }, "assignment_deletion_enabled": { "description": "Topic Assignment Allow File Deletion.", "type": "boolean", "required": false }, "forced_timer_enabled": { "description": "Topic Time Enabled", "type": "boolean", "required": false }, "forced_timer_amount": { "description": "Topic Timer Amount.", "type": "integer", "required": false }, "course": { "description": "Associated Course", "type": "integer", "required": false }, "lesson": { "description": "Associated Lesson", "type": "integer", "required": false }, "visible_type": { "description": "Available Release Schedule", "type": "string", "enum": [ "", "visible_after", "visible_after_specific_date" ], "required": false }, "visible_after": { "description": "Visible After X day(s)", "type": "integer", "required": false }, "visible_after_specific_date": { "description": "Visible After Specific Date (YYYY-MM-DD)", "type": "date", "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-quiz": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Pass zero to show global Course Quizzes. Must be used with Course parameter.", "type": "integer", "required": false }, "topic": { "description": "Limit results to be within a specific Topic. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "course": { "default": 0, "description": "Associated Course", "type": "integer", "required": false }, "lesson": { "default": 0, "description": "Associated Lesson", "type": "integer", "required": false }, "visible_type": { "default": "", "description": "Available Release Schedule", "type": "string", "enum": [ "", "visible_after", "visible_after_specific_date" ], "required": false }, "visible_after": { "default": 0, "description": "Visible After X day(s)", "type": "integer", "required": false }, "visible_after_specific_date": { "default": "", "description": "Visible After Specific Date (YYYY-MM-DD)", "type": "date", "required": false }, "prerequisites": { "default": [], "description": "Quiz Prerequisites", "type": "array", "items": { "type": "integer" }, "required": false }, "registered_users_only": { "default": false, "description": "Allowed Users", "type": "boolean", "required": false }, "passing_percentage": { "default": 0, "description": "Passing Score Percentage", "type": "float", "required": false }, "certificate": { "default": 0, "description": "Quiz Certificate", "type": "integer", "required": false }, "certificate_award_threshold": { "default": 0, "description": "Certificate Awarded for", "type": "float", "required": false }, "quiz_resume": { "default": false, "description": "Enable Quiz Saving", "type": "boolean", "required": false }, "quiz_resume_cookie_send_timer": { "default": 20, "description": "Save cookie data to the server every", "type": "integer", "required": false }, "retry_restrictions_enabled": { "default": false, "description": "Restrict Quiz Retakes", "type": "boolean", "required": false }, "retry_repeats": { "default": "", "description": "Number of repeats allowed. blank is unlimited, 0 is 1 repeats, 1 is 2 repeats, etc.", "type": "string", "required": false }, "answer_all_questions_enabled": { "default": true, "description": "All Questions required to complete", "type": "boolean", "required": false }, "time_limit_enabled": { "default": false, "description": "Time Limit Enabled", "type": "boolean", "required": false }, "time_limit_time": { "default": 0, "description": "Automatically Submit After", "type": "integer", "required": false }, "materials_enabled": { "default": false, "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "auto_start": { "default": false, "description": "Autostart", "type": "boolean", "required": false }, "quiz_modus": { "default": "single", "description": "Question Display", "type": "string", "enum": [ "single", "multiple" ], "required": false }, "review_table_enabled": { "default": false, "description": "Question Overview Table", "type": "boolean", "required": false }, "summary_hide": { "default": false, "description": "Quiz Summary", "type": "boolean", "required": false }, "skip_question_disabled": { "default": false, "description": "Skip Question", "type": "boolean", "required": false }, "custom_sorting": { "default": false, "description": "Custom Question Ordering", "type": "boolean", "required": false }, "sort_categories": { "default": false, "description": "Sort by Category", "type": "boolean", "required": false }, "question_random": { "default": false, "description": "Randomize Order", "type": "boolean", "required": false }, "show_max_question": { "default": false, "description": "", "type": "boolean", "required": false }, "show_points": { "default": false, "description": "Point Value", "type": "boolean", "required": false }, "show_category": { "default": false, "description": "Question Category", "type": "boolean", "required": false }, "hide_question_position_overview": { "default": false, "description": "Question Position", "type": "boolean", "required": false }, "hide_question_numbering": { "default": false, "description": "Question Numbering", "type": "boolean", "required": false }, "numbered_answer": { "default": false, "description": "Number Answers", "type": "boolean", "required": false }, "answer_random": { "default": false, "description": "Randomize Answers", "type": "boolean", "required": false }, "title_hidden": { "default": false, "description": "Quiz Title", "type": "boolean", "required": false }, "restart_button_hide": { "default": true, "description": "Restart Quiz button", "type": "boolean", "required": false }, "show_average_result": { "default": true, "description": "Average Score", "type": "boolean", "required": false }, "show_category_score": { "default": true, "description": "Category Score", "type": "boolean", "required": false }, "hide_result_points": { "default": true, "description": "Overall Score", "type": "boolean", "required": false }, "hide_result_correct_question": { "default": true, "description": "No. of Correct Answers", "type": "boolean", "required": false }, "hide_result_quiz_time": { "default": true, "description": "Time Spent", "type": "boolean", "required": false }, "custom_answer_feedback": { "default": true, "description": "Custom Answer Feedback", "type": "boolean", "required": false }, "hide_answer_message_box": { "default": true, "description": "Correct \/ Incorrect Messages", "type": "boolean", "required": false }, "disabled_answer_mark": { "default": true, "description": "Correct \/ Incorrect Answer Marks", "type": "boolean", "required": false }, "view_question_button_hidden": { "default": true, "description": "View Questions Button", "type": "boolean", "required": false }, "toplist_enabled": { "default": false, "description": "Leaderboard", "type": "boolean", "required": false }, "toplist_data_add_permissions": { "default": "1", "description": "Who can apply?", "type": "string", "enum": [ "1", "2", "3" ], "required": false }, "toplist_data_add_multiple": { "default": false, "description": "Multiple Applications per user", "type": "boolean", "required": false }, "toplist_data_add_automatic": { "default": false, "description": "Automatic user entry", "type": "boolean", "required": false }, "toplist_data_show_limit": { "default": 10, "description": "Number of displayed entries", "type": "integer", "required": false }, "toplist_data_sort": { "default": "1", "description": "Sort list by?", "type": "string", "enum": [ "1", "2", "3" ], "required": false }, "toplist_data_showin_enabled": { "default": false, "description": "Display on Quiz results page", "type": "boolean", "required": false }, "statistics_enabled": { "default": true, "description": "Quiz Statistics", "type": "boolean", "required": false }, "view_profile_statistics_enabled": { "default": true, "description": "Front-end Profile Display", "type": "boolean", "required": false }, "statistics_ip_lock_enabled": { "default": false, "description": "Statistics IP-lock", "type": "boolean", "required": false }, "email_enabled": { "default": false, "description": "Email Notifications", "type": "boolean", "required": false }, "email_admin_enabled": { "default": false, "description": "Admin", "type": "boolean", "required": false }, "email_user_enabled": { "default": false, "description": "User", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/sfwd-quiz" } ] } }, "\/ldlms\/v2\/sfwd-quiz\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Pass zero to show global Course Quizzes. Must be used with Course parameter.", "type": "integer", "required": false }, "topic": { "description": "Limit results to be within a specific Topic. Must be used with Course parameter.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "course": { "description": "Associated Course", "type": "integer", "required": false }, "lesson": { "description": "Associated Lesson", "type": "integer", "required": false }, "visible_type": { "description": "Available Release Schedule", "type": "string", "enum": [ "", "visible_after", "visible_after_specific_date" ], "required": false }, "visible_after": { "description": "Visible After X day(s)", "type": "integer", "required": false }, "visible_after_specific_date": { "description": "Visible After Specific Date (YYYY-MM-DD)", "type": "date", "required": false }, "prerequisites": { "description": "Quiz Prerequisites", "type": "array", "items": { "type": "integer" }, "required": false }, "registered_users_only": { "description": "Allowed Users", "type": "boolean", "required": false }, "passing_percentage": { "description": "Passing Score Percentage", "type": "float", "required": false }, "certificate": { "description": "Quiz Certificate", "type": "integer", "required": false }, "certificate_award_threshold": { "description": "Certificate Awarded for", "type": "float", "required": false }, "quiz_resume": { "description": "Enable Quiz Saving", "type": "boolean", "required": false }, "quiz_resume_cookie_send_timer": { "description": "Save cookie data to the server every", "type": "integer", "required": false }, "retry_restrictions_enabled": { "description": "Restrict Quiz Retakes", "type": "boolean", "required": false }, "retry_repeats": { "description": "Number of repeats allowed. blank is unlimited, 0 is 1 repeats, 1 is 2 repeats, etc.", "type": "string", "required": false }, "answer_all_questions_enabled": { "description": "All Questions required to complete", "type": "boolean", "required": false }, "time_limit_enabled": { "description": "Time Limit Enabled", "type": "boolean", "required": false }, "time_limit_time": { "description": "Automatically Submit After", "type": "integer", "required": false }, "materials_enabled": { "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "auto_start": { "description": "Autostart", "type": "boolean", "required": false }, "quiz_modus": { "description": "Question Display", "type": "string", "enum": [ "single", "multiple" ], "required": false }, "review_table_enabled": { "description": "Question Overview Table", "type": "boolean", "required": false }, "summary_hide": { "description": "Quiz Summary", "type": "boolean", "required": false }, "skip_question_disabled": { "description": "Skip Question", "type": "boolean", "required": false }, "custom_sorting": { "description": "Custom Question Ordering", "type": "boolean", "required": false }, "sort_categories": { "description": "Sort by Category", "type": "boolean", "required": false }, "question_random": { "description": "Randomize Order", "type": "boolean", "required": false }, "show_max_question": { "description": "", "type": "boolean", "required": false }, "show_points": { "description": "Point Value", "type": "boolean", "required": false }, "show_category": { "description": "Question Category", "type": "boolean", "required": false }, "hide_question_position_overview": { "description": "Question Position", "type": "boolean", "required": false }, "hide_question_numbering": { "description": "Question Numbering", "type": "boolean", "required": false }, "numbered_answer": { "description": "Number Answers", "type": "boolean", "required": false }, "answer_random": { "description": "Randomize Answers", "type": "boolean", "required": false }, "title_hidden": { "description": "Quiz Title", "type": "boolean", "required": false }, "restart_button_hide": { "description": "Restart Quiz button", "type": "boolean", "required": false }, "show_average_result": { "description": "Average Score", "type": "boolean", "required": false }, "show_category_score": { "description": "Category Score", "type": "boolean", "required": false }, "hide_result_points": { "description": "Overall Score", "type": "boolean", "required": false }, "hide_result_correct_question": { "description": "No. of Correct Answers", "type": "boolean", "required": false }, "hide_result_quiz_time": { "description": "Time Spent", "type": "boolean", "required": false }, "custom_answer_feedback": { "description": "Custom Answer Feedback", "type": "boolean", "required": false }, "hide_answer_message_box": { "description": "Correct \/ Incorrect Messages", "type": "boolean", "required": false }, "disabled_answer_mark": { "description": "Correct \/ Incorrect Answer Marks", "type": "boolean", "required": false }, "view_question_button_hidden": { "description": "View Questions Button", "type": "boolean", "required": false }, "toplist_enabled": { "description": "Leaderboard", "type": "boolean", "required": false }, "toplist_data_add_permissions": { "description": "Who can apply?", "type": "string", "enum": [ "1", "2", "3" ], "required": false }, "toplist_data_add_multiple": { "description": "Multiple Applications per user", "type": "boolean", "required": false }, "toplist_data_add_automatic": { "description": "Automatic user entry", "type": "boolean", "required": false }, "toplist_data_show_limit": { "description": "Number of displayed entries", "type": "integer", "required": false }, "toplist_data_sort": { "description": "Sort list by?", "type": "string", "enum": [ "1", "2", "3" ], "required": false }, "toplist_data_showin_enabled": { "description": "Display on Quiz results page", "type": "boolean", "required": false }, "statistics_enabled": { "description": "Quiz Statistics", "type": "boolean", "required": false }, "view_profile_statistics_enabled": { "description": "Front-end Profile Display", "type": "boolean", "required": false }, "statistics_ip_lock_enabled": { "description": "Statistics IP-lock", "type": "boolean", "required": false }, "email_enabled": { "description": "Email Notifications", "type": "boolean", "required": false }, "email_admin_enabled": { "description": "Admin", "type": "boolean", "required": false }, "email_user_enabled": { "description": "User", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-essays": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "any", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "graded", "not_graded" ], "type": "string" }, "required": false }, "course": { "description": "Filter by Course ID", "type": "integer", "required": false }, "lesson": { "description": "Filter by Lesson ID", "type": "integer", "default": 0, "required": false }, "topic": { "description": "Filter by Topic ID", "type": "integer", "default": 0, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/sfwd-essays" } ] } }, "\/ldlms\/v2\/sfwd-essays\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "any", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "graded", "not_graded" ], "type": "string" }, "required": false }, "course": { "description": "Filter by Course ID", "type": "integer", "required": false }, "lesson": { "description": "Filter by Lesson ID", "type": "integer", "default": 0, "required": false }, "topic": { "description": "Filter by Topic ID", "type": "integer", "default": 0, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string", "enum": [ "open", "closed" ], "required": false }, "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string", "enum": [ "open", "closed" ], "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "course": { "description": "Course ID", "type": "integer", "required": false }, "lesson": { "description": "Lesson ID", "type": "integer", "required": false }, "topic": { "description": "Topic ID", "type": "integer", "required": false }, "points_max": { "description": "Essay Points Maximum", "type": "integer", "required": false }, "points_awarded": { "description": "Essay Points Awarded", "type": "integer", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-question": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "quiz": { "default": "", "description": "Quiz ID.", "type": "integer", "required": false }, "question_type": { "default": "single", "description": "Question type.", "type": "enum", "enum": [ "single", "multiple", "free_answer", "sort_answer", "matrix_sort_answer", "cloze_answer", "assessment_answer", "essay" ], "required": false }, "points_total": { "default": "", "description": "Total Points amount", "type": "integer", "required": false }, "points_per_answer": { "default": "", "description": "Different points for each answer", "type": "boolean", "required": false }, "points_show_in_message": { "default": "", "description": "Show reached points in the correct\/incorrect message?", "type": "boolean", "required": false }, "points_diff_modus": { "default": "", "description": "Different points - modus 2 activate", "type": "boolean", "required": false }, "disable_correct": { "default": "", "description": "Disable answer correct setting.", "type": "boolean", "required": false }, "correct_message": { "description": "Message shown when Question is correct.", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "incorrect_message": { "description": "Message shown when Question is correct.", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "correct_same": { "default": "", "description": "Activate hint for this Question.", "type": "boolean", "required": false }, "hints_enabled": { "default": "", "description": "Activate hint for this Question.", "type": "boolean", "required": false }, "hints_message": { "description": "Hint message.", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "answers": { "description": "Question answer sets.", "type": "object", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/sfwd-question" } ] } }, "\/ldlms\/v2\/sfwd-question\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "quiz": { "description": "Quiz ID.", "type": "integer", "required": false }, "question_type": { "description": "Question type.", "type": "enum", "enum": [ "single", "multiple", "free_answer", "sort_answer", "matrix_sort_answer", "cloze_answer", "assessment_answer", "essay" ], "required": false }, "points_total": { "description": "Total Points amount", "type": "integer", "required": false }, "points_per_answer": { "description": "Different points for each answer", "type": "boolean", "required": false }, "points_show_in_message": { "description": "Show reached points in the correct\/incorrect message?", "type": "boolean", "required": false }, "points_diff_modus": { "description": "Different points - modus 2 activate", "type": "boolean", "required": false }, "disable_correct": { "description": "Disable answer correct setting.", "type": "boolean", "required": false }, "correct_message": { "description": "Message shown when Question is correct.", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "incorrect_message": { "description": "Message shown when Question is correct.", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "correct_same": { "description": "Activate hint for this Question.", "type": "boolean", "required": false }, "hints_enabled": { "description": "Activate hint for this Question.", "type": "boolean", "required": false }, "hints_message": { "description": "Hint message.", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "answers": { "description": "Question answer sets.", "type": "object", "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-assignment": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "any", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "graded", "not_graded" ], "type": "string" }, "required": false }, "course": { "description": "Filter by Course ID", "type": "integer", "required": false }, "lesson": { "description": "Filter by Lesson ID", "type": "integer", "default": 0, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/sfwd-assignment" } ] } }, "\/ldlms\/v2\/sfwd-assignment\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "any", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "graded", "not_graded" ], "type": "string" }, "required": false }, "course": { "description": "Filter by Course ID", "type": "integer", "required": false }, "lesson": { "description": "Filter by Lesson ID", "type": "integer", "default": 0, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string", "enum": [ "open", "closed" ], "required": false }, "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string", "enum": [ "open", "closed" ], "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "course": { "description": "Course ID", "type": "integer", "required": false }, "lesson": { "description": "Lesson ID", "type": "integer", "required": false }, "topic": { "description": "Topic ID", "type": "integer", "required": false }, "approved_status": { "description": "Assignment Approved Status", "type": "string", "enum": [ "", "approved", "not_approved" ], "required": false }, "points_enabled": { "description": "Assignment Points Enabled", "type": "boolean", "required": false }, "points_max": { "description": "Assignment Points Maximum", "type": "integer", "required": false }, "points_awarded": { "description": "Assignment Points Awarded", "type": "integer", "required": false } } } ] }, "\/ldlms\/v2\/groups": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "categories": { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "tags": { "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "ld_group_category": { "description": "Limit result set to items with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_group_tag": { "description": "Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "default": false, "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "certificate": { "default": 0, "description": "Group Certificate", "type": "integer", "required": false }, "disable_content_table": { "default": false, "description": "Group Content", "type": "boolean", "required": false }, "courses_per_page_custom": { "default": 0, "description": "Courses per page", "type": "integer", "required": false }, "courses_orderby": { "default": "", "description": "Sort By", "type": "string", "required": false }, "courses_order": { "default": "", "description": "Order Direction", "type": "string", "required": false }, "price_type": { "default": "closed", "description": "Group Price Type", "type": "string", "enum": [ "closed", "free", "paynow", "subscribe" ], "required": false }, "price_type_paynow_price": { "default": "", "description": "Pay Now Group Price", "type": "string", "required": false }, "group_price_type_paynow_enrollment_url": { "default": "", "description": "Pay Now group Enrollment URL", "type": "string", "required": false }, "price_type_subscribe_price": { "default": "", "description": "Subscribe Group Price", "type": "string", "required": false }, "trial_price": { "default": "", "description": "Group Trial Price", "type": "string", "required": false }, "group_price_type_subscribe_enrollment_url": { "default": "", "description": "Pay Now group Enrollment URL", "type": "string", "required": false }, "price_type_closed_price": { "default": "", "description": "Closed Group Price", "type": "string", "required": false }, "price_type_closed_custom_button_url": { "default": "", "description": "Closed Group Button URL", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/groups" } ] } }, "\/ldlms\/v2\/groups\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "categories": { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "tags": { "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "ld_group_category": { "description": "Limit result set to items with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_group_tag": { "description": "Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "author": { "description": "The ID for the author of the post.", "type": "integer", "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_category": { "description": "The terms assigned to the object in the ld_group_category taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "ld_group_tag": { "description": "The terms assigned to the object in the ld_group_tag taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "materials_enabled": { "description": "Materials Enabled", "type": "boolean", "required": false }, "materials": { "description": "Materials", "type": "object", "properties": { "raw": { "description": "Content for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the object, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "certificate": { "description": "Group Certificate", "type": "integer", "required": false }, "disable_content_table": { "description": "Group Content", "type": "boolean", "required": false }, "courses_per_page_custom": { "description": "Courses per page", "type": "integer", "required": false }, "courses_orderby": { "description": "Sort By", "type": "string", "required": false }, "courses_order": { "description": "Order Direction", "type": "string", "required": false }, "price_type": { "description": "Group Price Type", "type": "string", "enum": [ "closed", "free", "paynow", "subscribe" ], "required": false }, "price_type_paynow_price": { "description": "Pay Now Group Price", "type": "string", "required": false }, "group_price_type_paynow_enrollment_url": { "description": "Pay Now group Enrollment URL", "type": "string", "required": false }, "price_type_subscribe_price": { "description": "Subscribe Group Price", "type": "string", "required": false }, "trial_price": { "description": "Group Trial Price", "type": "string", "required": false }, "group_price_type_subscribe_enrollment_url": { "description": "Pay Now group Enrollment URL", "type": "string", "required": false }, "price_type_closed_price": { "description": "Closed Group Price", "type": "string", "required": false }, "price_type_closed_custom_button_url": { "description": "Closed Group Button URL", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/ldlms\/v2\/groups\/(?P[\\d]+)\/courses": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_course_category": { "description": "Limit result set to items with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_course_tag": { "description": "Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "course_ids": { "description": "Course IDs to add to Group.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "course_ids": { "description": "Course IDs to remove from Group.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v2\/groups\/(?P[\\d]+)\/leaders": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "name", "description": "Sort collection by user attribute.", "enum": [ "id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url" ], "type": "string", "required": false }, "slug": { "description": "Limit result set to users with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "roles": { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "type": "array", "items": { "type": "string" }, "required": false }, "capabilities": { "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", "type": "array", "items": { "type": "string" }, "required": false }, "who": { "description": "Limit result set to users who are considered authors.", "type": "string", "enum": [ "authors" ], "required": false }, "has_published_posts": { "description": "Limit result set to users who have published posts.", "type": [ "boolean", "array" ], "items": { "type": "string", "enum": { "post": "post", "page": "page", "attachment": "attachment", "nav_menu_item": "nav_menu_item", "wp_block": "wp_block", "wp_template": "wp_template", "wp_template_part": "wp_template_part", "wp_global_styles": "wp_global_styles", "wp_navigation": "wp_navigation", "wp_font_family": "wp_font_family", "wp_font_face": "wp_font_face", "elementor_library": "elementor_library", "product": "product", "sfwd-courses": "sfwd-courses", "sfwd-lessons": "sfwd-lessons", "sfwd-topic": "sfwd-topic", "sfwd-quiz": "sfwd-quiz", "sfwd-question": "sfwd-question", "ld-exam": "ld-exam", "sfwd-certificates": "sfwd-certificates", "groups": "groups", "bp-group-type": "bp-group-type", "bp-invite": "bp-invite", "bp-member-type": "bp-member-type", "points-type": "points-type", "points-award": "points-award", "points-deduct": "points-deduct", "achievement-type": "achievement-type", "step": "step", "rank-type": "rank-type", "rank-requirement": "rank-requirement", "bl": "bl", "guru": "guru", "ml": "ml", "pl": "pl", "level-rank": "level-rank", "test": "test", "mailpoet_email": "mailpoet_email", "sfwd-essays": "sfwd-essays", "sfwd-assignment": "sfwd-assignment", "tribe_rsvp_tickets": "tribe_rsvp_tickets", "tribe_tpp_tickets": "tribe_tpp_tickets", "tribe_venue": "tribe_venue", "tribe_organizer": "tribe_organizer", "tribe_events": "tribe_events", "jet-engine": "jet-engine" } }, "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "email", "name", "id", "username", "slug" ], "type": "string" }, "required": false }, "solid_user_groups": { "type": "array", "items": { "type": "string", "format": "uuid" }, "required": false }, "solid_last_seen": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time" }, "before": { "type": "string", "format": "date-time" } }, "required": false }, "solid_password_changed": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time" }, "before": { "type": "string", "format": "date-time" } }, "required": false }, "solid_password_strength": { "type": "array", "items": { "type": "integer", "oneOf": [ { "enum": [ 0 ], "title": "Very Weak" }, { "enum": [ 1 ], "title": "Very Weak" }, { "enum": [ 2 ], "title": "Weak" }, { "enum": [ 3 ], "title": "Medium" }, { "enum": [ 4 ], "title": "Strong" } ] }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "user_ids": { "description": "Group Leader User IDs to enroll into Group", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "user_ids": { "description": "Group Leader User IDs to remove from Group", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v2\/groups\/(?P[\\d]+)\/users": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "name", "description": "Sort collection by user attribute.", "enum": [ "id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url" ], "type": "string", "required": false }, "slug": { "description": "Limit result set to users with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "roles": { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "type": "array", "items": { "type": "string" }, "required": false }, "capabilities": { "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", "type": "array", "items": { "type": "string" }, "required": false }, "who": { "description": "Limit result set to users who are considered authors.", "type": "string", "enum": [ "authors" ], "required": false }, "has_published_posts": { "description": "Limit result set to users who have published posts.", "type": [ "boolean", "array" ], "items": { "type": "string", "enum": { "post": "post", "page": "page", "attachment": "attachment", "nav_menu_item": "nav_menu_item", "wp_block": "wp_block", "wp_template": "wp_template", "wp_template_part": "wp_template_part", "wp_global_styles": "wp_global_styles", "wp_navigation": "wp_navigation", "wp_font_family": "wp_font_family", "wp_font_face": "wp_font_face", "elementor_library": "elementor_library", "product": "product", "sfwd-courses": "sfwd-courses", "sfwd-lessons": "sfwd-lessons", "sfwd-topic": "sfwd-topic", "sfwd-quiz": "sfwd-quiz", "sfwd-question": "sfwd-question", "ld-exam": "ld-exam", "sfwd-certificates": "sfwd-certificates", "groups": "groups", "bp-group-type": "bp-group-type", "bp-invite": "bp-invite", "bp-member-type": "bp-member-type", "points-type": "points-type", "points-award": "points-award", "points-deduct": "points-deduct", "achievement-type": "achievement-type", "step": "step", "rank-type": "rank-type", "rank-requirement": "rank-requirement", "bl": "bl", "guru": "guru", "ml": "ml", "pl": "pl", "level-rank": "level-rank", "test": "test", "mailpoet_email": "mailpoet_email", "sfwd-essays": "sfwd-essays", "sfwd-assignment": "sfwd-assignment", "tribe_rsvp_tickets": "tribe_rsvp_tickets", "tribe_tpp_tickets": "tribe_tpp_tickets", "tribe_venue": "tribe_venue", "tribe_organizer": "tribe_organizer", "tribe_events": "tribe_events", "jet-engine": "jet-engine" } }, "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "email", "name", "id", "username", "slug" ], "type": "string" }, "required": false }, "solid_user_groups": { "type": "array", "items": { "type": "string", "format": "uuid" }, "required": false }, "solid_last_seen": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time" }, "before": { "type": "string", "format": "date-time" } }, "required": false }, "solid_password_changed": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time" }, "before": { "type": "string", "format": "date-time" } }, "required": false }, "solid_password_strength": { "type": "array", "items": { "type": "integer", "oneOf": [ { "enum": [ 0 ], "title": "Very Weak" }, { "enum": [ 1 ], "title": "Very Weak" }, { "enum": [ 2 ], "title": "Weak" }, { "enum": [ 3 ], "title": "Medium" }, { "enum": [ 4 ], "title": "Strong" } ] }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to enroll into Group.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Group ID", "type": "integer", "required": true }, "user_ids": { "description": "User IDs to remove from Group.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v2\/users\/(?P[\\d]+)\/courses": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "type": "integer", "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "ld_course_category": { "description": "Limit result set to items with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_course_tag": { "description": "Limit result set to items with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_course_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_course_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "course_ids": { "description": "Course IDs to add to User.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "course_ids": { "description": "Course IDs to remove from User.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v2\/users\/(?P[\\d]+)\/groups": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "author": { "description": "Limit result set to posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "author_exclude": { "description": "Ensure result set excludes posts assigned to specific authors.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "title", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "type": "string", "enum": [ "AND", "OR" ], "required": false }, "categories": { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "tags": { "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false }, "ld_group_category": { "description": "Limit result set to items with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_category taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ], "required": false }, "ld_group_tag": { "description": "Limit result set to items with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ], "required": false }, "ld_group_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the ld_group_tag taxonomy.", "type": [ "object", "array" ], "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to add to User.", "type": "array", "items": { "type": "integer" }, "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "group_ids": { "description": "Group IDs to remove from User.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/ldlms\/v2\/users\/(?P[\\d]+)\/course-progress": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false } } } ] }, "\/ldlms\/v2\/users\/(?P[\\d]+)\/course-progress\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false } } } ] }, "\/ldlms\/v2\/users\/(?P[\\d]+)\/course-progress\/(?P[\\d]+)\/steps": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "course": { "description": "Unique Course identifier for the object.", "type": "integer", "required": true } } } ] }, "\/ldlms\/v2\/users\/(?P[\\d]+)\/quiz-progress": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "User ID", "type": "integer", "required": true }, "quiz": { "description": "Limit results to be within a specific Quiz. Required for non-admin users.", "type": "integer", "required": false }, "course": { "description": "Limit results to be within a specific Course. Required for non-admin users.", "type": "integer", "required": false }, "lesson": { "description": "Limit results to be within a specific Lesson. Pass zero to show global Course Quizzes. Must be used with Course parameter.", "type": "integer", "required": false }, "topic": { "description": "Limit results to be within a specific Topic. Must be used with Course parameter.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "orderby": { "default": "taken", "enum": [ "taken", "title", "id", "date" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-quiz\/(?P[\\d]+)\/statistics": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "quiz": { "description": "Filter by Quiz ID", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "quiz", "user" ], "required": false }, "user": { "description": "Filter by User ID", "type": "integer", "required": false }, "after": { "description": "Limit response items after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to items before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false } } } ] }, "\/ldlms\/v2\/sfwd-quiz\/(?P[\\d]+)\/statistics\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "quiz": { "description": "Unique Quiz identifier for the object.", "type": "integer", "required": true } } } ] }, "\/ldlms\/v2\/sfwd-quiz\/(?P[\\d]+)\/statistics\/(?P[\\d]+)\/questions": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "quiz": { "description": "Unique Quiz identifier for the object.", "type": "integer", "required": true }, "statistic": { "description": "Unique Quiz Statistic identifier for the object.", "type": "integer", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false } } } ] }, "\/ldlms\/v2\/sfwd-quiz\/(?P[\\d]+)\/statistics\/(?P[\\d]+)\/questions\/(?P[\\w-]+)": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "quiz": { "description": "Unique Quiz identifier for the object.", "type": "integer", "required": true }, "statistic": { "description": "Unique Quiz Statistic identifier for the object.", "type": "integer", "required": true }, "id": { "description": "Unique Quiz Statistic Question identifier for the object.", "type": "text", "required": true } } } ] }, "\/ldlms\/v2\/sfwd-quiz\/(?P[\\d]+)\/form-entries": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false }, "user": { "description": "User ID", "type": "integer", "default": 0, "required": false }, "quiz": { "description": "Quiz ID", "type": "integer", "default": 0, "required": false }, "order": { "description": "Order", "type": "string", "default": "DESC", "enum": [ "ASC", "DESC" ], "required": false }, "orderby": { "description": "Order by", "type": "string", "default": "date", "enum": [ "date" ], "required": false } } } ] }, "\/ldlms\/v2\/echo": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] }, { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/echo" } ] } }, "\/ldlms\/v2\/price-types": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/price-types" } ] } }, "\/ldlms\/v2\/price-types\/(?P[\\w-]+)": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "An alphanumeric identifier for the price type.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ] }, "\/ldlms\/v2\/question-types": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/question-types" } ] } }, "\/ldlms\/v2\/question-types\/(?P[\\w-]+)": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "An alphanumeric identifier for the type", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ] }, "\/ldlms\/v2\/progress-status": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/progress-status" } ] } }, "\/ldlms\/v2\/progress-status\/(?P[\\w-]+)": { "namespace": "ldlms\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "An alphanumeric identifier for the progress status.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ] }, "\/ldlms\/v2\/exams": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ldlms\/v2\/exams" } ] } }, "\/ldlms\/v2\/exams\/(?P[\\d]+)": { "namespace": "ldlms\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "search_semantics": { "description": "How to interpret the search input.", "type": "string", "enum": [ "exact" ], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by post attribute.", "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "rand", "menu_order", "comment_count" ], "required": false }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "required": false }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "type": "array", "items": { "type": "string" }, "required": false }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "sent", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed", "any" ], "type": "string" }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "date": { "description": "The date the post was published, in the site's time zone.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time", "required": false }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string", "required": false }, "status": { "description": "A named status for the object.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "closed", "spam", "orphan", "hidden", "wc-pending", "wc-processing", "wc-on-hold", "wc-completed", "wc-cancelled", "wc-refunded", "wc-failed", "wc-checkout-draft", "flamingo-spam", "graded", "not_graded", "tribe-ea-success", "tribe-ea-failed", "tribe-ea-schedule", "tribe-ea-pending", "tribe-ea-draft", "tribe-ignored", "tribe-payout-hold", "tribe-payout-pending", "tribe-payout-paid", "tribe-payout-failed" ], "required": false }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string", "required": false }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the object, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML title for the object, transformed for display.", "type": "string", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string", "context": [ "edit" ] }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer", "context": [ "edit" ], "readonly": true }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean", "context": [ "view", "edit", "embed" ], "readonly": true } }, "required": false }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer", "required": false }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "_eb_attr": { "type": "string", "title": "", "description": "", "default": "" }, "_price": { "type": "string", "title": "", "description": "", "default": "" }, "_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_header": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_default_ticket_provider": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_capacity": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_start_date": { "type": "string", "title": "", "description": "", "default": "" }, "_ticket_end_date": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_description": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_show_not_going": { "type": "boolean", "title": "", "description": "", "default": false }, "_tribe_ticket_use_global_stock": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_global_stock_level": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_mode": { "type": "string", "title": "", "description": "", "default": "" }, "_global_stock_cap": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_rsvp_for_event": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_ticket_not_going_count": { "type": "string", "title": "", "description": "", "default": "" }, "_tribe_tickets_list": { "type": "array", "items": { "type": "number", "title": "", "description": "Numeric Array", "default": 0 } }, "_tribe_ticket_has_attendee_info_fields": { "type": "boolean", "title": "", "description": "", "default": false }, "footnotes": { "type": "string", "title": "", "description": "", "default": "" } }, "required": false }, "template": { "description": "The theme file to use to display the post.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Whether to bypass trash and force deletion.", "required": false } } } ] }, "\/tribe\/tickets\/v1": { "namespace": "tribe\/tickets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "tribe\/tickets\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/tickets\/v1" } ] } }, "\/tribe\/tickets\/v1\/doc": { "namespace": "tribe\/tickets\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/tickets\/v1\/doc" } ] } }, "\/tribe\/tickets\/v1\/tickets\/(?P\\d+)": { "namespace": "tribe\/tickets\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "description": "The ticket post ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "integer", "description": "The ticket post ID", "required": true }, "post_id": { "type": "integer", "required": true }, "edit_ticket_nonce": { "type": "string", "required": true }, "name": { "type": "string", "default": "", "required": false }, "description": { "type": "string", "default": "", "required": false }, "price": { "type": "string", "default": "", "required": false }, "show_description": { "type": "string", "default": "yes", "required": false }, "start_date": { "type": "string", "default": "", "required": false }, "start_time": { "type": "string", "default": "", "required": false }, "end_date": { "type": "string", "default": "", "required": false }, "end_time": { "type": "string", "default": "", "required": false }, "sku": { "type": "string", "default": "", "required": false }, "iac": { "type": "string", "default": "", "required": false }, "ticket": { "type": "object", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "description": "The ticket post ID", "required": true }, "post_id": { "type": "integer", "required": true }, "remove_ticket_nonce": { "type": "string", "required": true } } } ] }, "\/tribe\/tickets\/v1\/tickets": { "namespace": "tribe\/tickets\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "page": { "description": "The page of results to return; defaults to 1", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "How many tickets to return per results page; defaults to posts_per_page.", "type": "integer", "default": "10", "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to tickets containing the specified string in the title or description.", "type": "string", "required": false }, "offset": { "description": "Offset the results by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Sort results in ASC or DESC order. Defaults to ASC.", "type": "string", "enum": [ "ASC", "DESC" ], "required": false }, "orderby": { "description": "Order the results by one of date, relevance, id, include, title, or slug; defaults to title.", "type": "string", "enum": [ "id", "include", "title", "slug" ], "required": false }, "is_available": { "description": "Limit results to tickets that have or do not have capacity currently available.", "type": "boolean", "required": false }, "provider": { "description": "Limit results to tickets provided by one of the providers specified in the CSV list or array; defaults to all available.", "required": false }, "after": { "description": "Limit results to tickets created after or on the specified UTC date or timestamp.", "type": "string", "required": false }, "before": { "description": "Limit results to tickets created before or on the specified UTC date or timestamp.", "type": "string", "required": false }, "include": { "description": "Limit results to a specific CSV list or array of ticket IDs.", "required": false }, "exclude": { "description": "Exclude a specific CSV list or array of ticket IDs from the results.", "required": false }, "include_post": { "description": "Limit results to tickets that are assigned to one of the posts specified in the CSV list or array.", "required": false }, "exclude_post": { "description": "Limit results to tickets that are not assigned to any of the posts specified in the CSV list or array.", "required": false }, "attendees_min": { "description": "Limit results to tickets that have at least this number or attendees.", "type": "integer", "required": false }, "attendees_max": { "description": "Limit results to tickets that have at most this number of attendees.", "type": "integer", "required": false }, "checkedin_min": { "description": "Limit results to tickets that have at most this number of checked-in attendee.", "type": "integer", "required": false }, "checkedin_max": { "description": "Limit results to tickets that have at least this number of checked-in attendees.", "type": "integer", "required": false }, "capacity_min": { "description": "Limit results to tickets that have at least this capacity.", "type": "integer", "required": false }, "capacity_max": { "description": "Limit results to tickets that have at most this capacity.", "type": "integer", "required": false }, "available_from": { "description": "Limit results to tickets that will be available at or after the specified UTC date (parseable by strtotime) or timestamp.", "type": "string", "required": false }, "available_until": { "description": "Limit results to tickets that will be available up to the specified UTC date (parseable by strtotime) or timestamp.", "type": "string", "required": false }, "post_status": { "description": "Limit results to tickets assigned to posts that are in one of the post statuses specified in the CSV list or array; defaults to publish.", "required": false }, "status": { "description": "Limit results to tickets that are in one of post statuses specified in the CSV list or array; defaults to publish.", "required": false }, "currency": { "description": "Limit results to tickets priced in one of the 3-letter currency codes specified in the CSV list or array.", "required": false }, "attendee_information_available": { "description": "Limit results to tickets that provide attendees the possibility to fill in additional information or not; requires ET+.", "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": [ { "required": false }, { "description": { "type": "string", "in": "body", "validate_callback": [ [], "is_string_or_empty" ], "sanitize_callback": "sanitize_text_field", "default": "" }, "required": false } ] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/tickets\/v1\/tickets" } ] } }, "\/tribe\/tickets\/v1\/attendees\/(?P\\d+)": { "namespace": "tribe\/tickets\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "description": "The attendee post ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "integer", "description": "The attendee post ID", "required": true }, "check_in": { "type": "bool", "description": "Check in value for the attendee.", "required": false } } } ] }, "\/tribe\/tickets\/v1\/attendees": { "namespace": "tribe\/tickets\/v1", "methods": [ "POST", "GET" ], "endpoints": [ { "methods": [ "POST" ], "args": { "ticket_id": { "type": "integer", "description": "The Ticket ID, where the attendee is registered.", "required": true }, "full_name": { "type": "string", "description": "Full name of the attendee.", "required": true }, "email": { "type": "email", "description": "Email of the attendeee.", "required": true }, "attendee_status": { "type": "string", "description": "Order Status for the attendee.", "required": false }, "check_in": { "type": "bool", "description": "Check in value for the attendee.", "required": false } } }, { "methods": [ "GET" ], "args": { "page": { "description": "The page of results to return; defaults to 1", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "How many attendees to return per results page; defaults to posts_per_page.", "type": "integer", "default": "10", "minimum": 1, "maximum": 100, "required": false }, "provider": { "description": "Limit results to attendees whose ticket is provided by one of the providers specified in the CSV list or array; defaults to all the available.", "type": "string", "required": false }, "search": { "description": "Limit results to attendees containing the specified string in the title or description.", "type": "string", "required": false }, "offset": { "description": "Offset the results by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Sort results in ASC or DESC order. Defaults to ASC.", "type": "string", "enum": [ "ASC", "DESC" ], "required": false }, "orderby": { "description": "Order the results by one of date, relevance, id, include, title or slug. Defaults to id.", "type": "string", "enum": [ "id", "date", "include", "title", "slug" ], "required": false }, "post_id": { "description": "Limit results to attendees by post the ticket is associated with.", "type": "integer", "required": false }, "ticket_id": { "description": "Limit results to attendees associated with a ticket.", "type": "integer", "required": false }, "after": { "description": "Limit results to attendees created after or on the specified UTC date or timestamp.", "type": "string", "required": false }, "before": { "description": "Limit results to attendees created before or on the specified UTC date or timestamp.", "type": "string", "required": false }, "include": { "description": "Limit results to a specific CSV list or array of attendee IDs.", "required": false }, "exclude": { "description": "Exclude a specific CSV list or array of attendee IDs from the results.", "required": false }, "price_max": { "description": "Limit results to attendees that paid tickets a price equal or below the specified value; if not specified no maximum price limit will be used.", "type": "integer", "required": false }, "price_min": { "description": "Limit results to attendees that paid tickets a price equal or above the specified value; if not specified no minimum price limit will be used.", "type": "integer", "required": false }, "include_post": { "description": "Limit results to attendees whose ticket is assigned to one of the posts specified in the CSV list or array.", "required": false }, "exclude_post": { "description": "Limit results to attendees whose tickets is not assigned to any of the posts specified in the CSV list or array..", "required": false }, "include_ticket": { "description": "Limit results to a specific CSV list or array of ticket IDs.", "required": false }, "exclude_ticket": { "description": "Exclude a specific CSV list or array of ticket IDs.", "required": false }, "post_status": { "description": "Limit results to attendees for posts that are in one of the post statuses specified in the CSV list or array; defaults to publish.", "required": false }, "status": { "description": "Limit results to attendees that are in one of post statuses specified in the CSV list or array; defaults to publish.", "required": false }, "order_status": { "description": "Limit results to attendees whose order status is in one of post statuses specified in the CSV list or array; defaults to public.", "required": false }, "checkedin": { "description": "Limit results to attendees that are or not checked-in.", "type": "boolean", "required": false }, "rsvp_going_status": { "description": "Limit results to RSVP Attendees that have one of the RSVP Going status specified in the CSV list or array.", "required": false }, "attendee_information_available": { "description": "Limit results to attendees for tickets that provide attendees the possibility to fill in additional information or not; requires ET+.", "type": "boolean", "required": false }, "name": { "description": "Limit results to attendees by name. It will search for names that are like the specified value", "type": "string", "required": false }, "email": { "description": "Limit results to attendees by email. It will search for emails that are like the specified value", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/tickets\/v1\/attendees" } ] } }, "\/tribe\/tickets\/v1\/cart": { "namespace": "tribe\/tickets\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "provider": { "description": "Limit results to tickets provided by one of the providers specified in the CSV list or array; defaults to all available.", "required": false }, "post_id": { "type": "integer", "description": "The post ID", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "provider": { "type": "string", "description": "The cart provider", "required": true }, "tickets": { "default": null, "description": "List of tickets with their ID and quantity", "required": false }, "meta": { "default": null, "description": "List of meta for each ticket to be saved for Attendee Registration", "required": false }, "post_id": { "type": "integer", "description": "The post ID", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/tickets\/v1\/cart" } ] } }, "\/tribe\/event-aggregator\/v1": { "namespace": "tribe\/event-aggregator\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "tribe\/event-aggregator\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/event-aggregator\/v1" } ] } }, "\/tribe\/event-aggregator\/v1\/import\/(?P\\w+)\/batch": { "namespace": "tribe\/event-aggregator\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "import_id": { "type": "string", "description": "The import unique ID as provided by Event Aggregator service", "required": true }, "batch_hash": { "type": "string", "description": "The hash of the next expected batch, as previously provided by the client", "required": true }, "status": { "type": "object", "description": "The current status of the import.", "required": true }, "percentage_complete": { "type": "integer", "description": "The percentage of import completed.", "required": true }, "interval": { "type": "integer", "description": "The current interval, in seconds, between the end of a batch process and the start of the next; as set on the server.", "required": false } } } ] }, "\/tribe\/event-aggregator\/v1\/import\/(?P\\w+)\/state": { "namespace": "tribe\/event-aggregator\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "import_id": { "type": "string", "description": "The import unique ID as provided by Event Aggregator service", "required": true }, "batch_hash": { "type": "string", "description": "The hash of the next expected batch, as previously provided by the client", "required": true }, "status": { "type": "string", "enum": [ "success", "failed", "pending" ], "description": "The new status of the import.", "required": true }, "message": { "type": "string", "description": "The new status message for the user, not localised.", "required": true }, "message_slug": { "type": "string", "description": "The new status message slug, to allow for localised messages.", "required": true }, "percentage_complete": { "type": "integer", "description": "The percentage of import completed.", "required": true } } } ] }, "\/tribe\/events\/v1": { "namespace": "tribe\/events\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "tribe\/events\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/events\/v1" } ] } }, "\/tribe\/events\/v1\/doc": { "namespace": "tribe\/events\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/events\/v1\/doc" } ] } }, "\/tribe\/events\/v1\/events": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "page": { "default": 1, "description": "The archive page to return", "type": "integer", "required": false }, "per_page": { "default": "10", "description": "The number of events to return on each page", "type": "integer", "required": false }, "start_date": { "default": "2026-04-05 01:59:00", "description": "Events that start on the specified date", "required": false }, "end_date": { "default": "2028-04-05 09:40:12", "description": "Events that end on the specified date", "required": false }, "starts_before": { "description": "Events that start before the specified date", "required": false }, "starts_after": { "description": "Events that start after the specified date", "required": false }, "ends_before": { "description": "Events that end before the specified date", "required": false }, "ends_after": { "description": "Events that end after the specified date", "required": false }, "strict_dates": { "default": "false", "description": "Dates set using the start_date\/end_date, starts_*\/ends_* are set to start at the specified times. The default behavior is to include the entire days.", "required": false }, "search": { "description": "Events should contain the specified string in the title or description", "type": "string", "required": false }, "categories": { "description": "Events should be assigned one of the specified categories slugs or IDs", "items": { "type": "integer" }, "required": false }, "tags": { "description": "Events should be assigned one of the specified tags slugs or IDs", "items": { "type": "integer" }, "required": false }, "venue": { "description": "Events should be assigned one of the specified venue IDs", "items": { "type": "integer" }, "required": false }, "organizer": { "description": "Events should be assigned one of the specified organiser IDs", "items": { "type": "integer" }, "required": false }, "featured": { "type": "boolean", "description": "Events should be filtered by their featured status", "required": false }, "status": { "format": "string", "description": "The event post status", "required": false }, "geoloc": { "type": "boolean", "description": "Requires Events Calendar Pro. Events should be filtered by whether their venue has geolocation data", "required": false }, "geoloc_lat": { "format": "double", "description": "Requires Events Calendar Pro. Events should be filtered by their venue latitude location, must also provide geoloc_lng", "required": false }, "geoloc_lng": { "format": "double", "description": "Requires Events Calendar Pro. Events should be filtered by their venue longitude location, must also provide geoloc_lat", "required": false }, "include": { "description": "Include events with one of the post IDs specified in the array of CSV list, date filters will be ignored.", "items": { "type": "integer" }, "required": false }, "post_parent": { "type": "integer", "description": "Events should be filtered by their post_parent being the specified one.", "required": false }, "ticketed": { "type": "boolean", "description": "Filter events with or without tickets.", "required": false } } }, { "methods": [ "POST" ], "args": { "author": { "type": "integer", "description": "The event author ID", "required": false }, "date": { "type": "string", "description": "The event publication date", "required": false }, "date_utc": { "type": "string", "description": "The event publication date (UTC time zone)", "required": false }, "title": { "type": "string", "description": "The event title", "required": true }, "description": { "type": "string", "description": "The event description", "required": false }, "slug": { "type": "string", "description": "The event slug", "required": false }, "excerpt": { "type": "string", "description": "The event excerpt", "required": false }, "status": { "type": "string", "description": "The event post status", "required": false }, "timezone": { "type": "string", "description": "The event time zone", "required": false }, "all_day": { "default": false, "type": "boolean", "description": "Whether the event lasts the whole day or not", "required": false }, "start_date": { "type": "string", "description": "The event start date and time", "required": true }, "end_date": { "type": "string", "description": "The event end date and time", "required": true }, "image": { "type": "string", "description": "The event featured image ID or URL", "required": false }, "cost": { "description": "The event cost", "required": false }, "website": { "default": null, "description": "The event website URL", "required": false }, "show_map": { "type": "boolean", "description": "Whether the event should show a map or not", "required": false }, "show_map_link": { "type": "boolean", "description": "Whether the event should show a map link or not", "required": false }, "hide_from_listings": { "type": "boolean", "description": "Whether events should be hidden in the calendar view or not", "required": false }, "sticky": { "type": "boolean", "description": "Whether the event should be sticky in the calendar view or not", "required": false }, "featured": { "type": "boolean", "description": "Whether the event should be featured on the site or not", "required": false }, "categories": { "default": null, "items": { "type": "integer" }, "description": "The event category ID or name", "required": false }, "tags": { "default": null, "items": { "type": "integer" }, "description": "The event tag ID or name", "required": false }, "venue": { "default": null, "items": { "type": "integer" }, "description": "The event venue ID or data", "required": false }, "organizer": { "default": null, "items": { "type": "integer" }, "description": "The event organiser IDs or data", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/events\/v1\/events" } ] } }, "\/tribe\/events\/v1\/events\/(?P\\d+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "description": "the event post ID", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "description": "the event post ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "integer", "description": "the event post ID", "required": true }, "author": { "type": "integer", "description": "The event author ID", "required": false }, "date": { "type": "string", "description": "The event publication date", "required": false }, "date_utc": { "type": "string", "description": "The event publication date (UTC time zone)", "required": false }, "title": { "type": "string", "description": "The event title", "required": false }, "description": { "type": "string", "description": "The event description", "required": false }, "slug": { "type": "string", "description": "The event slug", "required": false }, "excerpt": { "type": "string", "description": "The event excerpt", "required": false }, "status": { "type": "string", "description": "The event post status", "required": false }, "timezone": { "type": "string", "description": "The event time zone", "required": false }, "all_day": { "default": false, "type": "boolean", "description": "Whether the event lasts the whole day or not", "required": false }, "start_date": { "type": "string", "description": "The event start date and time", "required": false }, "end_date": { "type": "string", "description": "The event end date and time", "required": false }, "image": { "type": "string", "description": "The event featured image ID or URL", "required": false }, "cost": { "description": "The event cost", "required": false }, "website": { "default": null, "description": "The event website URL", "required": false }, "show_map": { "type": "boolean", "description": "Whether the event should show a map or not", "required": false }, "show_map_link": { "type": "boolean", "description": "Whether the event should show a map link or not", "required": false }, "hide_from_listings": { "type": "boolean", "description": "Whether events should be hidden in the calendar view or not", "required": false }, "sticky": { "type": "boolean", "description": "Whether the event should be sticky in the calendar view or not", "required": false }, "featured": { "type": "boolean", "description": "Whether the event should be featured on the site or not", "required": false }, "categories": { "default": null, "items": { "type": "integer" }, "description": "The event category ID or name", "required": false }, "tags": { "default": null, "items": { "type": "integer" }, "description": "The event tag ID or name", "required": false }, "venue": { "default": null, "items": { "type": "integer" }, "description": "The event venue ID or data", "required": false }, "organizer": { "default": null, "items": { "type": "integer" }, "description": "The event organiser IDs or data", "required": false } } } ] }, "\/tribe\/events\/v1\/events\/by-slug\/(?P[^\/]+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "description": "the event post name", "required": true } } }, { "methods": [ "DELETE" ], "args": { "slug": { "type": "string", "description": "the event post name", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "slug": { "type": "string", "description": "The event slug", "required": false }, "author": { "type": "integer", "description": "The event author ID", "required": false }, "date": { "type": "string", "description": "The event publication date", "required": false }, "date_utc": { "type": "string", "description": "The event publication date (UTC time zone)", "required": false }, "title": { "type": "string", "description": "The event title", "required": false }, "description": { "type": "string", "description": "The event description", "required": false }, "excerpt": { "type": "string", "description": "The event excerpt", "required": false }, "status": { "type": "string", "description": "The event post status", "required": false }, "timezone": { "type": "string", "description": "The event time zone", "required": false }, "all_day": { "default": false, "type": "boolean", "description": "Whether the event lasts the whole day or not", "required": false }, "start_date": { "type": "string", "description": "The event start date and time", "required": false }, "end_date": { "type": "string", "description": "The event end date and time", "required": false }, "image": { "type": "string", "description": "The event featured image ID or URL", "required": false }, "cost": { "description": "The event cost", "required": false }, "website": { "default": null, "description": "The event website URL", "required": false }, "show_map": { "type": "boolean", "description": "Whether the event should show a map or not", "required": false }, "show_map_link": { "type": "boolean", "description": "Whether the event should show a map link or not", "required": false }, "hide_from_listings": { "type": "boolean", "description": "Whether events should be hidden in the calendar view or not", "required": false }, "sticky": { "type": "boolean", "description": "Whether the event should be sticky in the calendar view or not", "required": false }, "featured": { "type": "boolean", "description": "Whether the event should be featured on the site or not", "required": false }, "categories": { "default": null, "items": { "type": "integer" }, "description": "The event category ID or name", "required": false }, "tags": { "default": null, "items": { "type": "integer" }, "description": "The event tag ID or name", "required": false }, "venue": { "default": null, "items": { "type": "integer" }, "description": "The event venue ID or data", "required": false }, "organizer": { "default": null, "items": { "type": "integer" }, "description": "The event organiser IDs or data", "required": false } } } ] }, "\/tribe\/events\/v1\/venues": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "page": { "default": 1, "description": "The archive page to return", "type": "integer", "required": false }, "per_page": { "default": "10", "description": "The number of venues to return on each page", "type": "integer", "required": false }, "search": { "description": "Venues should contain the specified string in the title, description or custom fields", "type": "string", "required": false }, "event": { "description": "Venues should be related to this event", "type": "integer", "required": false }, "has_events": { "description": "Venues should have events associated to them", "required": false }, "only_with_upcoming": { "description": "Venues should have upcoming events associated to them", "default": false, "required": false }, "status": { "format": "string", "description": "The organiser post status", "required": false } } }, { "methods": [ "POST" ], "args": { "author": { "type": "integer", "description": "The venue author ID", "required": false }, "date": { "type": "string", "description": "The venue publication date", "required": false }, "date_utc": { "type": "string", "description": "The venue publication date (UTC time zone)", "required": false }, "venue": { "type": "string", "description": "The venue name", "required": true }, "description": { "type": "string", "default": null, "description": "The venue description", "required": false }, "status": { "type": "string", "description": "The venue post status", "required": false }, "show_map": { "type": "string", "default": null, "description": "Whether events linked to the venue should show a map or not", "required": false }, "show_map_link": { "type": "string", "default": null, "description": "Whether events linked to the venue should show a map link or not", "required": false }, "address": { "type": "string", "default": null, "description": "The venue address", "required": false }, "city": { "type": "string", "default": null, "description": "The venue city", "required": false }, "country": { "type": "string", "default": null, "description": "The venue country", "required": false }, "province": { "type": "string", "default": null, "description": "The venue province", "required": false }, "state": { "type": "string", "default": null, "description": "The venue state", "required": false }, "zip": { "type": "string", "default": null, "description": "The venue Postal Code", "required": false }, "phone": { "type": "string", "default": null, "description": "The venue phone number", "required": false }, "stateprovince": { "type": "string", "default": null, "description": "The venue state and province", "required": false }, "website": { "type": "string", "default": null, "description": "The venue website URL", "required": false }, "image": { "type": "string", "default": null, "description": "The organiser featured image ID or URL", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/events\/v1\/venues" } ] } }, "\/tribe\/events\/v1\/venues\/(?P\\d+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "description": "the venue post ID", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "description": "the venue post ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "integer", "description": "the venue post ID", "required": true }, "author": { "type": "integer", "description": "The venue author ID", "required": false }, "date": { "type": "string", "description": "The venue publication date", "required": false }, "date_utc": { "type": "string", "description": "The venue publication date (UTC time zone)", "required": false }, "venue": { "type": "string", "description": "The venue name", "required": false }, "description": { "type": "string", "default": null, "description": "The venue description", "required": false }, "status": { "type": "string", "description": "The venue post status", "required": false }, "show_map": { "type": "string", "default": null, "description": "Whether events linked to the venue should show a map or not", "required": false }, "show_map_link": { "type": "string", "default": null, "description": "Whether events linked to the venue should show a map link or not", "required": false }, "address": { "type": "string", "default": null, "description": "The venue address", "required": false }, "city": { "type": "string", "default": null, "description": "The venue city", "required": false }, "country": { "type": "string", "default": null, "description": "The venue country", "required": false }, "province": { "type": "string", "default": null, "description": "The venue province", "required": false }, "state": { "type": "string", "default": null, "description": "The venue state", "required": false }, "zip": { "type": "string", "default": null, "description": "The venue Postal Code", "required": false }, "phone": { "type": "string", "default": null, "description": "The venue phone number", "required": false }, "stateprovince": { "type": "string", "default": null, "description": "The venue state and province", "required": false }, "website": { "type": "string", "default": null, "description": "The venue website URL", "required": false }, "image": { "type": "string", "default": null, "description": "The organiser featured image ID or URL", "required": false } } } ] }, "\/tribe\/events\/v1\/venues\/by-slug\/(?P[^\/]+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "description": "the venue post name", "required": true } } }, { "methods": [ "DELETE" ], "args": { "slug": { "type": "string", "description": "the venue post name", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "slug": { "type": "string", "description": "the venue post name", "required": true }, "author": { "type": "integer", "description": "The venue author ID", "required": false }, "date": { "type": "string", "description": "The venue publication date", "required": false }, "date_utc": { "type": "string", "description": "The venue publication date (UTC time zone)", "required": false }, "venue": { "type": "string", "description": "The venue name", "required": false }, "description": { "type": "string", "default": null, "description": "The venue description", "required": false }, "status": { "type": "string", "description": "The venue post status", "required": false }, "show_map": { "type": "string", "default": null, "description": "Whether events linked to the venue should show a map or not", "required": false }, "show_map_link": { "type": "string", "default": null, "description": "Whether events linked to the venue should show a map link or not", "required": false }, "address": { "type": "string", "default": null, "description": "The venue address", "required": false }, "city": { "type": "string", "default": null, "description": "The venue city", "required": false }, "country": { "type": "string", "default": null, "description": "The venue country", "required": false }, "province": { "type": "string", "default": null, "description": "The venue province", "required": false }, "state": { "type": "string", "default": null, "description": "The venue state", "required": false }, "zip": { "type": "string", "default": null, "description": "The venue Postal Code", "required": false }, "phone": { "type": "string", "default": null, "description": "The venue phone number", "required": false }, "stateprovince": { "type": "string", "default": null, "description": "The venue state and province", "required": false }, "website": { "type": "string", "default": null, "description": "The venue website URL", "required": false }, "image": { "type": "string", "default": null, "description": "The organiser featured image ID or URL", "required": false } } } ] }, "\/tribe\/events\/v1\/organizers": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "page": { "default": 1, "description": "The archive page to return", "type": "integer", "required": false }, "per_page": { "default": "10", "description": "The number of organisers to return on each page", "type": "integer", "required": false }, "search": { "description": "Organisers should contain the specified string in the title, description or custom fields", "type": "string", "required": false }, "event": { "description": "Organisers should be related to this event", "type": "integer", "required": false }, "has_events": { "description": "Organisers should have events associated to them", "required": false }, "only_with_upcoming": { "description": "Organisers should have upcoming events associated to them", "default": false, "required": false }, "status": { "format": "string", "description": "The organiser post status", "required": false } } }, { "methods": [ "POST" ], "args": { "author": { "type": "integer", "default": null, "description": "The organiser author ID", "required": false }, "date": { "type": "string", "default": null, "description": "The organiser publication date", "required": false }, "date_utc": { "type": "string", "default": null, "description": "The organiser publication date (UTC time zone)", "required": false }, "organizer": { "type": "string", "default": null, "description": "The organiser's name", "required": true }, "description": { "type": "string", "default": null, "description": "The organiser description", "required": false }, "status": { "type": "string", "default": null, "description": "The organiser post status", "required": false }, "phone": { "type": "string", "default": null, "description": "The organiser's phone number", "required": false }, "website": { "type": "string", "default": null, "description": "The organiser's website", "required": false }, "email": { "type": "string", "default": null, "description": "The organiser email address", "required": false }, "image": { "type": "string", "default": null, "description": "The organiser featured image ID or URL", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/events\/v1\/organizers" } ] } }, "\/tribe\/events\/v1\/organizers\/(?P\\d+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "description": "the organiser post ID", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "description": "the organiser post ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "integer", "description": "the organiser post ID", "required": true }, "author": { "type": "integer", "default": null, "description": "The organiser author ID", "required": false }, "date": { "type": "string", "default": null, "description": "The organiser publication date", "required": false }, "date_utc": { "type": "string", "default": null, "description": "The organiser publication date (UTC time zone)", "required": false }, "organizer": { "type": "string", "default": null, "description": "The organiser's name", "required": false }, "description": { "type": "string", "default": null, "description": "The organiser description", "required": false }, "status": { "type": "string", "default": null, "description": "The organiser post status", "required": false }, "phone": { "type": "string", "default": null, "description": "The organiser's phone number", "required": false }, "website": { "type": "string", "default": null, "description": "The organiser's website", "required": false }, "email": { "type": "string", "default": null, "description": "The organiser email address", "required": false }, "image": { "type": "string", "default": null, "description": "The organiser featured image ID or URL", "required": false } } } ] }, "\/tribe\/events\/v1\/organizers\/by-slug\/(?P[^\/]+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "description": "the organiser post name", "required": true } } }, { "methods": [ "DELETE" ], "args": { "slug": { "type": "string", "description": "the organiser post name", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "slug": { "type": "string", "description": "the organiser post name", "required": true }, "author": { "type": "integer", "default": null, "description": "The organiser author ID", "required": false }, "date": { "type": "string", "default": null, "description": "The organiser publication date", "required": false }, "date_utc": { "type": "string", "default": null, "description": "The organiser publication date (UTC time zone)", "required": false }, "organizer": { "type": "string", "default": null, "description": "The organiser's name", "required": false }, "description": { "type": "string", "default": null, "description": "The organiser description", "required": false }, "status": { "type": "string", "default": null, "description": "The organiser post status", "required": false }, "phone": { "type": "string", "default": null, "description": "The organiser's phone number", "required": false }, "website": { "type": "string", "default": null, "description": "The organiser's website", "required": false }, "email": { "type": "string", "default": null, "description": "The organiser email address", "required": false }, "image": { "type": "string", "default": null, "description": "The organiser featured image ID or URL", "required": false } } } ] }, "\/tribe\/events\/v1\/categories": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "page": { "default": 1, "description": "The archive page to return", "type": "integer", "required": false }, "per_page": { "default": "10", "description": "The number of event categories to return on each page", "type": "integer", "required": false }, "search": { "description": "Limit results to those matching a string", "type": "string", "required": false }, "exclude": { "description": "Ensure result set exclude specific IDs", "items": { "type": "integer" }, "required": false }, "include": { "description": "Limit result set to specific IDs", "items": { "type": "integer" }, "required": false }, "order": { "description": "Order sort attribute ascending or descending", "type": "string", "required": false }, "orderby": { "description": "Sort collection by term attribute", "type": "string", "required": false }, "hide_empty": { "description": "Whether to hide terms not assigned to any posts", "type": "boolean", "default": "1", "required": false }, "parent": { "description": "Limit result set to terms assigned to a specific parent", "type": "integer", "required": false }, "post": { "description": "Limit result set to terms assigned to a specific post", "type": "integer", "required": false }, "event": { "description": "Limit result set to terms assigned to a specific event (an alias of the \"post\" parameter)", "type": "integer", "required": false }, "slug": { "description": "Limit result set to terms with a specific slug", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "The event category name", "required": true }, "description": { "type": "string", "description": "The event category description", "required": false }, "slug": { "type": "string", "description": "The event category slug", "required": false }, "parent": { "type": "integer", "description": "The event category slug", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/events\/v1\/categories" } ] } }, "\/tribe\/events\/v1\/categories\/(?P\\d+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "description": "the event category term ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "integer", "description": "the event category term ID", "required": true }, "name": { "type": "string", "description": "The event category name", "required": false }, "description": { "type": "string", "description": "The event category description", "required": false }, "slug": { "type": "string", "description": "The event category slug", "required": false }, "parent": { "type": "integer", "description": "The event category slug", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "description": "the event category term ID", "required": true } } } ] }, "\/tribe\/events\/v1\/tags": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "page": { "default": 1, "description": "The archive page to return", "type": "integer", "required": false }, "per_page": { "default": "10", "description": "The number of event tags to return on each page", "type": "integer", "required": false }, "search": { "description": "Limit results to those matching a string", "type": "string", "required": false }, "exclude": { "description": "Ensure result set exclude specific IDs", "items": { "type": "integer" }, "required": false }, "include": { "description": "Limit result set to specific IDs", "items": { "type": "integer" }, "required": false }, "order": { "description": "Order sort attribute ascending or descending", "type": "string", "required": false }, "orderby": { "description": "Sort collection by term attribute", "type": "string", "required": false }, "hide_empty": { "description": "Whether to hide terms not assigned to any posts", "type": "boolean", "default": "1", "required": false }, "post": { "description": "Limit result set to terms assigned to a specific post", "type": "integer", "required": false }, "event": { "description": "Limit result set to terms assigned to a specific event (an alias of the \"post\" parameter)", "type": "integer", "required": false }, "slug": { "description": "Limit result set to terms with a specific slug", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "The event tag name", "required": true }, "description": { "type": "string", "description": "The event tag description", "required": false }, "slug": { "type": "string", "description": "The event tag slug", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/events\/v1\/tags" } ] } }, "\/tribe\/events\/v1\/tags\/(?P\\d+)": { "namespace": "tribe\/events\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "description": "the event tag term ID", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "integer", "description": "the event tag term ID", "required": true }, "name": { "type": "string", "description": "The event tag name", "required": false }, "description": { "type": "string", "description": "The event tag description", "required": false }, "slug": { "type": "string", "description": "The event tag slug", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "description": "the event tag term ID", "required": true } } } ] }, "\/tribe\/views\/v2": { "namespace": "tribe\/views\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "tribe\/views\/v2", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/views\/v2" } ] } }, "\/tribe\/views\/v2\/html": { "namespace": "tribe\/views\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET", "POST" ], "args": { "url": { "required": true }, "view": { "required": false }, "_wpnonce": { "required": false }, "view_data": { "required": false }, "action": { "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/tribe\/views\/v2\/html" } ] } }, "\/jetpack\/v4": { "namespace": "jetpack\/v4", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "jetpack\/v4", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4" } ] } }, "\/jetpack\/v4\/verify_xmlrpc_error": { "namespace": "jetpack\/v4", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "nonce": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/verify_xmlrpc_error" } ] } }, "\/jetpack\/v4\/heartbeat\/data": { "namespace": "jetpack\/v4", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "prefix": { "description": "Prefix to add before the stats identifiers.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/heartbeat\/data" } ] } }, "\/oembed\/1.0\/embed\/activity": { "namespace": "oembed\/1.0", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "url": { "required": true }, "format": { "default": "json", "required": false }, "maxwidth": { "default": 600, "required": false }, "hide_media": { "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/oembed\/1.0\/embed\/activity" } ] } }, "\/elementor\/v1": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "elementor\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1" } ] } }, "\/elementor\/v1\/site-editor": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/site-editor" } ] } }, "\/elementor\/v1\/site-editor\/templates": { "namespace": "elementor\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/site-editor\/templates" } ] } }, "\/elementor\/v1\/site-editor\/templates\/(?P[\\w]+)": { "namespace": "elementor\/v1", "methods": [ "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": false } } } ] }, "\/elementor\/v1\/site-editor\/conditions-config": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/site-editor\/conditions-config" } ] } }, "\/elementor\/v1\/site-editor\/templates-conditions\/(?P[\\w]+)": { "namespace": "elementor\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": false } } } ] }, "\/elementor\/v1\/site-editor\/templates-conditions-conflicts": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/site-editor\/templates-conditions-conflicts" } ] } }, "\/wc-admin": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc-admin", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin" } ] } }, "\/wc-admin\/notice\/dismiss": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/notice\/dismiss" } ] } }, "\/wc-admin\/features": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/features" } ] } }, "\/wc-admin\/experiments\/assignment": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/experiments\/assignment" } ] } }, "\/wc-admin\/marketing\/recommended": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "category": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/recommended" } ] } }, "\/wc-admin\/marketing\/knowledge-base": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "category": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/knowledge-base" } ] } }, "\/wc-admin\/marketing\/misc-recommendations": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/misc-recommendations" } ] } }, "\/wc-admin\/marketing\/overview\/activate-plugin": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "plugin": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/overview\/activate-plugin" } ] } }, "\/wc-admin\/marketing\/overview\/installed-plugins": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/overview\/installed-plugins" } ] } }, "\/wc-admin\/marketing\/recommendations": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "category": { "type": "string", "enum": [ "channels", "extensions" ], "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/recommendations" } ] } }, "\/wc-admin\/marketing\/channels": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/channels" } ] } }, "\/wc-admin\/marketing\/campaigns": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/campaigns" } ] } }, "\/wc-admin\/marketing\/campaign-types": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/marketing\/campaign-types" } ] } }, "\/wc-admin\/options": { "namespace": "wc-admin", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/options" } ] } }, "\/wc-admin\/legacy-settings": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "schema": { "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/legacy-settings" } ] } }, "\/wc-admin\/payment-gateway-suggestions": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "force_default_suggestions": { "type": "boolean", "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/payment-gateway-suggestions" } ] } }, "\/wc-admin\/payment-gateway-suggestions\/dismiss": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/payment-gateway-suggestions\/dismiss" } ] } }, "\/wc-admin\/themes": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "pluginzip": { "description": "A zip file of the theme to be uploaded.", "type": "file", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/themes" } ] } }, "\/wc-admin\/plugins\/install": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/install" } ] } }, "\/wc-admin\/plugins\/install\/status": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/install\/status" } ] } }, "\/wc-admin\/plugins\/install\/status\/(?P[a-z0-9_\\-]+)": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/wc-admin\/plugins\/active": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/active" } ] } }, "\/wc-admin\/plugins\/installed": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/installed" } ] } }, "\/wc-admin\/plugins\/activate": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/activate" } ] } }, "\/wc-admin\/plugins\/activate\/status": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/activate\/status" } ] } }, "\/wc-admin\/plugins\/activate\/status\/(?P[a-z0-9_\\-]+)": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/wc-admin\/plugins\/connect-jetpack": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/connect-jetpack" } ] } }, "\/wc-admin\/plugins\/request-wccom-connect": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/request-wccom-connect" } ] } }, "\/wc-admin\/plugins\/finish-wccom-connect": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/finish-wccom-connect" } ] } }, "\/wc-admin\/plugins\/connect-wcpay": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/connect-wcpay" } ] } }, "\/wc-admin\/plugins\/connect-square": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/plugins\/connect-square" } ] } }, "\/wc-admin\/onboarding\/free-extensions": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/free-extensions" } ] } }, "\/wc-admin\/onboarding\/product-types": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/product-types" } ] } }, "\/wc-admin\/onboarding\/profile": { "namespace": "wc-admin", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "completed": { "type": "boolean", "description": "Whether or not the profile was completed.", "required": false }, "skipped": { "type": "boolean", "description": "Whether or not the profile was skipped.", "required": false }, "industry": { "type": "array", "description": "Industry.", "items": { "type": "string" }, "required": false }, "business_extensions": { "type": "array", "description": "Extra business extensions to install.", "items": { "type": "string" }, "required": false }, "is_agree_marketing": { "type": "boolean", "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "required": false }, "store_email": { "type": "string", "description": "Store email address.", "required": false }, "is_store_country_set": { "type": "boolean", "description": "Whether or not this store country is set via onboarding profiler.", "required": false }, "is_plugins_page_skipped": { "type": "boolean", "description": "Whether or not plugins step in core profiler was skipped.", "required": false }, "business_choice": { "type": "string", "description": "Business choice.", "required": false }, "selling_online_answer": { "type": "string", "description": "Selling online answer.", "required": false }, "selling_platforms": { "type": [ "array", "null" ], "description": "Selling platforms.", "items": { "type": [ "string", "null" ] }, "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/profile" } ] } }, "\/wc-admin\/onboarding\/profile\/experimental_get_email_prefill": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/profile\/experimental_get_email_prefill" } ] } }, "\/wc-admin\/onboarding\/profile\/progress": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/profile\/progress" } ] } }, "\/wc-admin\/onboarding\/profile\/progress\/core-profiler\/complete": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "step": { "type": "string", "description": "The Core Profiler step to mark as complete.", "enum": [ "intro-opt-in", "skip-guided-setup", "user-profile", "business-info", "plugins", "intro-builder", "skip-guided-setup" ], "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/profile\/progress\/core-profiler\/complete" } ] } }, "\/wc-admin\/onboarding\/profile\/update-store-currency-and-measurement-units": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "country_code": { "description": "Country code.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/profile\/update-store-currency-and-measurement-units" } ] } }, "\/wc-admin\/onboarding\/tasks\/import_sample_products": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/tasks\/import_sample_products" } ] } }, "\/wc-admin\/onboarding\/tasks\/create_homepage": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/tasks\/create_homepage" } ] } }, "\/wc-admin\/onboarding\/tasks\/create_product_from_template": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "template_name": { "type": "string", "description": "Product template name.", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/tasks\/create_product_from_template" } ] } }, "\/wc-admin\/onboarding\/tasks": { "namespace": "wc-admin", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "ids": { "description": "Optional parameter to get only specific task lists by ID.", "type": "array", "items": { "enum": [], "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "ids": { "description": "Optional parameter to get only specific task lists by ID.", "type": "array", "items": { "enum": [], "type": "string" }, "required": false }, "extended_tasks": { "description": "List of extended deprecated tasks from the client-side filter.", "type": "array", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/tasks" } ] } }, "\/wc-admin\/onboarding\/tasks\/(?P[a-z0-9_\\-]+)\/hide": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/onboarding\/tasks\/(?P[a-z0-9_\\-]+)\/unhide": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/onboarding\/tasks\/(?P[a-z0-9_\\-]+)\/dismiss": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/onboarding\/tasks\/(?P[a-z0-9_\\-]+)\/undo_dismiss": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/onboarding\/tasks\/(?P[a-z0-9_-]+)\/snooze": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "duration": { "description": "Time period to snooze the task.", "type": "string", "required": false }, "task_list_id": { "description": "Optional parameter to query specific task list.", "type": "string", "required": false } } } ] }, "\/wc-admin\/onboarding\/tasks\/(?P[a-z0-9_\\-]+)\/action": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/onboarding\/tasks\/(?P[a-z0-9_\\-]+)\/undo_snooze": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/onboarding\/themes\/install": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/themes\/install" } ] } }, "\/wc-admin\/onboarding\/themes\/activate": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/themes\/activate" } ] } }, "\/wc-admin\/onboarding\/plugins\/install-and-activate-async": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "plugins": { "description": "A list of plugins to install", "type": "array", "items": "string", "required": true }, "source": { "description": "The source of the request", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/plugins\/install-and-activate-async" } ] } }, "\/wc-admin\/onboarding\/plugins\/install-and-activate": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/plugins\/install-and-activate" } ] } }, "\/wc-admin\/onboarding\/plugins\/scheduled-installs\/(?P\\w+)": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/wc-admin\/onboarding\/plugins\/jetpack-authorization-url": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "redirect_url": { "description": "The URL to redirect to after authorization", "type": "string", "required": true }, "from": { "description": "from value for the jetpack authorization page", "type": "string", "default": "woocommerce-onboarding", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/plugins\/jetpack-authorization-url" } ] } }, "\/wc-admin\/onboarding\/products": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/onboarding\/products" } ] } }, "\/wc-admin\/mobile-app\/send-magic-link": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/mobile-app\/send-magic-link" } ] } }, "\/wc-admin\/mobile-app": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/mobile-app" } ] } }, "\/wc-admin\/shipping-partner-suggestions": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "force_default_suggestions": { "type": "boolean", "description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/shipping-partner-suggestions" } ] } }, "\/wc-analytics": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc-analytics", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics" } ] } }, "\/wc-analytics\/customers": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date_registered", "enum": [ "username", "name", "first_name", "last_name", "email", "location", "country", "city", "state", "postcode", "date_registered", "date_last_active", "orders_count", "total_spend", "avg_order_value" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "type": "string", "required": false }, "searchby": { "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "type": "string", "default": "name", "enum": [ "name", "username", "email", "all" ], "required": false }, "name_includes": { "description": "Limit response to objects with specific names.", "type": "string", "required": false }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "type": "string", "required": false }, "username_includes": { "description": "Limit response to objects with specific usernames.", "type": "string", "required": false }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "type": "string", "required": false }, "email_includes": { "description": "Limit response to objects including emails.", "type": "string", "required": false }, "email_excludes": { "description": "Limit response to objects excluding emails.", "type": "string", "required": false }, "country_includes": { "description": "Limit response to objects with specific countries.", "type": "string", "required": false }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "type": "string", "required": false }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "type": "integer", "required": false }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "type": "integer", "required": false }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "type": "array", "items": { "type": "integer" }, "required": false }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "type": "number", "required": false }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "type": "number", "required": false }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "type": "number", "required": false }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "type": "number", "required": false }, "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "users": { "description": "Limit result to items with specified user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "type": "array", "items": { "type": "string", "enum": [ "email", "name", "country", "city", "state", "postcode" ] }, "required": false }, "user_type": { "description": "Limit result to items with specified user type.", "type": "string", "default": "all", "enum": [ "all", "registered", "guest" ], "required": false }, "location_includes": { "description": "Includes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).", "type": "string", "required": false }, "location_excludes": { "description": "Excludes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).", "type": "string", "required": false }, "include": { "description": "Limit result to items with specified customer IDs.", "type": "array", "items": { "type": "integer" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/customers" } ] } }, "\/wc-analytics\/customers\/(?P[\\d-]+)": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date_registered", "enum": [ "username", "name", "first_name", "last_name", "email", "location", "country", "city", "state", "postcode", "date_registered", "date_last_active", "orders_count", "total_spend", "avg_order_value" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "type": "string", "required": false }, "searchby": { "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "type": "string", "default": "name", "enum": [ "name", "username", "email", "all" ], "required": false }, "name_includes": { "description": "Limit response to objects with specific names.", "type": "string", "required": false }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "type": "string", "required": false }, "username_includes": { "description": "Limit response to objects with specific usernames.", "type": "string", "required": false }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "type": "string", "required": false }, "email_includes": { "description": "Limit response to objects including emails.", "type": "string", "required": false }, "email_excludes": { "description": "Limit response to objects excluding emails.", "type": "string", "required": false }, "country_includes": { "description": "Limit response to objects with specific countries.", "type": "string", "required": false }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "type": "string", "required": false }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "type": "integer", "required": false }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "type": "integer", "required": false }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "type": "array", "items": { "type": "integer" }, "required": false }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "type": "number", "required": false }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "type": "number", "required": false }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "type": "number", "required": false }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "type": "number", "required": false }, "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "users": { "description": "Limit result to items with specified user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "type": "array", "items": { "type": "string", "enum": [ "email", "name", "country", "city", "state", "postcode" ] }, "required": false }, "user_type": { "description": "Limit result to items with specified user type.", "type": "string", "default": "all", "enum": [ "all", "registered", "guest" ], "required": false }, "location_includes": { "description": "Includes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).", "type": "string", "required": false }, "location_excludes": { "description": "Excludes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).", "type": "string", "required": false }, "include": { "description": "Limit result to items with specified customer IDs.", "type": "array", "items": { "type": "integer" }, "required": false } } } ] }, "\/wc-analytics\/leaderboards": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 5, "minimum": 1, "maximum": 20, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "persisted_query": { "description": "URL query to persist across links.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/leaderboards" } ] } }, "\/wc-analytics\/leaderboards\/allowed": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/leaderboards\/allowed" } ] } }, "\/wc-analytics\/leaderboards\/(?P\\w+)": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "leaderboard": { "type": "string", "enum": [ "customers", "coupons", "categories", "products" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 5, "minimum": 1, "maximum": 20, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "persisted_query": { "description": "URL query to persist across links.", "type": "string", "required": false } } } ] }, "\/wc-analytics\/reports": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports" } ] } }, "\/wc-analytics\/reports\/import": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "days": { "description": "Number of days to import.", "type": "integer", "minimum": 0, "required": false }, "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean", "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/import" } ] } }, "\/wc-analytics\/reports\/import\/cancel": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/import\/cancel" } ] } }, "\/wc-analytics\/reports\/import\/delete": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/import\/delete" } ] } }, "\/wc-analytics\/reports\/import\/status": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/import\/status" } ] } }, "\/wc-analytics\/reports\/import\/totals": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "days": { "description": "Number of days to import.", "type": "integer", "minimum": 0, "required": false }, "skip_existing": { "description": "Skip importing existing order data.", "type": "boolean", "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/import\/totals" } ] } }, "\/wc-analytics\/reports\/(?P[a-z]+)\/export": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "report_args": { "description": "Parameters to pass on to the exported report.", "type": "object", "required": false }, "email": { "description": "When true, email a link to download the export to the requesting user.", "type": "boolean", "required": false } } } ] }, "\/wc-analytics\/reports\/(?P[a-z]+)\/export\/(?P[a-z0-9]+)\/status": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/wc-analytics\/reports\/products": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "net_revenue", "orders_count", "items_sold", "product_name", "variations", "sku" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "categories": { "description": "Limit result to items from the specified categories.", "type": "array", "items": { "type": "integer" }, "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "products": { "description": "Limit result to items with specified product IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "extended_info": { "description": "Add additional piece of info about each product to the report.", "type": "boolean", "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/products" } ] } }, "\/wc-analytics\/reports\/variations": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "net_revenue", "orders_count", "items_sold", "sku" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "product_includes": { "description": "Limit result set to items that have the specified parent product(s).", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "product_excludes": { "description": "Limit result set to items that don't have the specified parent product(s).", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "variations": { "description": "Limit result to items with specified variation IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "extended_info": { "description": "Add additional piece of info about each variation to the report.", "type": "boolean", "default": false, "required": false }, "attribute_is": { "description": "Limit result set to variations that include the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false }, "attribute_is_not": { "description": "Limit result set to variations that don't include the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false }, "category_includes": { "description": "Limit result set to variations in the specified categories.", "type": "array", "items": { "type": "integer" }, "required": false }, "category_excludes": { "description": "Limit result set to variations not in the specified categories.", "type": "array", "items": { "type": "integer" }, "required": false }, "products": { "description": "Limit result to items with specified product IDs.", "type": "array", "items": { "type": "integer" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/variations" } ] } }, "\/wc-analytics\/reports\/products\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "net_revenue", "coupons", "refunds", "shipping", "taxes", "net_revenue", "orders_count", "items_sold" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "fields": { "description": "Limit stats fields to the specified items.", "type": "array", "items": { "type": "string" }, "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "categories": { "description": "Limit result to items from the specified categories.", "type": "array", "items": { "type": "integer" }, "required": false }, "products": { "description": "Limit result to items with specified product IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "variations": { "description": "Limit result to items with specified variation IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "segmentby": { "description": "Segment the response by additional constraint.", "type": "string", "enum": [ "product", "category", "variation" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/products\/stats" } ] } }, "\/wc-analytics\/reports\/variations\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "net_revenue", "coupons", "refunds", "shipping", "taxes", "net_revenue", "orders_count", "items_sold" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "fields": { "description": "Limit stats fields to the specified items.", "type": "array", "items": { "type": "string" }, "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "category_includes": { "description": "Limit result to items from the specified categories.", "type": "array", "items": { "type": "integer" }, "required": false }, "category_excludes": { "description": "Limit result set to variations not in the specified categories.", "type": "array", "items": { "type": "integer" }, "required": false }, "product_includes": { "description": "Limit result set to items that have the specified parent product(s).", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "product_excludes": { "description": "Limit result set to items that don't have the specified parent product(s).", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "variations": { "description": "Limit result to items with specified variation IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "segmentby": { "description": "Segment the response by additional constraint.", "type": "string", "enum": [ "product", "category", "variation" ], "required": false }, "attribute_is": { "description": "Limit result set to orders that include products with the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false }, "attribute_is_not": { "description": "Limit result set to orders that don't include products with the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/variations\/stats" } ] } }, "\/wc-analytics\/reports\/revenue\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "total_sales", "coupons", "refunds", "shipping", "taxes", "net_revenue", "orders_count", "items_sold", "gross_sales" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "segmentby": { "description": "Segment the response by additional constraint.", "type": "string", "enum": [ "product", "category", "variation", "coupon", "customer_type" ], "required": false }, "date_type": { "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", "type": "string", "enum": [ "date_paid", "date_created", "date_completed" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/revenue\/stats" } ] } }, "\/wc-analytics\/reports\/orders": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 0, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "num_items_sold", "net_total" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "product_includes": { "description": "Limit result set to items that have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "product_excludes": { "description": "Limit result set to items that don't have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "variation_includes": { "description": "Limit result set to items that have the specified variation(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "variation_excludes": { "description": "Limit result set to items that don't have the specified variation(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "coupon_includes": { "description": "Limit result set to items that have the specified coupon(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "coupon_excludes": { "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "tax_rate_includes": { "description": "Limit result set to items that have the specified tax rate(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "tax_rate_excludes": { "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "status_is": { "description": "Limit result set to items that have the specified order status.", "type": "array", "items": { "enum": [ "any", "trash", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "type": "string" }, "required": false }, "status_is_not": { "description": "Limit result set to items that don't have the specified order status.", "type": "array", "items": { "enum": [ "any", "trash", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "type": "string" }, "required": false }, "customer_type": { "description": "Limit result set to returning or new customers.", "type": "string", "default": "", "enum": [ "", "returning", "new" ], "required": false }, "refunds": { "description": "Limit result set to specific types of refunds.", "type": "string", "default": "", "enum": [ "", "all", "partial", "full", "none" ], "required": false }, "extended_info": { "description": "Add additional piece of info about each coupon to the report.", "type": "boolean", "default": false, "required": false }, "order_includes": { "description": "Limit result set to items that have the specified order IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "order_excludes": { "description": "Limit result set to items that don't have the specified order IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "attribute_is": { "description": "Limit result set to orders that include products with the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false }, "attribute_is_not": { "description": "Limit result set to orders that don't include products with the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/orders" } ] } }, "\/wc-analytics\/reports\/orders\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "net_revenue", "orders_count", "avg_order_value" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "status_is": { "description": "Limit result set to items that have the specified order status.", "type": "array", "default": null, "items": { "enum": [ "any", "trash", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "type": "string" }, "required": false }, "status_is_not": { "description": "Limit result set to items that don't have the specified order status.", "type": "array", "items": { "enum": [ "any", "trash", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "type": "string" }, "required": false }, "product_includes": { "description": "Limit result set to items that have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "product_excludes": { "description": "Limit result set to items that don't have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "variation_includes": { "description": "Limit result set to items that have the specified variation(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "variation_excludes": { "description": "Limit result set to items that don't have the specified variation(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "coupon_includes": { "description": "Limit result set to items that have the specified coupon(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "coupon_excludes": { "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "tax_rate_includes": { "description": "Limit result set to items that have the specified tax rate(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "tax_rate_excludes": { "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "customer": { "description": "Alias for customer_type (deprecated).", "type": "string", "enum": [ "new", "returning" ], "required": false }, "customer_type": { "description": "Limit result set to orders that have the specified customer_type", "type": "string", "enum": [ "new", "returning" ], "required": false }, "refunds": { "description": "Limit result set to specific types of refunds.", "type": "string", "default": "", "enum": [ "", "all", "partial", "full", "none" ], "required": false }, "attribute_is": { "description": "Limit result set to orders that include products with the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false }, "attribute_is_not": { "description": "Limit result set to orders that don't include products with the specified attributes.", "type": "array", "items": { "type": "array" }, "default": [], "required": false }, "segmentby": { "description": "Segment the response by additional constraint.", "type": "string", "enum": [ "product", "category", "variation", "coupon", "customer_type" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/orders\/stats" } ] } }, "\/wc-analytics\/reports\/categories": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "category_id", "enum": [ "category_id", "items_sold", "net_revenue", "orders_count", "products_count", "category" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "status_is": { "description": "Limit result set to items that have the specified order status.", "type": "array", "items": { "enum": [ "any", "trash", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "type": "string" }, "required": false }, "status_is_not": { "description": "Limit result set to items that don't have the specified order status.", "type": "array", "items": { "enum": [ "any", "trash", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "type": "string" }, "required": false }, "categories": { "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "extended_info": { "description": "Add additional piece of info about each category to the report.", "type": "boolean", "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/categories" } ] } }, "\/wc-analytics\/reports\/taxes": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "tax_rate_id", "enum": [ "name", "tax_rate_id", "tax_code", "rate", "order_tax", "total_tax", "shipping_tax", "orders_count" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "taxes": { "description": "Limit result set to items assigned one or more tax rates.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/taxes" } ] } }, "\/wc-analytics\/reports\/taxes\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "items_sold", "total_sales", "orders_count", "products_count" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "fields": { "description": "Limit stats fields to the specified items.", "type": "array", "items": { "type": "string" }, "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "taxes": { "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", "type": "array", "items": { "type": "integer" }, "required": false }, "segmentby": { "description": "Segment the response by additional constraint.", "type": "string", "enum": [ "tax_rate_id" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/taxes\/stats" } ] } }, "\/wc-analytics\/reports\/coupons": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "coupon_id", "enum": [ "coupon_id", "code", "amount", "orders_count" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "coupons": { "description": "Limit result set to coupons assigned specific coupon IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "extended_info": { "description": "Add additional piece of info about each coupon to the report.", "type": "boolean", "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/coupons" } ] } }, "\/wc-analytics\/reports\/coupons\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "amount", "coupons_count", "orders_count" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "fields": { "description": "Limit stats fields to the specified items.", "type": "array", "items": { "type": "string" }, "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "coupons": { "description": "Limit result set to coupons assigned specific coupon IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "segmentby": { "description": "Segment the response by additional constraint.", "type": "string", "enum": [ "product", "variation", "category", "coupon" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/coupons\/stats" } ] } }, "\/wc-analytics\/reports\/stock": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "stock_status", "enum": [ "stock_status", "stock_quantity", "date", "id", "include", "title", "sku" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "type": { "description": "Limit result set to items assigned a stock report type.", "type": "string", "default": "all", "enum": [ "all", "lowstock", "instock", "outofstock", "onbackorder" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/stock" } ] } }, "\/wc-analytics\/reports\/stock\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/stock\/stats" } ] } }, "\/wc-analytics\/reports\/downloads": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "product" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "product_includes": { "description": "Limit result set to items that have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "product_excludes": { "description": "Limit result set to items that don't have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order_includes": { "description": "Limit result set to items that have the specified order IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "order_excludes": { "description": "Limit result set to items that don't have the specified order IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "customer_includes": { "description": "Limit response to objects that have the specified user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "customer_excludes": { "description": "Limit response to objects that don't have the specified user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "ip_address_includes": { "description": "Limit response to objects that have a specified IP address.", "type": "array", "items": { "type": "string" }, "required": false }, "ip_address_excludes": { "description": "Limit response to objects that don't have a specified IP address.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/downloads" } ] } }, "\/wc-analytics\/reports\/downloads\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "download_count" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "fields": { "description": "Limit stats fields to the specified items.", "type": "array", "items": { "type": "string" }, "required": false }, "interval": { "description": "Time interval to use for buckets in the returned data.", "type": "string", "default": "week", "enum": [ "hour", "day", "week", "month", "quarter", "year" ], "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "product_includes": { "description": "Limit result set to items that have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "product_excludes": { "description": "Limit result set to items that don't have the specified product(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order_includes": { "description": "Limit result set to items that have the specified order IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "order_excludes": { "description": "Limit result set to items that don't have the specified order IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "customer_includes": { "description": "Limit response to objects that have the specified customer IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "customer_excludes": { "description": "Limit response to objects that don't have the specified customer IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "ip_address_includes": { "description": "Limit response to objects that have a specified IP address.", "type": "array", "items": { "type": "string" }, "required": false }, "ip_address_excludes": { "description": "Limit response to objects that don't have a specified IP address.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/downloads\/stats" } ] } }, "\/wc-analytics\/reports\/customers": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date_registered", "enum": [ "username", "name", "first_name", "last_name", "email", "location", "country", "city", "state", "postcode", "date_registered", "date_last_active", "orders_count", "total_spend", "avg_order_value" ], "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "type": "string", "required": false }, "searchby": { "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "type": "string", "default": "name", "enum": [ "name", "username", "email", "all" ], "required": false }, "name_includes": { "description": "Limit response to objects with specific names.", "type": "string", "required": false }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "type": "string", "required": false }, "username_includes": { "description": "Limit response to objects with specific usernames.", "type": "string", "required": false }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "type": "string", "required": false }, "email_includes": { "description": "Limit response to objects including emails.", "type": "string", "required": false }, "email_excludes": { "description": "Limit response to objects excluding emails.", "type": "string", "required": false }, "country_includes": { "description": "Limit response to objects with specific countries.", "type": "string", "required": false }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "type": "string", "required": false }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "type": "integer", "required": false }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "type": "integer", "required": false }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "type": "array", "items": { "type": "integer" }, "required": false }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "type": "number", "required": false }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "type": "number", "required": false }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "type": "number", "required": false }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "type": "number", "required": false }, "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "customers": { "description": "Limit result to items with specified customer IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "users": { "description": "Limit result to items with specified user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "type": "array", "items": { "type": "string", "enum": [ "email", "name", "country", "city", "state", "postcode" ] }, "required": false }, "user_type": { "description": "Limit result to items with specified user type.", "type": "string", "default": "all", "enum": [ "all", "registered", "guest" ], "required": false }, "location_includes": { "description": "Includes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).", "type": "string", "required": false }, "location_excludes": { "description": "Excludes customers by location (state, country). Provide a comma-separated list of locations. Each location can be a country code (e.g. GB) or combination of country and state (e.g. US:CA).", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/customers" } ] } }, "\/wc-analytics\/reports\/customers\/stats": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "match": { "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "type": "string", "default": "all", "enum": [ "all", "any" ], "required": false }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "type": "string", "required": false }, "searchby": { "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "type": "string", "default": "name", "enum": [ "name", "username", "email", "all" ], "required": false }, "name_includes": { "description": "Limit response to objects with specific names.", "type": "string", "required": false }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "type": "string", "required": false }, "username_includes": { "description": "Limit response to objects with specific usernames.", "type": "string", "required": false }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "type": "string", "required": false }, "email_includes": { "description": "Limit response to objects including emails.", "type": "string", "required": false }, "email_excludes": { "description": "Limit response to objects excluding emails.", "type": "string", "required": false }, "country_includes": { "description": "Limit response to objects with specific countries.", "type": "string", "required": false }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "type": "string", "required": false }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "type": "array", "items": { "type": "string" }, "required": false }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "type": "integer", "required": false }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "type": "integer", "required": false }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "type": "array", "items": { "type": "integer" }, "required": false }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "type": "number", "required": false }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "type": "number", "required": false }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "type": "number", "required": false }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "type": "number", "required": false }, "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "type": "array", "items": { "type": "integer" }, "required": false }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "type": "string", "format": "date-time", "required": false }, "customers": { "description": "Limit result to items with specified customer IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "fields": { "description": "Limit stats fields to the specified items.", "type": "array", "items": { "type": "string" }, "required": false }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/customers\/stats" } ] } }, "\/wc-analytics\/imports\/status": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/imports\/status" } ] } }, "\/wc-analytics\/imports\/trigger": { "namespace": "wc-analytics", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/imports\/trigger" } ] } }, "\/wc-analytics\/reports\/performance-indicators": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "stats": { "description": "Limit response to specific report stats. Allowed values: .", "type": "array", "items": { "type": "string", "enum": [] }, "default": [], "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/performance-indicators" } ] } }, "\/wc-analytics\/reports\/performance-indicators\/allowed": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "stats": { "description": "Limit response to specific report stats. Allowed values: .", "type": "array", "items": { "type": "string", "enum": [] }, "default": [], "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/reports\/performance-indicators\/allowed" } ] } }, "\/wc-analytics\/admin\/notes": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "note_id", "date", "type", "title", "status" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "type": { "description": "Type of note.", "type": "array", "items": { "enum": [ "error", "warning", "update", "info", "marketing", "survey" ], "type": "string" }, "required": false }, "status": { "description": "Status of note.", "type": "array", "items": { "enum": [ "pending", "actioned", "unactioned", "snoozed", "sent" ], "type": "string" }, "required": false }, "source": { "description": "Source of note.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/admin\/notes" } ] } }, "\/wc-analytics\/admin\/notes\/(?P[\\d-]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false } } } ] }, "\/wc-analytics\/admin\/notes\/delete\/(?P[\\d-]+)": { "namespace": "wc-analytics", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ] }, "\/wc-analytics\/admin\/notes\/delete\/all": { "namespace": "wc-analytics", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": { "status": { "description": "Status of note.", "type": "array", "items": { "enum": [ "pending", "actioned", "unactioned", "snoozed", "sent" ], "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/admin\/notes\/delete\/all" } ] } }, "\/wc-analytics\/admin\/notes\/tracker\/(?P[\\d-]+)\/user\/(?P[\\d-]+)": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/wc-analytics\/admin\/notes\/update": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/admin\/notes\/update" } ] } }, "\/wc-analytics\/admin\/notes\/experimental-activate-promo\/(?P[\\w-]+)": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-analytics\/admin\/notes\/(?P[\\d-]+)\/action\/(?P[\\d-]+)": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "note_id": { "description": "Unique ID for the Note.", "type": "integer", "required": false }, "action_id": { "description": "Unique ID for the Note Action.", "type": "integer", "required": false } } } ] }, "\/wc-analytics\/coupons": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to coupons with codes matching a given string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "code": { "description": "Limit result set to resources with a specific code.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": true }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/coupons" } ] } }, "\/wc-analytics\/coupons\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "code": { "description": "Coupon code.", "type": "string", "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc-analytics\/coupons\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/coupons\/batch" } ] } }, "\/wc-analytics\/data": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/data" } ] } }, "\/wc-analytics\/data\/countries\/locales": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/data\/countries\/locales" } ] } }, "\/wc-analytics\/data\/countries": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/data\/countries" } ] } }, "\/wc-analytics\/data\/countries\/(?P[\\w-]+)": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "location": { "description": "ISO3166 alpha-2 country code.", "type": "string", "required": false } } } ] }, "\/wc-analytics\/data\/download-ips": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/data\/download-ips" } ] } }, "\/wc-analytics\/orders": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "status": { "default": [ "any" ], "description": "Limit result set to orders which have specific statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "trash", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ] }, "required": false }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "type": "integer", "required": false }, "product": { "description": "Limit result set to orders assigned a specific product.", "type": "integer", "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "type": "boolean", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "created_via": { "description": "Limit result set to orders created via specific sources (e.g. checkout, admin).", "type": "array", "items": { "type": "string" }, "required": false }, "number": { "description": "Limit result set to orders matching part of an order number.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "created_via": { "description": "Shows where the order was created.", "type": "string", "required": false }, "status": { "default": "pending", "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "manual_update": { "default": false, "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/orders" } ] } }, "\/wc-analytics\/orders\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "created_via": { "description": "Shows where the order was created.", "type": "string", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc-analytics\/orders\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "created_via": { "description": "Shows where the order was created.", "type": "string", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/orders\/batch" } ] } }, "\/wc-analytics\/products": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Search by similar product name or SKU.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "rand", "menu_order", "comment_count", "popularity", "rating", "post__in", "price", "sales", "random", "popularity", "rating", "menu_order", "price", "popularity", "rating" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "brand": { "description": "Limit result set to products assigned a specific brand ID.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a specific category ID.", "type": "string", "required": false }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "type": "string", "required": false }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "type": "string", "required": false }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name\/attribute slug.", "type": "string", "required": false }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "type": "string", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "search_sku": { "description": "Limit results to those with a SKU that partial matches a string. This argument takes precedence over 'sku'.", "type": "string", "required": false }, "search_name_or_sku": { "description": "Limit results to those with a name or SKU that partial matches a string. This argument takes precedence over 'search', 'sku' and 'search_sku'.", "type": "string", "required": false }, "search_fields": { "description": "Limit search to specific fields when used with search parameter. Available fields: name, sku, global_unique_id, description, short_description. This argument takes precedence over all other search parameters.", "type": "array", "items": { "type": "string", "enum": [ "name", "global_unique_id", "description", "short_description", "sku" ] }, "default": [], "required": false }, "include_status": { "description": "Limit result set to products with any of the statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "exclude_status": { "description": "Exclude products with any of the statuses from result set.", "type": "array", "items": { "type": "string", "enum": [ "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "include_types": { "description": "Limit result set to products with any of the types.", "type": "array", "items": { "type": "string", "enum": [ "simple", "grouped", "external", "variable" ] }, "required": false }, "exclude_types": { "description": "Exclude products with any of the types from result set.", "type": "array", "items": { "type": "string", "enum": [ "simple", "grouped", "external", "variable" ] }, "required": false }, "downloadable": { "description": "Limit result set to downloadable products.", "type": "boolean", "required": false }, "virtual": { "description": "Limit result set to virtual products.", "type": "boolean", "required": false }, "pos_products_only": { "description": "Limit result set to products visible in Point of Sale.", "type": "boolean", "required": false }, "low_in_stock": { "description": "Limit result set to products that are low or out of stock. (Deprecated)", "type": "boolean", "default": false, "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "default": "simple", "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "default": "publish", "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "default": false, "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "default": false, "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products" } ] } }, "\/wc-analytics\/products\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "type": "boolean", "required": false } } } ] }, "\/wc-analytics\/products\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/batch" } ] } }, "\/wc-analytics\/products\/(?P[\\d]+)\/related": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false } } } ] }, "\/wc-analytics\/products\/suggested-products": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "rand", "menu_order", "comment_count", "popularity", "rating", "post__in", "price", "sales", "random", "popularity", "rating", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "brand": { "description": "Limit result set to products assigned a specific brand ID.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a specific category ID.", "type": "string", "required": false }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "type": "string", "required": false }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "type": "string", "required": false }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name\/attribute slug.", "type": "string", "required": false }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "type": "string", "required": false }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "type": "boolean", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "categories": { "description": "Limit result set to specific product categorie ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "tags": { "description": "Limit result set to specific product tag ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "limit": { "description": "Limit result set to specific amount of suggested products.", "type": "integer", "default": 5, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/suggested-products" } ] } }, "\/wc-analytics\/products\/(?P[\\d]+)\/duplicate": { "namespace": "wc-analytics", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ] }, "\/wc-analytics\/products\/attributes": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "search": { "description": "Search by similar attribute name.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Name for the resource.", "type": "string", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "default": "select", "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "default": "menu_order", "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "default": false, "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/attributes" } ] } }, "\/wc-analytics\/products\/attributes\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": true, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc-analytics\/products\/attributes\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/attributes\/batch" } ] } }, "\/wc-analytics\/products\/attributes\/(?P[a-z0-9_\\-]+)": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "Slug identifier for the resource.", "type": "string", "required": false } } } ] }, "\/wc-analytics\/products\/attributes\/(?P[\\d]+)\/terms": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc-analytics\/products\/attributes\/(?P[\\d]+)\/terms\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc-analytics\/products\/attributes\/(?P[\\d]+)\/terms\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc-analytics\/products\/attributes\/(?P[a-z0-9_\\-]+)\/terms": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false } } } ] }, "\/wc-analytics\/products\/categories": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "default": "default", "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/categories" } ] } }, "\/wc-analytics\/products\/categories\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc-analytics\/products\/categories\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/categories\/batch" } ] } }, "\/wc-analytics\/products\/(?P[\\d]+)\/variations": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "has_price": { "description": "Limit result set to products with or without price.", "type": "boolean", "required": false }, "attributes": { "description": "Limit result set to products with specified attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Attribute slug." }, "term": { "type": "string", "description": "Attribute term." }, "terms": { "type": "array", "description": "Attribute terms." } } }, "required": false }, "virtual": { "description": "Limit result set to virtual product variations.", "type": "boolean", "required": false }, "downloadable": { "description": "Limit result set to downloadable product variations.", "type": "boolean", "required": false }, "include_status": { "description": "Limit result set to product variations with any of the statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "exclude_status": { "description": "Exclude product variations with any of the statuses from result set.", "type": "array", "items": { "type": "string", "enum": [ "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "pos_products_only": { "description": "Limit result set to variations visible in Point of Sale.", "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "type": { "default": "variation", "description": "Product type.", "type": "string", "enum": [ "variation" ], "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "default": "publish", "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "default": false, "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "name": { "description": "Product parent name.", "type": "string", "required": false } } } ] }, "\/wc-analytics\/products\/(?P[\\d]+)\/variations\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "variation" ], "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "name": { "description": "Product parent name.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc-analytics\/products\/(?P[\\d]+)\/variations\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "variation" ], "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "name": { "description": "Product parent name.", "type": "string", "required": false } } } ] }, "\/wc-analytics\/products\/(?P[\\d]+)\/variations\/generate": { "namespace": "wc-analytics", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "delete": { "description": "Deletes unused variations.", "type": "boolean", "required": false }, "default_values": { "description": "Default values for generated variations.", "type": "object", "properties": { "type": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Product type.", "type": "string", "enum": [ "variation" ] }, "description": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation description.", "type": "string" }, "sku": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Stock Keeping Unit.", "type": "string" }, "global_unique_id": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, "regular_price": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation regular price.", "type": "string" }, "sale_price": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation sale price.", "type": "string" }, "date_on_sale_from": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ] }, "date_on_sale_to": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ] }, "status": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ] }, "virtual": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "If the variation is virtual.", "type": "boolean" }, "downloadable": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } } }, "download_limit": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "download_expiry": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "tax_status": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ] }, "tax_class": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Tax class.", "type": "string" }, "manage_stock": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Stock management at variation level.", "type": [ "boolean", "string" ] }, "stock_quantity": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Stock quantity.", "type": "integer" }, "stock_status": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ] }, "backorders": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ] }, "low_stock_amount": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ] }, "weight": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation weight (kg).", "type": "string" }, "dimensions": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } } }, "shipping_class": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Shipping class slug.", "type": "string" }, "image": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "attributes": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } } }, "menu_order": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Menu order, used to custom sort products.", "type": "integer" }, "meta_data": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } }, "parent_id": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Product parent ID.", "type": "integer" }, "name": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Product parent name.", "type": "string" } }, "required": false }, "type": { "default": "variation", "description": "Product type.", "type": "string", "enum": [ "variation" ], "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "default": "publish", "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "default": false, "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "name": { "description": "Product parent name.", "type": "string", "required": false } } } ] }, "\/wc-analytics\/variations": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "has_price": { "description": "Limit result set to products with or without price.", "type": "boolean", "required": false }, "attributes": { "description": "Limit result set to products with specified attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Attribute slug." }, "term": { "type": "string", "description": "Attribute term." }, "terms": { "type": "array", "description": "Attribute terms." } } }, "required": false }, "virtual": { "description": "Limit result set to virtual product variations.", "type": "boolean", "required": false }, "downloadable": { "description": "Limit result set to downloadable product variations.", "type": "boolean", "required": false }, "include_status": { "description": "Limit result set to product variations with any of the statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "exclude_status": { "description": "Exclude product variations with any of the statuses from result set.", "type": "array", "items": { "type": "string", "enum": [ "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "pos_products_only": { "description": "Limit result set to variations visible in Point of Sale.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/variations" } ] } }, "\/wc-analytics\/products\/reviews": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date_gmt", "enum": [ "date", "date_gmt", "id", "include", "product" ], "required": false }, "reviewer": { "description": "Limit result set to reviews assigned to specific user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "reviewer_exclude": { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "reviewer_email": { "default": null, "description": "Limit result set to that from a specific author email.", "format": "email", "type": "string", "required": false }, "product": { "default": [], "description": "Limit result set to reviews assigned to specific product IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", "type": "string", "enum": [ "all", "hold", "approved", "spam", "trash" ], "required": false } } }, { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the product.", "type": "integer", "required": true }, "product_name": { "description": "Product name.", "type": "string", "required": false }, "status": { "default": "approved", "description": "Status of the review.", "type": "string", "enum": [ "approved", "hold", "spam", "unspam", "trash", "untrash" ], "required": false }, "reviewer": { "type": "string", "description": "Name of the reviewer.", "required": true }, "reviewer_email": { "type": "string", "description": "Email of the reviewer.", "required": true }, "review": { "type": "string", "description": "Review content.", "required": true }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/reviews" } ] } }, "\/wc-analytics\/products\/reviews\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "product_id": { "description": "Unique identifier for the product that the review belongs to.", "type": "integer", "required": false }, "product_name": { "description": "Product name.", "type": "string", "required": false }, "status": { "description": "Status of the review.", "type": "string", "enum": [ "approved", "hold", "spam", "unspam", "trash", "untrash" ], "required": false }, "reviewer": { "description": "Reviewer name.", "type": "string", "required": false }, "reviewer_email": { "description": "Reviewer email.", "type": "string", "format": "email", "required": false }, "review": { "description": "The content of the review.", "type": "string", "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc-analytics\/products\/reviews\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the product that the review belongs to.", "type": "integer", "required": false }, "product_name": { "description": "Product name.", "type": "string", "required": false }, "status": { "description": "Status of the review.", "type": "string", "enum": [ "approved", "hold", "spam", "unspam", "trash", "untrash" ], "required": false }, "reviewer": { "description": "Reviewer name.", "type": "string", "required": false }, "reviewer_email": { "description": "Reviewer email.", "type": "string", "format": "email", "required": false }, "review": { "description": "The content of the review.", "type": "string", "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/reviews\/batch" } ] } }, "\/wc-analytics\/products\/low-in-stock": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/low-in-stock" } ] } }, "\/wc-analytics\/products\/count-low-in-stock": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/products\/count-low-in-stock" } ] } }, "\/wc-analytics\/settings\/(?P[\\w-]+)": { "namespace": "wc-analytics", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false } } } ] }, "\/wc-analytics\/settings\/(?P[\\w-]+)\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "value": { "description": "Setting value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false } } } ] }, "\/wc-analytics\/settings\/(?P[\\w-]+)\/(?P[\\w-]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "value": { "description": "Setting value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false } } } ] }, "\/wc-analytics\/taxes": { "namespace": "wc-analytics", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "type": "string", "required": false }, "class": { "description": "Sort by tax class.", "enum": [ "standard", "reduced-rate", "zero-rate" ], "type": "string", "required": false }, "search": { "description": "Search by similar tax code.", "type": "string", "required": false }, "include": { "description": "Limit result set to items that have the specified rate ID(s) assigned.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false } } }, { "methods": [ "POST" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode\/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string", "required": false }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "default": 1, "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "default": "standard", "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false }, "postcodes": { "description": "List of postcodes \/ ZIPs. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false }, "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/taxes" } ] } }, "\/wc-analytics\/taxes\/(?P[\\d]+)": { "namespace": "wc-analytics", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode\/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string", "required": false }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false }, "postcodes": { "description": "List of postcodes \/ ZIPs. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false }, "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc-analytics\/taxes\/batch": { "namespace": "wc-analytics", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode\/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string", "required": false }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false }, "postcodes": { "description": "List of postcodes \/ ZIPs. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false }, "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-analytics\/taxes\/batch" } ] } }, "\/wc-admin\/launch-your-store\/initialize-coming-soon": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/launch-your-store\/initialize-coming-soon" } ] } }, "\/wc-admin\/launch-your-store\/update-survey-status": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "status": { "type": "string", "enum": [ "yes", "no" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/launch-your-store\/update-survey-status" } ] } }, "\/wc-admin\/launch-your-store\/survey-completed": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/launch-your-store\/survey-completed" } ] } }, "\/wc-admin\/launch-your-store\/woopayments\/test-orders\/count": { "namespace": "wc-admin", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/launch-your-store\/woopayments\/test-orders\/count" } ] } }, "\/wc-admin\/launch-your-store\/woopayments\/test-orders": { "namespace": "wc-admin", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/launch-your-store\/woopayments\/test-orders" } ] } }, "\/wc\/store": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc\/store", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store" } ] } }, "\/wc\/store\/batch": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "validation": { "type": "string", "enum": [ "require-all-validate", "normal" ], "default": "normal", "required": false }, "requests": { "type": "array", "maxItems": 25, "items": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH", "DELETE" ], "default": "POST" }, "path": { "type": "string", "required": true }, "body": { "type": "object", "properties": [], "additionalProperties": true }, "headers": { "type": "object", "properties": [], "additionalProperties": { "type": [ "string", "array" ], "items": { "type": "string" } } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/batch" } ] } }, "\/wc\/store\/cart": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart" } ] } }, "\/wc\/store\/cart\/add-item": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "The basket item product or variation ID.", "type": "integer", "required": false }, "quantity": { "description": "Quantity of this item to add to the basket.", "type": "number", "required": false }, "variation": { "description": "Chosen attributes (for variations).", "type": "array", "items": { "type": "object", "properties": { "attribute": { "description": "Variation attribute name.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Variation attribute value.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/add-item" } ] } }, "\/wc\/store\/cart\/apply-coupon": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/apply-coupon" } ] } }, "\/wc\/store\/cart\/coupons": { "namespace": "wc\/store", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "The coupon's unique code.", "type": "string", "required": false }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/coupons" } ] } }, "\/wc\/store\/cart\/coupons\/(?P[\\w-]+)": { "namespace": "wc\/store", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false } } } ] }, "\/wc\/store\/cart\/extensions": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "type": "string", "required": false }, "data": { "description": "Additional data to pass to the extension", "type": "object", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/extensions" } ] } }, "\/wc\/store\/cart\/items": { "namespace": "wc\/store", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "extensions": { "type": "object", "properties": [], "default": [], "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/items" } ] } }, "\/wc\/store\/cart\/items\/(?P[\\w-]{32})": { "namespace": "wc\/store", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "type": "string", "required": false }, "extensions": { "type": "object", "properties": [], "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "type": "string", "required": false } } } ] }, "\/wc\/store\/cart\/remove-coupon": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/remove-coupon" } ] } }, "\/wc\/store\/cart\/remove-item": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/remove-item" } ] } }, "\/wc\/store\/cart\/select-shipping-rate": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "type": [ "integer", "string", "null" ], "required": false }, "rate_id": { "description": "The chosen rate ID for the package.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/select-shipping-rate" } ] } }, "\/wc\/store\/cart\/update-item": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item to update.", "type": "string", "required": false }, "quantity": { "description": "New quantity of the item in the basket.", "type": "number", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/update-item" } ] } }, "\/wc\/store\/cart\/update-customer": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/cart\/update-customer" } ] } }, "\/wc\/store\/checkout": { "namespace": "wc\/store", "methods": [ "GET", "POST", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": [ "string", "boolean" ] } } }, "required": false }, "customer_password": { "description": "Customer password for new accounts, if applicable.", "type": "string", "required": false }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string", "required": false }, "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": true }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "type": "string", "enum": [ "", "bacs", "cheque", "cod" ], "required": false }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean", "required": false }, "additional_fields": { "description": "Additional fields to be persisted on the order.", "type": "object", "properties": [], "required": false }, "extensions": { "type": "object", "properties": { "woocommerce\/order-attribution": { "description": "Extension data registered by woocommerce\/order-attribution", "type": [ "object", "null" ], "context": [ "view", "edit" ], "properties": { "source_type": { "description": "Order attribution field: source_type", "type": [ "string", "null" ], "context": [] }, "referrer": { "description": "Order attribution field: referrer", "type": [ "string", "null" ], "context": [] }, "utm_campaign": { "description": "Order attribution field: utm_campaign", "type": [ "string", "null" ], "context": [] }, "utm_source": { "description": "Order attribution field: utm_source", "type": [ "string", "null" ], "context": [] }, "utm_medium": { "description": "Order attribution field: utm_medium", "type": [ "string", "null" ], "context": [] }, "utm_content": { "description": "Order attribution field: utm_content", "type": [ "string", "null" ], "context": [] }, "utm_id": { "description": "Order attribution field: utm_id", "type": [ "string", "null" ], "context": [] }, "utm_term": { "description": "Order attribution field: utm_term", "type": [ "string", "null" ], "context": [] }, "utm_source_platform": { "description": "Order attribution field: utm_source_platform", "type": [ "string", "null" ], "context": [] }, "utm_creative_format": { "description": "Order attribution field: utm_creative_format", "type": [ "string", "null" ], "context": [] }, "utm_marketing_tactic": { "description": "Order attribution field: utm_marketing_tactic", "type": [ "string", "null" ], "context": [] }, "session_entry": { "description": "Order attribution field: session_entry", "type": [ "string", "null" ], "context": [] }, "session_start_time": { "description": "Order attribution field: session_start_time", "type": [ "string", "null" ], "context": [] }, "session_pages": { "description": "Order attribution field: session_pages", "type": [ "string", "null" ], "context": [] }, "session_count": { "description": "Order attribution field: session_count", "type": [ "string", "null" ], "context": [] }, "user_agent": { "description": "Order attribution field: user_agent", "type": [ "string", "null" ], "context": [] } } } }, "default": { "woocommerce\/order-attribution": [] }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "additional_fields": { "description": "Additional fields to be persisted on the order.", "type": "object", "properties": [], "required": false }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "type": "string", "enum": [ "", "bacs", "cheque", "cod" ], "required": false }, "order_notes": { "description": "Order notes.", "type": "string", "required": false }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string", "required": false }, "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean", "required": false }, "extensions": { "type": "object", "properties": { "woocommerce\/order-attribution": { "description": "Extension data registered by woocommerce\/order-attribution", "type": [ "object", "null" ], "context": [ "view", "edit" ], "properties": { "source_type": { "description": "Order attribution field: source_type", "type": [ "string", "null" ], "context": [] }, "referrer": { "description": "Order attribution field: referrer", "type": [ "string", "null" ], "context": [] }, "utm_campaign": { "description": "Order attribution field: utm_campaign", "type": [ "string", "null" ], "context": [] }, "utm_source": { "description": "Order attribution field: utm_source", "type": [ "string", "null" ], "context": [] }, "utm_medium": { "description": "Order attribution field: utm_medium", "type": [ "string", "null" ], "context": [] }, "utm_content": { "description": "Order attribution field: utm_content", "type": [ "string", "null" ], "context": [] }, "utm_id": { "description": "Order attribution field: utm_id", "type": [ "string", "null" ], "context": [] }, "utm_term": { "description": "Order attribution field: utm_term", "type": [ "string", "null" ], "context": [] }, "utm_source_platform": { "description": "Order attribution field: utm_source_platform", "type": [ "string", "null" ], "context": [] }, "utm_creative_format": { "description": "Order attribution field: utm_creative_format", "type": [ "string", "null" ], "context": [] }, "utm_marketing_tactic": { "description": "Order attribution field: utm_marketing_tactic", "type": [ "string", "null" ], "context": [] }, "session_entry": { "description": "Order attribution field: session_entry", "type": [ "string", "null" ], "context": [] }, "session_start_time": { "description": "Order attribution field: session_start_time", "type": [ "string", "null" ], "context": [] }, "session_pages": { "description": "Order attribution field: session_pages", "type": [ "string", "null" ], "context": [] }, "session_count": { "description": "Order attribution field: session_count", "type": [ "string", "null" ], "context": [] }, "user_agent": { "description": "Order attribution field: user_agent", "type": [ "string", "null" ], "context": [] } } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/checkout" } ] } }, "\/wc\/store\/checkout\/(?P[\\d]+)": { "namespace": "wc\/store", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": [ "string", "boolean" ] } } }, "required": false }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string", "required": false }, "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": true }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "type": "string", "enum": [ "", "bacs", "cheque", "cod" ], "required": false }, "additional_fields": { "description": "Additional fields to be persisted on the order.", "type": "object", "properties": [], "required": false }, "extensions": { "type": "object", "properties": { "woocommerce\/order-attribution": { "description": "Extension data registered by woocommerce\/order-attribution", "type": [ "object", "null" ], "context": [ "view", "edit" ], "properties": { "source_type": { "description": "Order attribution field: source_type", "type": [ "string", "null" ], "context": [] }, "referrer": { "description": "Order attribution field: referrer", "type": [ "string", "null" ], "context": [] }, "utm_campaign": { "description": "Order attribution field: utm_campaign", "type": [ "string", "null" ], "context": [] }, "utm_source": { "description": "Order attribution field: utm_source", "type": [ "string", "null" ], "context": [] }, "utm_medium": { "description": "Order attribution field: utm_medium", "type": [ "string", "null" ], "context": [] }, "utm_content": { "description": "Order attribution field: utm_content", "type": [ "string", "null" ], "context": [] }, "utm_id": { "description": "Order attribution field: utm_id", "type": [ "string", "null" ], "context": [] }, "utm_term": { "description": "Order attribution field: utm_term", "type": [ "string", "null" ], "context": [] }, "utm_source_platform": { "description": "Order attribution field: utm_source_platform", "type": [ "string", "null" ], "context": [] }, "utm_creative_format": { "description": "Order attribution field: utm_creative_format", "type": [ "string", "null" ], "context": [] }, "utm_marketing_tactic": { "description": "Order attribution field: utm_marketing_tactic", "type": [ "string", "null" ], "context": [] }, "session_entry": { "description": "Order attribution field: session_entry", "type": [ "string", "null" ], "context": [] }, "session_start_time": { "description": "Order attribution field: session_start_time", "type": [ "string", "null" ], "context": [] }, "session_pages": { "description": "Order attribution field: session_pages", "type": [ "string", "null" ], "context": [] }, "session_count": { "description": "Order attribution field: session_count", "type": [ "string", "null" ], "context": [] }, "user_agent": { "description": "Order attribution field: user_agent", "type": [ "string", "null" ], "context": [] } } } }, "default": { "woocommerce\/order-attribution": [] }, "required": false } } } ] }, "\/wc\/store\/order\/(?P[\\d]+)": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/products\/attributes": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/products\/attributes" } ] } }, "\/wc\/store\/products\/attributes\/(?P[\\d]+)": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/products\/attributes\/(?P[\\d]+)\/terms": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "attribute_id": { "description": "Unique identifier for the attribute.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count", "menu_order", "name_num", "id" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ] }, "\/wc\/store\/products\/categories": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/products\/categories" } ] } }, "\/wc\/store\/products\/categories\/(?P[\\d]+)": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/products\/brands": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/products\/brands" } ] } }, "\/wc\/store\/products\/brands\/(?P[\\w-]+)": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "identifier": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/products\/collection-data": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "default": 10, "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "type": "string", "required": false }, "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "date_column": { "description": "When limiting response using after\/before, which date column to compare against.", "type": "string", "default": "date", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "modified", "id", "include", "title", "slug", "price", "popularity", "rating", "menu_order", "comment_count" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable", "variation" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a set of category IDs or slugs, separated by commas.", "type": "string", "required": false }, "category_operator": { "description": "Operator to compare product category terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "brand": { "description": "Limit result set to products assigned a set of brand IDs or slugs, separated by commas.", "type": "string", "required": false }, "brand_operator": { "description": "Operator to compare product brand terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "tag": { "description": "Limit result set to products assigned a set of tag IDs or slugs, separated by commas.", "type": "string", "required": false }, "tag_operator": { "description": "Operator to compare product tags.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "array", "items": { "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "sanitize_callback": "sanitize_text_field", "validate_callback": "rest_validate_request_arg" }, "default": [], "required": false }, "attributes": { "description": "Limit result set to products with selected global attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "description": "Attribute taxonomy name.", "type": "string", "sanitize_callback": "wc_sanitize_taxonomy_name" }, "term_id": { "description": "List of attribute term IDs.", "type": "array", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "type": "array", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list" }, "operator": { "description": "Operator to compare product attribute terms.", "type": "string", "enum": [ "in", "not_in", "and" ] } } }, "default": [], "required": false }, "attribute_relation": { "description": "The logical relationship between attributes when filtering across several at once.", "type": "string", "enum": [ "in", "and" ], "default": "and", "required": false }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "type": "string", "enum": [ "any", "visible", "catalog", "search", "hidden" ], "required": false }, "rating": { "description": "Limit result set to products with a certain average rating.", "type": "array", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5 ] }, "default": [], "required": false }, "calculate_price_range": { "description": "If true, calculates the minimum and maximum product prices for the collection.", "type": "boolean", "default": false, "required": false }, "calculate_stock_status_counts": { "description": "If true, calculates stock counts for products in the collection.", "type": "boolean", "default": false, "required": false }, "calculate_attribute_counts": { "description": "If requested, calculates attribute term counts for products in the collection.", "type": "array", "items": { "type": "object", "properties": { "taxonomy": { "description": "Taxonomy name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "query_type": { "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", "type": "string", "enum": [ "and", "or" ], "context": [ "view", "edit" ], "readonly": true } } }, "default": [], "required": false }, "calculate_rating_counts": { "description": "If true, calculates rating counts for products in the collection.", "type": "boolean", "default": false, "required": false }, "calculate_taxonomy_counts": { "description": "If requested, calculates taxonomy term counts for products in the collection.", "type": "array", "items": { "type": "string", "description": "Taxonomy name." }, "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/products\/collection-data" } ] } }, "\/wc\/store\/products\/reviews": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "default": 10, "minimum": 0, "maximum": 100, "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "date_gmt", "id", "rating", "product" ], "required": false }, "category_id": { "description": "Limit result set to reviews from specific category IDs.", "type": "string", "required": false }, "product_id": { "description": "Limit result set to reviews from specific product IDs.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/products\/reviews" } ] } }, "\/wc\/store\/products\/tags": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/products\/tags" } ] } }, "\/wc\/store\/products": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "default": 10, "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "type": "string", "required": false }, "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "date_column": { "description": "When limiting response using after\/before, which date column to compare against.", "type": "string", "default": "date", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "modified", "id", "include", "title", "slug", "price", "popularity", "rating", "menu_order", "comment_count" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable", "variation" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a set of category IDs or slugs, separated by commas.", "type": "string", "required": false }, "category_operator": { "description": "Operator to compare product category terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "brand": { "description": "Limit result set to products assigned a set of brand IDs or slugs, separated by commas.", "type": "string", "required": false }, "brand_operator": { "description": "Operator to compare product brand terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "tag": { "description": "Limit result set to products assigned a set of tag IDs or slugs, separated by commas.", "type": "string", "required": false }, "tag_operator": { "description": "Operator to compare product tags.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "array", "items": { "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "sanitize_callback": "sanitize_text_field", "validate_callback": "rest_validate_request_arg" }, "default": [], "required": false }, "attributes": { "description": "Limit result set to products with selected global attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "description": "Attribute taxonomy name.", "type": "string", "sanitize_callback": "wc_sanitize_taxonomy_name" }, "term_id": { "description": "List of attribute term IDs.", "type": "array", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "type": "array", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list" }, "operator": { "description": "Operator to compare product attribute terms.", "type": "string", "enum": [ "in", "not_in", "and" ] } } }, "default": [], "required": false }, "attribute_relation": { "description": "The logical relationship between attributes when filtering across several at once.", "type": "string", "enum": [ "in", "and" ], "default": "and", "required": false }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "type": "string", "enum": [ "any", "visible", "catalog", "search", "hidden" ], "required": false }, "rating": { "description": "Limit result set to products with a certain average rating.", "type": "array", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5 ] }, "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/products" } ] } }, "\/wc\/store\/products\/(?P[\\d]+)": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/products\/(?P[\\S]+)": { "namespace": "wc\/store", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "slug": { "description": "Slug of the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/v1": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc\/store\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1" } ] } }, "\/wc\/store\/v1\/batch": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "validation": { "type": "string", "enum": [ "require-all-validate", "normal" ], "default": "normal", "required": false }, "requests": { "type": "array", "maxItems": 25, "items": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH", "DELETE" ], "default": "POST" }, "path": { "type": "string", "required": true }, "body": { "type": "object", "properties": [], "additionalProperties": true }, "headers": { "type": "object", "properties": [], "additionalProperties": { "type": [ "string", "array" ], "items": { "type": "string" } } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/batch" } ] } }, "\/wc\/store\/v1\/cart": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart" } ] } }, "\/wc\/store\/v1\/cart\/add-item": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "The basket item product or variation ID.", "type": "integer", "required": false }, "quantity": { "description": "Quantity of this item to add to the basket.", "type": "number", "required": false }, "variation": { "description": "Chosen attributes (for variations).", "type": "array", "items": { "type": "object", "properties": { "attribute": { "description": "Variation attribute name.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Variation attribute value.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/add-item" } ] } }, "\/wc\/store\/v1\/cart\/apply-coupon": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/apply-coupon" } ] } }, "\/wc\/store\/v1\/cart\/coupons": { "namespace": "wc\/store\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "The coupon's unique code.", "type": "string", "required": false }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/coupons" } ] } }, "\/wc\/store\/v1\/cart\/coupons\/(?P[\\w-]+)": { "namespace": "wc\/store\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false } } } ] }, "\/wc\/store\/v1\/cart\/extensions": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "type": "string", "required": false }, "data": { "description": "Additional data to pass to the extension", "type": "object", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/extensions" } ] } }, "\/wc\/store\/v1\/cart\/items": { "namespace": "wc\/store\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "extensions": { "type": "object", "properties": [], "default": [], "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/items" } ] } }, "\/wc\/store\/v1\/cart\/items\/(?P[\\w-]{32})": { "namespace": "wc\/store\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "type": "string", "required": false }, "extensions": { "type": "object", "properties": [], "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "type": "string", "required": false } } } ] }, "\/wc\/store\/v1\/cart\/remove-coupon": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/remove-coupon" } ] } }, "\/wc\/store\/v1\/cart\/remove-item": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/remove-item" } ] } }, "\/wc\/store\/v1\/cart\/select-shipping-rate": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "type": [ "integer", "string", "null" ], "required": false }, "rate_id": { "description": "The chosen rate ID for the package.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/select-shipping-rate" } ] } }, "\/wc\/store\/v1\/cart\/update-item": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item to update.", "type": "string", "required": false }, "quantity": { "description": "New quantity of the item in the basket.", "type": "number", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/update-item" } ] } }, "\/wc\/store\/v1\/cart\/update-customer": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/cart\/update-customer" } ] } }, "\/wc\/store\/v1\/checkout": { "namespace": "wc\/store\/v1", "methods": [ "GET", "POST", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": [ "string", "boolean" ] } } }, "required": false }, "customer_password": { "description": "Customer password for new accounts, if applicable.", "type": "string", "required": false }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string", "required": false }, "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": true }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "type": "string", "enum": [ "", "bacs", "cheque", "cod" ], "required": false }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean", "required": false }, "additional_fields": { "description": "Additional fields to be persisted on the order.", "type": "object", "properties": [], "required": false }, "extensions": { "type": "object", "properties": { "woocommerce\/order-attribution": { "description": "Extension data registered by woocommerce\/order-attribution", "type": [ "object", "null" ], "context": [ "view", "edit" ], "properties": { "source_type": { "description": "Order attribution field: source_type", "type": [ "string", "null" ], "context": [] }, "referrer": { "description": "Order attribution field: referrer", "type": [ "string", "null" ], "context": [] }, "utm_campaign": { "description": "Order attribution field: utm_campaign", "type": [ "string", "null" ], "context": [] }, "utm_source": { "description": "Order attribution field: utm_source", "type": [ "string", "null" ], "context": [] }, "utm_medium": { "description": "Order attribution field: utm_medium", "type": [ "string", "null" ], "context": [] }, "utm_content": { "description": "Order attribution field: utm_content", "type": [ "string", "null" ], "context": [] }, "utm_id": { "description": "Order attribution field: utm_id", "type": [ "string", "null" ], "context": [] }, "utm_term": { "description": "Order attribution field: utm_term", "type": [ "string", "null" ], "context": [] }, "utm_source_platform": { "description": "Order attribution field: utm_source_platform", "type": [ "string", "null" ], "context": [] }, "utm_creative_format": { "description": "Order attribution field: utm_creative_format", "type": [ "string", "null" ], "context": [] }, "utm_marketing_tactic": { "description": "Order attribution field: utm_marketing_tactic", "type": [ "string", "null" ], "context": [] }, "session_entry": { "description": "Order attribution field: session_entry", "type": [ "string", "null" ], "context": [] }, "session_start_time": { "description": "Order attribution field: session_start_time", "type": [ "string", "null" ], "context": [] }, "session_pages": { "description": "Order attribution field: session_pages", "type": [ "string", "null" ], "context": [] }, "session_count": { "description": "Order attribution field: session_count", "type": [ "string", "null" ], "context": [] }, "user_agent": { "description": "Order attribution field: user_agent", "type": [ "string", "null" ], "context": [] } } } }, "default": { "woocommerce\/order-attribution": [] }, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "allow_batch": { "v1": true }, "args": { "additional_fields": { "description": "Additional fields to be persisted on the order.", "type": "object", "properties": [], "required": false }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "type": "string", "enum": [ "", "bacs", "cheque", "cod" ], "required": false }, "order_notes": { "description": "Order notes.", "type": "string", "required": false }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string", "required": false }, "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "type": "boolean", "required": false }, "extensions": { "type": "object", "properties": { "woocommerce\/order-attribution": { "description": "Extension data registered by woocommerce\/order-attribution", "type": [ "object", "null" ], "context": [ "view", "edit" ], "properties": { "source_type": { "description": "Order attribution field: source_type", "type": [ "string", "null" ], "context": [] }, "referrer": { "description": "Order attribution field: referrer", "type": [ "string", "null" ], "context": [] }, "utm_campaign": { "description": "Order attribution field: utm_campaign", "type": [ "string", "null" ], "context": [] }, "utm_source": { "description": "Order attribution field: utm_source", "type": [ "string", "null" ], "context": [] }, "utm_medium": { "description": "Order attribution field: utm_medium", "type": [ "string", "null" ], "context": [] }, "utm_content": { "description": "Order attribution field: utm_content", "type": [ "string", "null" ], "context": [] }, "utm_id": { "description": "Order attribution field: utm_id", "type": [ "string", "null" ], "context": [] }, "utm_term": { "description": "Order attribution field: utm_term", "type": [ "string", "null" ], "context": [] }, "utm_source_platform": { "description": "Order attribution field: utm_source_platform", "type": [ "string", "null" ], "context": [] }, "utm_creative_format": { "description": "Order attribution field: utm_creative_format", "type": [ "string", "null" ], "context": [] }, "utm_marketing_tactic": { "description": "Order attribution field: utm_marketing_tactic", "type": [ "string", "null" ], "context": [] }, "session_entry": { "description": "Order attribution field: session_entry", "type": [ "string", "null" ], "context": [] }, "session_start_time": { "description": "Order attribution field: session_start_time", "type": [ "string", "null" ], "context": [] }, "session_pages": { "description": "Order attribution field: session_pages", "type": [ "string", "null" ], "context": [] }, "session_count": { "description": "Order attribution field: session_count", "type": [ "string", "null" ], "context": [] }, "user_agent": { "description": "Order attribution field: user_agent", "type": [ "string", "null" ], "context": [] } } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/checkout" } ] } }, "\/wc\/store\/v1\/checkout\/(?P[\\d]+)": { "namespace": "wc\/store\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": [ "string", "boolean" ] } } }, "required": false }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "type": "string", "required": false }, "billing_address": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true }, "email": { "description": "Email", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": true }, "shipping_address": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name", "type": "string", "context": [ "view", "edit" ], "required": true }, "last_name": { "description": "Last name", "type": "string", "context": [ "view", "edit" ], "required": true }, "company": { "description": "Company", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_1": { "description": "Address", "type": "string", "context": [ "view", "edit" ], "required": true }, "address_2": { "description": "Flat, suite, etc.", "type": "string", "context": [ "view", "edit" ], "required": true }, "city": { "description": "City", "type": "string", "context": [ "view", "edit" ], "required": true }, "state": { "description": "State\/County code, or name of the state, county, province, or district.", "type": "string", "context": [ "view", "edit" ], "required": true }, "postcode": { "description": "Postcode", "type": "string", "context": [ "view", "edit" ], "required": true }, "country": { "description": "Country\/Region code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ], "required": true }, "phone": { "description": "Phone", "type": "string", "context": [ "view", "edit" ], "required": true } }, "required": false }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "type": "string", "enum": [ "", "bacs", "cheque", "cod" ], "required": false }, "additional_fields": { "description": "Additional fields to be persisted on the order.", "type": "object", "properties": [], "required": false }, "extensions": { "type": "object", "properties": { "woocommerce\/order-attribution": { "description": "Extension data registered by woocommerce\/order-attribution", "type": [ "object", "null" ], "context": [ "view", "edit" ], "properties": { "source_type": { "description": "Order attribution field: source_type", "type": [ "string", "null" ], "context": [] }, "referrer": { "description": "Order attribution field: referrer", "type": [ "string", "null" ], "context": [] }, "utm_campaign": { "description": "Order attribution field: utm_campaign", "type": [ "string", "null" ], "context": [] }, "utm_source": { "description": "Order attribution field: utm_source", "type": [ "string", "null" ], "context": [] }, "utm_medium": { "description": "Order attribution field: utm_medium", "type": [ "string", "null" ], "context": [] }, "utm_content": { "description": "Order attribution field: utm_content", "type": [ "string", "null" ], "context": [] }, "utm_id": { "description": "Order attribution field: utm_id", "type": [ "string", "null" ], "context": [] }, "utm_term": { "description": "Order attribution field: utm_term", "type": [ "string", "null" ], "context": [] }, "utm_source_platform": { "description": "Order attribution field: utm_source_platform", "type": [ "string", "null" ], "context": [] }, "utm_creative_format": { "description": "Order attribution field: utm_creative_format", "type": [ "string", "null" ], "context": [] }, "utm_marketing_tactic": { "description": "Order attribution field: utm_marketing_tactic", "type": [ "string", "null" ], "context": [] }, "session_entry": { "description": "Order attribution field: session_entry", "type": [ "string", "null" ], "context": [] }, "session_start_time": { "description": "Order attribution field: session_start_time", "type": [ "string", "null" ], "context": [] }, "session_pages": { "description": "Order attribution field: session_pages", "type": [ "string", "null" ], "context": [] }, "session_count": { "description": "Order attribution field: session_count", "type": [ "string", "null" ], "context": [] }, "user_agent": { "description": "Order attribution field: user_agent", "type": [ "string", "null" ], "context": [] } } } }, "default": { "woocommerce\/order-attribution": [] }, "required": false } } } ] }, "\/wc\/store\/v1\/order\/(?P[\\d]+)": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/v1\/products\/attributes": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/products\/attributes" } ] } }, "\/wc\/store\/v1\/products\/attributes\/(?P[\\d]+)": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/v1\/products\/attributes\/(?P[\\d]+)\/terms": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "attribute_id": { "description": "Unique identifier for the attribute.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count", "menu_order", "name_num", "id" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ] }, "\/wc\/store\/v1\/products\/categories": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/products\/categories" } ] } }, "\/wc\/store\/v1\/products\/categories\/(?P[\\d]+)": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/v1\/products\/brands": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/products\/brands" } ] } }, "\/wc\/store\/v1\/products\/brands\/(?P[\\w-]+)": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "identifier": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/v1\/products\/collection-data": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "default": 10, "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "type": "string", "required": false }, "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "date_column": { "description": "When limiting response using after\/before, which date column to compare against.", "type": "string", "default": "date", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "modified", "id", "include", "title", "slug", "price", "popularity", "rating", "menu_order", "comment_count" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable", "variation" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a set of category IDs or slugs, separated by commas.", "type": "string", "required": false }, "category_operator": { "description": "Operator to compare product category terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "brand": { "description": "Limit result set to products assigned a set of brand IDs or slugs, separated by commas.", "type": "string", "required": false }, "brand_operator": { "description": "Operator to compare product brand terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "tag": { "description": "Limit result set to products assigned a set of tag IDs or slugs, separated by commas.", "type": "string", "required": false }, "tag_operator": { "description": "Operator to compare product tags.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "array", "items": { "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "sanitize_callback": "sanitize_text_field", "validate_callback": "rest_validate_request_arg" }, "default": [], "required": false }, "attributes": { "description": "Limit result set to products with selected global attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "description": "Attribute taxonomy name.", "type": "string", "sanitize_callback": "wc_sanitize_taxonomy_name" }, "term_id": { "description": "List of attribute term IDs.", "type": "array", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "type": "array", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list" }, "operator": { "description": "Operator to compare product attribute terms.", "type": "string", "enum": [ "in", "not_in", "and" ] } } }, "default": [], "required": false }, "attribute_relation": { "description": "The logical relationship between attributes when filtering across several at once.", "type": "string", "enum": [ "in", "and" ], "default": "and", "required": false }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "type": "string", "enum": [ "any", "visible", "catalog", "search", "hidden" ], "required": false }, "rating": { "description": "Limit result set to products with a certain average rating.", "type": "array", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5 ] }, "default": [], "required": false }, "calculate_price_range": { "description": "If true, calculates the minimum and maximum product prices for the collection.", "type": "boolean", "default": false, "required": false }, "calculate_stock_status_counts": { "description": "If true, calculates stock counts for products in the collection.", "type": "boolean", "default": false, "required": false }, "calculate_attribute_counts": { "description": "If requested, calculates attribute term counts for products in the collection.", "type": "array", "items": { "type": "object", "properties": { "taxonomy": { "description": "Taxonomy name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "query_type": { "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", "type": "string", "enum": [ "and", "or" ], "context": [ "view", "edit" ], "readonly": true } } }, "default": [], "required": false }, "calculate_rating_counts": { "description": "If true, calculates rating counts for products in the collection.", "type": "boolean", "default": false, "required": false }, "calculate_taxonomy_counts": { "description": "If requested, calculates taxonomy term counts for products in the collection.", "type": "array", "items": { "type": "string", "description": "Taxonomy name." }, "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/products\/collection-data" } ] } }, "\/wc\/store\/v1\/products\/reviews": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "default": 10, "minimum": 0, "maximum": 100, "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "date_gmt", "id", "rating", "product" ], "required": false }, "category_id": { "description": "Limit result set to reviews from specific category IDs.", "type": "string", "required": false }, "product_id": { "description": "Limit result set to reviews from specific product IDs.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/products\/reviews" } ] } }, "\/wc\/store\/v1\/products\/tags": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "order": { "description": "Sort ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort by term property.", "type": "string", "default": "name", "enum": [ "name", "slug", "count" ], "required": false }, "hide_empty": { "description": "If true, empty terms will not be returned.", "type": "boolean", "default": true, "required": false }, "parent": { "description": "Limit results to terms with a specific parent (hierarchical taxonomies only).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/products\/tags" } ] } }, "\/wc\/store\/v1\/products": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "type": "integer", "default": 10, "minimum": 0, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "type": "string", "required": false }, "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "date_column": { "description": "When limiting response using after\/before, which date column to compare against.", "type": "string", "default": "date", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "modified", "id", "include", "title", "slug", "price", "popularity", "rating", "menu_order", "comment_count" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable", "variation" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a set of category IDs or slugs, separated by commas.", "type": "string", "required": false }, "category_operator": { "description": "Operator to compare product category terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "brand": { "description": "Limit result set to products assigned a set of brand IDs or slugs, separated by commas.", "type": "string", "required": false }, "brand_operator": { "description": "Operator to compare product brand terms.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "tag": { "description": "Limit result set to products assigned a set of tag IDs or slugs, separated by commas.", "type": "string", "required": false }, "tag_operator": { "description": "Operator to compare product tags.", "type": "string", "enum": [ "in", "not_in", "and" ], "default": "in", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "type": "string", "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "array", "items": { "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "sanitize_callback": "sanitize_text_field", "validate_callback": "rest_validate_request_arg" }, "default": [], "required": false }, "attributes": { "description": "Limit result set to products with selected global attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "description": "Attribute taxonomy name.", "type": "string", "sanitize_callback": "wc_sanitize_taxonomy_name" }, "term_id": { "description": "List of attribute term IDs.", "type": "array", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "type": "array", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list" }, "operator": { "description": "Operator to compare product attribute terms.", "type": "string", "enum": [ "in", "not_in", "and" ] } } }, "default": [], "required": false }, "attribute_relation": { "description": "The logical relationship between attributes when filtering across several at once.", "type": "string", "enum": [ "in", "and" ], "default": "and", "required": false }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "type": "string", "enum": [ "any", "visible", "catalog", "search", "hidden" ], "required": false }, "rating": { "description": "Limit result set to products with a certain average rating.", "type": "array", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5 ] }, "default": [], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/store\/v1\/products" } ] } }, "\/wc\/store\/v1\/products\/(?P[\\d]+)": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/store\/v1\/products\/(?P[\\S]+)": { "namespace": "wc\/store\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "slug": { "description": "Slug of the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/private": { "namespace": "wc\/private", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc\/private", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/private" } ] } }, "\/wc\/private\/patterns": { "namespace": "wc\/private", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/private\/patterns" } ] } }, "\/wc\/v2": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc\/v2", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2" } ] } }, "\/wc\/v2\/products\/brands": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "default": "default", "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/brands" } ] } }, "\/wc\/v2\/products\/brands\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/products\/brands\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/brands\/batch" } ] } }, "\/wc\/v3\/products\/brands": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "default": "default", "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/brands" } ] } }, "\/wc\/v3\/products\/brands\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/products\/brands\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/brands\/batch" } ] } }, "\/redux\/descriptors\/v1": { "namespace": "redux\/descriptors\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "redux\/descriptors\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/redux\/descriptors\/v1" } ] } }, "\/redux\/descriptors\/v1\/fields": { "namespace": "redux\/descriptors\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/redux\/descriptors\/v1\/fields" } ] } }, "\/redux\/descriptors\/v1\/field\/(?P[a-z0-9-_]+)": { "namespace": "redux\/descriptors\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "type": { "description": "The field type", "type": "string", "required": false } } } ] }, "\/redux\/descriptors\/v1\/field\/(?P[a-z0-9-_]+)\/render": { "namespace": "redux\/descriptors\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "args": { "name": { "description": "The field type", "type": "string", "required": false } } } ] }, "\/google-site-kit\/v1": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "google-site-kit\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/setup-tag": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/setup-tag" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/connection": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/connection" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/authentication": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/authentication" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/disconnect": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/disconnect" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/get-token": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/get-token" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/user-input-settings": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "settings": { "type": "object", "required": true, "questions": { "purpose": { "type": "array", "items": { "type": "string" } }, "postFrequency": { "type": "array", "items": { "type": "string" } }, "goals": { "type": "array", "items": { "type": "string" } }, "includeConversionEvents": { "type": "array", "items": { "type": "string" } } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/user-input-settings" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/audience-settings": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "settings": { "type": "object", "required": true, "minProperties": 1, "additionalProperties": false, "properties": { "configuredAudiences": { "type": "array", "items": { "type": "string" } }, "isAudienceSegmentationWidgetHidden": { "type": "boolean" }, "didSetAudiences": { "type": "boolean" } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/audience-settings" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/conversion-reporting-settings": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "settings": { "type": "object", "required": true, "minProperties": 1, "additionalProperties": false, "properties": { "newEventsCalloutDismissedAt": { "type": "integer" }, "lostEventsCalloutDismissedAt": { "type": "integer" } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/conversion-reporting-settings" } ] } }, "\/google-site-kit\/v1\/core\/modules\/data\/list": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/list" } ] } }, "\/google-site-kit\/v1\/core\/modules\/data\/activation": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "data": { "type": "object", "description": "", "default": null, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/activation" } ] } }, "\/google-site-kit\/v1\/core\/modules\/data\/info": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/info" } ] } }, "\/google-site-kit\/v1\/core\/modules\/data\/check-access": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/check-access" } ] } }, "\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/notifications": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false } } } ] }, "\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/settings": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false }, "data": { "type": "object", "description": "Settings to set.", "default": null, "required": false } } } ] }, "\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/data-available": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false } } } ] }, "\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/(?P[a-z\\-]+)": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false }, "datapoint": { "type": "string", "description": "Module data point to address.", "default": null, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "slug": { "type": "string", "description": "Identifier for the module.", "default": null, "required": false }, "datapoint": { "type": "string", "description": "Module data point to address.", "default": null, "required": false }, "data": { "type": "object", "description": "Data to set.", "default": null, "required": false } } } ] }, "\/google-site-kit\/v1\/core\/modules\/data\/recover-modules": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/recover-modules" } ] } }, "\/google-site-kit\/v1\/core\/modules\/data\/sharing-settings": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "data": { "type": "object", "description": "", "default": null, "required": true } } }, { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/sharing-settings" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/dismissed-items": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "DELETE" ], "args": { "data": { "type": "object", "description": "", "default": null, "minProperties": 1, "additionalProperties": false, "properties": { "slugs": { "type": "array", "required": true, "items": { "type": "string" } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismissed-items" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/dismiss-item": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismiss-item" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/expirable-items": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/expirable-items" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/set-expirable-item-timers": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "data": { "type": "array", "description": "", "default": null, "items": { "type": "object", "additionalProperties": false, "properties": { "slug": { "type": "string", "required": true }, "expiration": { "type": "integer", "required": true } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/set-expirable-item-timers" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/permissions": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/permissions" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/nonces": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/nonces" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/survey-trigger": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "triggerID": { "type": "string", "required": true }, "ttl": { "type": "integer", "minimum": 0 } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey-trigger" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/survey-event": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "session": { "type": "object", "required": true, "properties": { "session_id": { "type": "string", "required": true }, "session_token": { "type": "string", "required": true } } }, "event": { "type": "object", "required": true, "properties": { "survey_shown": { "type": "object" }, "survey_closed": { "type": "object" }, "question_answered": { "type": "object" }, "completion_shown": { "type": "object" }, "follow_up_link_clicked": { "type": "object" } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey-event" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/survey-timeouts": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey-timeouts" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/survey": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/reset": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/reset" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/reset-persistent": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/reset-persistent" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/developer-plugin": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/developer-plugin" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/tracking": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "enabled": { "type": "boolean", "required": true } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/tracking" } ] } }, "\/google-site-kit\/v1\/core\/search\/data\/entity-search": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "query": { "type": "string", "description": "Text content to search for.", "default": null, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/search\/data\/entity-search" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/admin-bar-settings": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "enabled": { "type": "boolean", "required": false } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/admin-bar-settings" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/notifications": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/notifications" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/mark-notification": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "data": { "type": "object", "description": "", "default": null, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/mark-notification" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/site-health-tag-placement-test": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/site-health-tag-placement-test" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/health-checks": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/health-checks" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/dismissed-tours": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismissed-tours" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/dismiss-tour": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismiss-tour" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/key-metrics": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "settings": { "type": "object", "required": true, "properties": { "isWidgetHidden": { "type": "boolean", "required": true }, "widgetSlugs": { "type": "array", "required": false, "maxItems": 8, "items": { "type": "string" } } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/key-metrics" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/dismissed-prompts": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismissed-prompts" } ] } }, "\/google-site-kit\/v1\/core\/user\/data\/dismiss-prompt": { "namespace": "google-site-kit\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "data": { "type": "object", "description": "", "default": null, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismiss-prompt" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/consent-mode": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "settings": { "type": "object", "required": true, "minProperties": 1, "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "regions": { "type": "array", "items": { "type": "string" } } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/consent-mode" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/consent-api-info": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/consent-api-info" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/consent-api-activate": { "namespace": "google-site-kit\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/consent-api-activate" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/ads-measurement-status": { "namespace": "google-site-kit\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/ads-measurement-status" } ] } }, "\/google-site-kit\/v1\/core\/site\/data\/conversion-tracking": { "namespace": "google-site-kit\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "data": { "type": "object", "description": "", "default": null, "properties": { "settings": { "type": "object", "required": true, "properties": { "enabled": { "type": "boolean", "required": true } } } }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/google-site-kit\/v1\/core\/site\/data\/conversion-tracking" } ] } }, "\/jet-engine\/v2": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "jet-engine\/v2", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2" } ] } }, "\/jet-engine\/v2\/search-posts": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "query": { "default": "", "required": false }, "ids": { "default": "", "required": false }, "post_type": { "default": "any", "required": false }, "tax": { "default": "", "required": false }, "search_terms": { "default": false, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/search-posts" } ] } }, "\/jet-engine\/v2\/add-item": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/add-item" } ] } }, "\/jet-engine\/v2\/edit-item\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/delete-item\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ] }, "\/jet-engine\/v2\/get-item\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/get-items": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/get-items" } ] } }, "\/jet-engine\/v2\/add-post-type": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/add-post-type" } ] } }, "\/jet-engine\/v2\/edit-post-type\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/get-post-type\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/delete-post-type\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": { "action": { "default": "none", "required": true }, "to_post_type": { "default": "", "required": false } } } ] }, "\/jet-engine\/v2\/get-post-types": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/get-post-types" } ] } }, "\/jet-engine\/v2\/get-built-in-post-type\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/edit-built-in-post-type\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/reset-built-in-post-type\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ] }, "\/jet-engine\/v2\/copy-post-type\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/add-meta-box": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/add-meta-box" } ] } }, "\/jet-engine\/v2\/edit-meta-box\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/get-meta-box\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/get-meta-boxes": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/get-meta-boxes" } ] } }, "\/jet-engine\/v2\/delete-meta-box\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ] }, "\/jet-engine\/v2\/add-taxonomy": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/add-taxonomy" } ] } }, "\/jet-engine\/v2\/edit-taxonomy\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/get-taxonomy\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/delete-taxonomy\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": { "action": { "default": "none", "required": true } } } ] }, "\/jet-engine\/v2\/get-taxonomies": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/get-taxonomies" } ] } }, "\/jet-engine\/v2\/get-built-in-tax\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/edit-built-in-tax\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/reset-built-in-tax\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ] }, "\/jet-engine\/v2\/copy-taxonomy\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/add-relation": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/add-relation" } ] } }, "\/jet-engine\/v2\/edit-relation\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/get-relation\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/delete-relation\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ] }, "\/jet-engine\/v2\/get-relations": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/get-relations" } ] } }, "\/jet-engine\/v2\/add-options-page": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/add-options-page" } ] } }, "\/jet-engine\/v2\/edit-options-page\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/get-options-page\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/delete-options-page\/(?P[\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": { "action": { "default": "none", "required": true } } } ] }, "\/jet-engine\/v2\/get-options-pages": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/get-options-pages" } ] } }, "\/jet-engine\/v2\/search-glossary-fields": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "query": { "default": "", "required": false }, "glossary_id": { "default": "", "required": true }, "values": { "default": "", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/search-glossary-fields" } ] } }, "\/jet-engine\/v2\/add-query": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/add-query" } ] } }, "\/jet-engine\/v2\/edit-query\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/jet-engine\/v2\/get-query\/(?P[a-z\\-\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/jet-engine\/v2\/delete-query\/(?P[a-z\\-\\_\\d]+)": { "namespace": "jet-engine\/v2", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ] }, "\/jet-engine\/v2\/get-queries": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/get-queries" } ] } }, "\/jet-engine\/v2\/search-query-preview": { "namespace": "jet-engine\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "_s": { "default": "", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/search-query-preview" } ] } }, "\/jet-engine\/v2\/update-query-preview": { "namespace": "jet-engine\/v2", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jet-engine\/v2\/update-query-preview" } ] } }, "\/elementor\/v1\/documents": { "namespace": "elementor\/v1\/documents", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "elementor\/v1\/documents", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/documents" } ] } }, "\/elementor\/v1\/documents\/(?P\\d+)\/media\/import": { "namespace": "elementor\/v1\/documents", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "required": true } } } ] }, "\/elementor\/v1\/cache": { "namespace": "elementor\/v1", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/cache" } ] } }, "\/elementor\/v1\/globals": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/globals" } ] } }, "\/elementor\/v1\/globals\/colors": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/globals\/colors" } ] } }, "\/elementor\/v1\/globals\/colors\/(?P[\\w]+)": { "namespace": "elementor\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } }, { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } } ] }, "\/elementor\/v1\/globals\/typography": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/globals\/typography" } ] } }, "\/elementor\/v1\/globals\/typography\/(?P[\\w]+)": { "namespace": "elementor\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } }, { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } } ] }, "\/elementor\/v1\/settings\/(?P[\\w_-]+)": { "namespace": "elementor\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/elementor\/v1\/post": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "included_types": { "description": "Included post types", "type": "array", "default": null, "required": false }, "excluded_types": { "description": "Post type to exclude", "type": "array", "default": [ "e-floating-buttons", "e-landing-page", "elementor_library", "attachment", "revision", "nav_menu_item", "custom_css", "customize_changeset" ], "required": false }, "term": { "description": "Posts to search", "type": "string", "default": "", "required": false }, "keys_conversion_map": { "description": "Specify keys to extract and convert, i.e. [\"key_1\" => \"new_key_1\"].", "type": "array", "default": { "ID": "id", "post_title": "label", "post_type": "groupLabel" }, "required": false }, "items_count": { "description": "Posts per page", "type": "integer", "default": 100, "required": false }, "is_public": { "description": "Whether to include only public post types", "type": "boolean", "default": true, "required": false }, "meta_query": { "description": "WP_Query meta_query array", "type": "array", "default": null, "required": false }, "tax_query": { "description": "WP_Query tax_query array", "type": "array", "default": null, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/post" } ] } }, "\/elementor\/v1\/term": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "included_types": { "description": "Included taxonomy containing terms (categories, tags, etc...)", "type": "array", "default": null, "required": false }, "excluded_types": { "description": "Excluded taxonomy containing terms (categories, tags, etc...)", "type": "array", "default": null, "required": false }, "term": { "description": "Terms to search", "type": "string", "default": "", "required": false }, "keys_conversion_map": { "description": "Specify keys to extract and convert, i.e. [\"key_1\" => \"new_key_1\"].", "type": "array", "default": { "term_id": "id", "name": "label", "taxonomy": "groupLabel" }, "required": false }, "items_count": { "description": "Terms per request", "type": "integer", "default": 100, "required": false }, "hide_empty": { "description": "Whether to include only public terms", "type": "boolean", "default": false, "required": false }, "meta_query": { "description": "WP_Query meta_query array", "type": "array", "default": null, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/term" } ] } }, "\/elementor\/v1\/user": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "term": { "description": "Posts to search", "type": "string", "default": "", "required": false }, "keys_conversion_map": { "description": "Specify keys to extract and convert, i.e. [\"key_1\" => \"new_key_1\"].", "type": [ "array", "string" ], "default": { "ID": "id", "display_name": "label", "role": "groupLabel" }, "required": false }, "items_count": { "description": "Posts per page", "type": "integer", "default": 100, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/user" } ] } }, "\/elementor-ai\/v1": { "namespace": "elementor-ai\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "elementor-ai\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-ai\/v1" } ] } }, "\/elementor-ai\/v1\/permissions": { "namespace": "elementor-ai\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-ai\/v1\/permissions" } ] } }, "\/elementor\/v1\/favorites": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/favorites" } ] } }, "\/elementor\/v1\/favorites\/(?P[\\w]+)": { "namespace": "elementor\/v1", "methods": [ "POST", "DELETE" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "description": "Type of favorites.", "type": "string", "required": true }, "favorite": { "description": "The favorite slug to create.", "type": "string", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Type of favorites.", "type": "string", "required": true }, "favorite": { "description": "The favorite slug to delete.", "type": "string", "required": true } } } ] }, "\/elementor\/v1\/kit-elements-defaults": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/kit-elements-defaults" } ] } }, "\/elementor\/v1\/kit-elements-defaults\/(?P[\\w\\-\\_]+)": { "namespace": "elementor\/v1", "methods": [ "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "type": { "type": "string", "description": "The type of the element.", "required": true }, "settings": { "description": "All the default values for the requested type", "type": "object", "required": true } } }, { "methods": [ "DELETE" ], "args": { "type": { "type": "string", "description": "The type of the element.", "required": true } } } ] }, "\/elementor\/v1\/site-navigation\/recent-posts": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "posts_per_page": { "description": "Number of posts to return", "type": "integer", "required": true }, "post_type": { "description": "Post types to retrieve", "type": "array", "default": [ "page", "post", "elementor_library" ], "required": false }, "post__not_in": { "description": "Post id`s to exclude", "type": "array", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/site-navigation\/recent-posts" } ] } }, "\/elementor\/v1\/site-navigation\/add-new-post": { "namespace": "elementor\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "post_type": { "description": "Post type to create", "type": "string", "default": "post", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/site-navigation\/add-new-post" } ] } }, "\/elementor\/v1\/checklist": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/checklist" } ] } }, "\/elementor\/v1\/checklist\/(?P[\\d]+)": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } } ] }, "\/elementor\/v1\/checklist\/steps": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/checklist\/steps" } ] } }, "\/elementor\/v1\/checklist\/steps\/(?P[\\d]+)": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } } ] }, "\/elementor\/v1\/checklist\/steps\/(?P[\\w\\-\\_]+)": { "namespace": "elementor\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "type": "string", "description": "The step id.", "required": true } } } ] }, "\/elementor\/v1\/checklist\/user-progress": { "namespace": "elementor\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/checklist\/user-progress" } ] } }, "\/elementor\/v1\/template-library\/templates": { "namespace": "elementor\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "title": { "type": "string", "description": "The title of the document", "required": false }, "type": { "description": "The document type.", "type": "string", "enum": [ "page", "section", "header", "footer", "single", "single-post", "single-page", "archive", "search-results", "error-404", "product", "product-archive", "loop-item" ], "required": true }, "content": { "description": "Elementor data object", "type": "object", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/template-library\/templates" } ] } }, "\/elementor\/v1\/user-data\/current-user": { "namespace": "elementor\/v1", "methods": [ "GET", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "PATCH" ], "args": { "suppressedMessages": { "type": "array", "description": "Array of suppressed message keys", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/user-data\/current-user" } ] } }, "\/elementor\/v1\/global-widget\/templates": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/global-widget\/templates" } ] } }, "\/elementor-pro\/v1": { "namespace": "elementor-pro\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "elementor-pro\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-pro\/v1" } ] } }, "\/elementor-pro\/v1\/posts-widget": { "namespace": "elementor-pro\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-pro\/v1\/posts-widget" } ] } }, "\/elementor\/v1\/form-submissions": { "namespace": "elementor\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 50, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "additionalProperties": { "context": "filter" }, "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "order_by": { "description": "Sort collection by object attribute.", "type": "string", "default": "created_at", "enum": [ "created_at", "id", "main_meta_id" ], "required": false }, "status": { "description": "Limit result set to submissions assigned one or more statuses.", "type": "string", "default": "all", "enum": [ "all", "unread", "read", "trash" ], "additionalProperties": { "context": "filter" }, "required": false }, "form": { "description": "Limit result set to submissions assigned to specific forms. The form id should follow this pattern {post_id}_{element_id} e.g: 10_476d0ce", "type": "string", "additionalProperties": { "context": "filter" }, "required": false }, "referer": { "description": "Limit result set to submissions assigned to specific referer.", "type": "string", "additionalProperties": { "context": "filter" }, "required": false }, "after": { "description": "Limit response to submissions sent after a given ISO8601 compliant date.", "type": "string", "format": "date", "additionalProperties": { "context": "filter" }, "required": false }, "before": { "description": "Limit response to submissions sent before a given ISO8601 compliant date.", "type": "string", "format": "date", "additionalProperties": { "context": "filter" }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "ids": { "description": "Unique identifiers for the objects.", "type": "array", "items": { "type": "integer" }, "required": true }, "force": { "description": "Delete the object permanently.", "type": "boolean", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "ids": { "description": "Unique identifiers for the objects.", "type": "array", "items": { "type": "integer" }, "required": true }, "is_read": { "description": "mark whether the submission was read or not", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/form-submissions" } ] } }, "\/elementor\/v1\/form-submissions\/(?P[\\d]+)": { "namespace": "elementor\/v1", "methods": [ "GET", "DELETE", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true }, "force": { "description": "Delete the object permanently.", "type": "boolean", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true }, "is_read": { "description": "mark whether the submission was read or not", "type": "boolean", "required": false }, "values": { "description": "Form field values, receive an array, the key should be the form field id and the value should be the value.", "type": "object", "required": false } } } ] }, "\/elementor\/v1\/form-submissions\/restore\/(?P[\\d]+)": { "namespace": "elementor\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the object.", "type": "string", "required": true } } } ] }, "\/elementor\/v1\/form-submissions\/restore": { "namespace": "elementor\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "ids": { "description": "Unique identifiers for the objects.", "type": "array", "items": { "type": "integer" }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/form-submissions\/restore" } ] } }, "\/elementor\/v1\/form-submissions\/export": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 10000, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "additionalProperties": { "context": "filter" }, "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "order_by": { "description": "Sort collection by object attribute.", "type": "string", "default": "created_at", "enum": [ "created_at", "id", "main_meta_id" ], "required": false }, "status": { "description": "Limit result set to submissions assigned one or more statuses.", "type": "string", "default": "all", "enum": [ "all", "unread", "read", "trash" ], "additionalProperties": { "context": "filter" }, "required": false }, "form": { "description": "Limit result set to submissions assigned to specific forms. The form id should follow this pattern {post_id}_{element_id} e.g: 10_476d0ce", "type": "string", "additionalProperties": { "context": "filter" }, "required": false }, "referer": { "description": "Limit result set to submissions assigned to specific referer.", "type": "string", "additionalProperties": { "context": "filter" }, "required": false }, "after": { "description": "Limit response to submissions sent after a given ISO8601 compliant date.", "type": "string", "format": "date", "additionalProperties": { "context": "filter" }, "required": false }, "before": { "description": "Limit response to submissions sent before a given ISO8601 compliant date.", "type": "string", "format": "date", "additionalProperties": { "context": "filter" }, "required": false }, "ids": { "description": "Unique identifiers for the objects.", "type": "array", "items": { "type": "integer" }, "additionalProperties": { "context": "filter" }, "required": false }, "format": { "description": "The format of the export (for now only csv).", "enum": [ "csv" ], "default": "csv", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/form-submissions\/export" } ] } }, "\/elementor\/v1\/form-submissions\/referer": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made, determines fields present in response. (only \"options\" available for now)", "type": "string", "enum": [ "options" ], "default": "options", "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "additionalProperties": { "context": "filter" }, "required": false }, "value": { "description": "Limit results specific referer.", "type": "string", "additionalProperties": { "context": "filter" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/form-submissions\/referer" } ] } }, "\/elementor\/v1\/forms": { "namespace": "elementor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made, determines fields present in response. (only \"options\" available for now)", "type": "string", "enum": [ "options" ], "default": "options", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/forms" } ] } }, "\/elementor-pro\/v1\/woocommerce-module": { "namespace": "elementor-pro\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-pro\/v1\/woocommerce-module" } ] } }, "\/elementor-pro\/v1\/set-notice-dismissed": { "namespace": "elementor-pro\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "post_id": { "type": "integer", "required": true }, "is_custom_wc_cart_notice_dismissed": { "type": "boolean", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-pro\/v1\/set-notice-dismissed" } ] } }, "\/elementor-pro\/v1\/get-notice-dismissed\/(?P\\d+)": { "namespace": "elementor-pro\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ] }, "\/elementor-pro\/v1\/get-post-type-taxonomies": { "namespace": "elementor-pro\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "post_type": { "description": "The post type for which to fetch the list of taxonomies.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-pro\/v1\/get-post-type-taxonomies" } ] } }, "\/elementor-pro\/v1\/refresh-loop": { "namespace": "elementor-pro\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "post_id": { "description": "The post ID of the page containing the loop.", "type": "integer", "required": true }, "widget_id": { "description": "The ID of the loop widget.", "type": "string", "required": true }, "widget_filters": { "description": "The filters for the loop widget.", "type": "object", "required": true }, "widget_model": { "description": "The model of the loop widget. In Editor mode only.", "type": "object", "required": false }, "pagination_base_url": { "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-pro\/v1\/refresh-loop" } ] } }, "\/elementor-pro\/v1\/refresh-search": { "namespace": "elementor-pro\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "post_id": { "description": "The post ID of the page containing the loop.", "type": "integer", "required": true }, "widget_id": { "description": "The ID of the loop widget.", "type": "string", "required": true }, "widget_model": { "description": "The model of the loop widget. In Editor mode only.", "type": "object", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor-pro\/v1\/refresh-search" } ] } }, "\/woocommerce-email-editor\/v1": { "namespace": "woocommerce-email-editor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "woocommerce-email-editor\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/woocommerce-email-editor\/v1" } ] } }, "\/woocommerce-email-editor\/v1\/send_preview_email": { "namespace": "woocommerce-email-editor\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/woocommerce-email-editor\/v1\/send_preview_email" } ] } }, "\/woocommerce-email-editor\/v1\/get_personalization_tags": { "namespace": "woocommerce-email-editor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/woocommerce-email-editor\/v1\/get_personalization_tags" } ] } }, "\/woocommerce-email-editor\/v1\/personalization_tags": { "namespace": "woocommerce-email-editor\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "post_id": { "description": "The post ID for context-aware tag filtering.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/woocommerce-email-editor\/v1\/personalization_tags" } ] } }, "\/wc\/v1\/coupons": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "filter": { "type": "object", "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false }, "code": { "description": "Limit result set to resources with a specific code.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": true }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string", "required": false }, "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": [ "null", "string" ], "required": false }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string", "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": "string", "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/coupons" } ] } }, "\/wc\/v1\/coupons\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "code": { "description": "Coupon code.", "type": "string", "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string", "required": false }, "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string", "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": "string", "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v1\/coupons\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": "string", "required": false }, "expiry_date": { "description": "UTC DateTime when the coupon expires.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": "string", "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": "string", "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/coupons\/batch" } ] } }, "\/wc\/v1\/customers\/(?P[\\d]+)\/downloads": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "customer_id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ] }, "\/wc\/v1\/customers": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", "enum": [ "id", "include", "name", "registered_date" ], "type": "string", "required": false }, "email": { "description": "Limit result set to resources with a specific email.", "type": "string", "format": "email", "required": false }, "role": { "description": "Limit result set to resources with a specific role.", "type": "string", "default": "customer", "enum": [ "all", "administrator", "editor", "author", "contributor", "subscriber", "teacher", "learning_manager", "translator", "fue_manager", "customer", "shop_manager", "group_leader", "wdm_instructor", "group_creator", "wpseo_manager", "wpseo_editor", "events_admin", "give_manager", "give_accountant", "give_worker", "give_donor", "editorlab", "course_creator", "bbp_keymaster", "bbp_moderator", "bbp_participant", "bbp_spectator", "bbp_blocked" ], "required": false } } }, { "methods": [ "POST" ], "args": { "email": { "type": "string", "description": "New user email address.", "required": true }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "New user username.", "type": "string", "required": false }, "password": { "description": "New user password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/customers" } ] } }, "\/wc\/v1\/customers\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "email": { "description": "The email address for the customer.", "type": "string", "format": "email", "required": false }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "Customer login name.", "type": "string", "required": false }, "password": { "description": "Customer password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false }, "reassign": { "default": 0, "type": "integer", "description": "ID to reassign posts to.", "required": false } } } ] }, "\/wc\/v1\/customers\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "email": { "description": "The email address for the customer.", "type": "string", "format": "email", "required": false }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "Customer login name.", "type": "string", "required": false }, "password": { "description": "Customer password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/customers\/batch" } ] } }, "\/wc\/v1\/orders\/(?P[\\d]+)\/notes": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "note": { "type": "string", "description": "Order note content.", "required": true }, "customer_note": { "default": false, "description": "Shows\/define if the note is only for reference or for the customer (the user will be notified).", "type": "boolean", "required": false } } } ] }, "\/wc\/v1\/orders\/(?P[\\d]+)\/notes\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/orders\/(?P[\\d]+)\/refunds": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "filter": { "type": "object", "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false }, "status": { "default": "any", "description": "Limit result set to orders assigned a specific status.", "type": "string", "enum": [ "any", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "type": "integer", "required": false }, "product": { "description": "Limit result set to orders assigned a specific product.", "type": "integer", "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "amount": { "description": "Refund amount.", "type": "string", "required": false }, "reason": { "description": "Reason for refund.", "type": "string", "required": false } } } ] }, "\/wc\/v1\/orders\/(?P[\\d]+)\/refunds\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": true, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/orders": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "filter": { "type": "object", "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false }, "status": { "default": "any", "description": "Limit result set to orders assigned a specific status.", "type": "string", "enum": [ "any", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "type": "integer", "required": false }, "product": { "description": "Limit result set to orders assigned a specific product.", "type": "integer", "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "status": { "default": "pending", "description": "Order status.", "type": "string", "enum": [ "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ], "readonly": true }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta": { "description": "Line item meta data.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "Meta label.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ] }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/orders" } ] } }, "\/wc\/v1\/orders\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ], "readonly": true }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta": { "description": "Line item meta data.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "Meta label.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ] }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v1\/orders\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1.", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2.", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ], "readonly": true }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta": { "description": "Line item meta data.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "Meta label.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ] }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/orders\/batch" } ] } }, "\/wc\/v1\/products\/attributes\/(?P[\\d]+)\/terms": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v1\/products\/attributes\/(?P[\\d]+)\/terms\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/products\/attributes\/(?P[\\d]+)\/terms\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v1\/products\/attributes": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Name for the resource.", "type": "string", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "default": "select", "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "default": "menu_order", "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "default": false, "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/attributes" } ] } }, "\/wc\/v1\/products\/attributes\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": true, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/products\/attributes\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/attributes\/batch" } ] } }, "\/wc\/v1\/products\/categories": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "default": "default", "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/categories" } ] } }, "\/wc\/v1\/products\/categories\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/products\/categories\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/categories\/batch" } ] } }, "\/wc\/v1\/products\/(?P[\\d]+)\/reviews": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "review": { "type": "string", "description": "Review content.", "required": true }, "date_created": { "description": "The date the review was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false }, "name": { "type": "string", "description": "Name of the reviewer.", "required": true }, "email": { "type": "string", "description": "Email of the reviewer.", "required": true } } } ] }, "\/wc\/v1\/products\/(?P[\\d]+)\/reviews\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "review": { "description": "The content of the review.", "type": "string", "required": false }, "date_created": { "description": "The date the review was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false }, "name": { "description": "Reviewer name.", "type": "string", "required": false }, "email": { "description": "Reviewer email.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v1\/products\/shipping_classes": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/shipping_classes" } ] } }, "\/wc\/v1\/products\/shipping_classes\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Shipping class name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/products\/shipping_classes\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Shipping class name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/shipping_classes\/batch" } ] } }, "\/wc\/v1\/products\/tags": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/tags" } ] } }, "\/wc\/v1\/products\/tags\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Tag name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/products\/tags\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Tag name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/tags\/batch" } ] } }, "\/wc\/v1\/products": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "filter": { "type": "object", "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "draft", "pending", "private", "publish" ], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "category": { "description": "Limit result set to products assigned a specific category ID.", "type": "string", "required": false }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "type": "string", "required": false }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "type": "string", "required": false }, "attribute": { "description": "Limit result set to products with a specific attribute.", "type": "string", "required": false }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "type": "string", "required": false }, "sku": { "description": "Limit result set to products with a specific SKU.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "type": { "default": "simple", "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "default": "publish", "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false }, "featured": { "default": false, "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price.", "type": "string", "required": false }, "date_on_sale_to": { "description": "End data of sale price.", "type": "string", "required": false }, "virtual": { "default": false, "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "download_type": { "default": "standard", "description": "Download type, this controls the schema on the front-end.", "type": "string", "enum": [ "standard" ], "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "default": true, "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean", "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "type": "boolean", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "variations": { "description": "List of variations.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Variation ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "date_created": { "description": "The date the variation was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the variation was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "permalink": { "description": "Variation URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ], "readonly": true }, "sku": { "description": "Unique identifier.", "type": "string", "context": [ "view", "edit" ] }, "price": { "description": "Current variation price.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "regular_price": { "description": "Variation regular price.", "type": "string", "context": [ "view", "edit" ] }, "sale_price": { "description": "Variation sale price.", "type": "string", "context": [ "view", "edit" ] }, "date_on_sale_from": { "description": "Start date of sale price.", "type": "string", "context": [ "view", "edit" ] }, "date_on_sale_to": { "description": "End data of sale price.", "type": "string", "context": [ "view", "edit" ] }, "on_sale": { "description": "Shows if the variation is on sale.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "purchasable": { "description": "Shows if the variation can be bought.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "visible": { "description": "If the variation is visible.", "type": "boolean", "context": [ "view", "edit" ] }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "downloads": { "description": "List of downloadable files.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } } }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "default": null, "context": [ "view", "edit" ] }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "default": null, "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status.", "type": "string", "default": "taxable", "enum": [ "taxable", "shipping", "none" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class.", "type": "string", "context": [ "view", "edit" ] }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "default": false, "context": [ "view", "edit" ] }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "context": [ "view", "edit" ] }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean", "default": true, "context": [ "view", "edit" ] }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "default": "no", "enum": [ "no", "notify", "yes" ], "context": [ "view", "edit" ] }, "backorders_allowed": { "description": "Shows if back-orders are allowed.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "backordered": { "description": "Shows if the variation is on back-order.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "weight": { "description": "Variation weight (kg).", "type": "string", "context": [ "view", "edit" ] }, "dimensions": { "description": "Variation dimensions.", "type": "object", "context": [ "view", "edit" ], "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } } }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "context": [ "view", "edit" ] }, "shipping_class_id": { "description": "Shipping class ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Variation image data.", "type": "object", "context": [ "view", "edit" ], "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "attributes": { "description": "List of attributes.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } } } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products" } ] } }, "\/wc\/v1\/products\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price.", "type": "string", "required": false }, "date_on_sale_to": { "description": "End data of sale price.", "type": "string", "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "download_type": { "description": "Download type, this controls the schema on the front-end.", "type": "string", "enum": [ "standard" ], "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean", "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "variations": { "description": "List of variations.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Variation ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "date_created": { "description": "The date the variation was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the variation was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "permalink": { "description": "Variation URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ], "readonly": true }, "sku": { "description": "Unique identifier.", "type": "string", "context": [ "view", "edit" ] }, "price": { "description": "Current variation price.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "regular_price": { "description": "Variation regular price.", "type": "string", "context": [ "view", "edit" ] }, "sale_price": { "description": "Variation sale price.", "type": "string", "context": [ "view", "edit" ] }, "date_on_sale_from": { "description": "Start date of sale price.", "type": "string", "context": [ "view", "edit" ] }, "date_on_sale_to": { "description": "End data of sale price.", "type": "string", "context": [ "view", "edit" ] }, "on_sale": { "description": "Shows if the variation is on sale.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "purchasable": { "description": "Shows if the variation can be bought.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "visible": { "description": "If the variation is visible.", "type": "boolean", "context": [ "view", "edit" ] }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "downloads": { "description": "List of downloadable files.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } } }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "default": null, "context": [ "view", "edit" ] }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "default": null, "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status.", "type": "string", "default": "taxable", "enum": [ "taxable", "shipping", "none" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class.", "type": "string", "context": [ "view", "edit" ] }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "default": false, "context": [ "view", "edit" ] }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "context": [ "view", "edit" ] }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean", "default": true, "context": [ "view", "edit" ] }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "default": "no", "enum": [ "no", "notify", "yes" ], "context": [ "view", "edit" ] }, "backorders_allowed": { "description": "Shows if back-orders are allowed.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "backordered": { "description": "Shows if the variation is on back-order.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "weight": { "description": "Variation weight (kg).", "type": "string", "context": [ "view", "edit" ] }, "dimensions": { "description": "Variation dimensions.", "type": "object", "context": [ "view", "edit" ], "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } } }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "context": [ "view", "edit" ] }, "shipping_class_id": { "description": "Shipping class ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Variation image data.", "type": "object", "context": [ "view", "edit" ], "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "attributes": { "description": "List of attributes.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } } } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "type": "boolean", "required": false } } } ] }, "\/wc\/v1\/products\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price.", "type": "string", "required": false }, "date_on_sale_to": { "description": "End data of sale price.", "type": "string", "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "download_type": { "description": "Download type, this controls the schema on the front-end.", "type": "string", "enum": [ "standard" ], "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean", "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "variations": { "description": "List of variations.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Variation ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "date_created": { "description": "The date the variation was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the variation was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "permalink": { "description": "Variation URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ], "readonly": true }, "sku": { "description": "Unique identifier.", "type": "string", "context": [ "view", "edit" ] }, "price": { "description": "Current variation price.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "regular_price": { "description": "Variation regular price.", "type": "string", "context": [ "view", "edit" ] }, "sale_price": { "description": "Variation sale price.", "type": "string", "context": [ "view", "edit" ] }, "date_on_sale_from": { "description": "Start date of sale price.", "type": "string", "context": [ "view", "edit" ] }, "date_on_sale_to": { "description": "End data of sale price.", "type": "string", "context": [ "view", "edit" ] }, "on_sale": { "description": "Shows if the variation is on sale.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "purchasable": { "description": "Shows if the variation can be bought.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "visible": { "description": "If the variation is visible.", "type": "boolean", "context": [ "view", "edit" ] }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "downloads": { "description": "List of downloadable files.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } } }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "default": null, "context": [ "view", "edit" ] }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "default": null, "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status.", "type": "string", "default": "taxable", "enum": [ "taxable", "shipping", "none" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class.", "type": "string", "context": [ "view", "edit" ] }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "default": false, "context": [ "view", "edit" ] }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "context": [ "view", "edit" ] }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean", "default": true, "context": [ "view", "edit" ] }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "default": "no", "enum": [ "no", "notify", "yes" ], "context": [ "view", "edit" ] }, "backorders_allowed": { "description": "Shows if back-orders are allowed.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "backordered": { "description": "Shows if the variation is on back-order.", "type": "boolean", "context": [ "view", "edit" ], "readonly": true }, "weight": { "description": "Variation weight (kg).", "type": "string", "context": [ "view", "edit" ] }, "dimensions": { "description": "Variation dimensions.", "type": "object", "context": [ "view", "edit" ], "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } } }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "context": [ "view", "edit" ] }, "shipping_class_id": { "description": "Shipping class ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Variation image data.", "type": "object", "context": [ "view", "edit" ], "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "attributes": { "description": "List of attributes.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } } } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/products\/batch" } ] } }, "\/wc\/v1\/reports\/sales": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "period": { "description": "Report period.", "type": "string", "enum": [ "week", "month", "last_month", "year" ], "required": false }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/reports\/sales" } ] } }, "\/wc\/v1\/reports\/top_sellers": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "period": { "description": "Report period.", "type": "string", "enum": [ "week", "month", "last_month", "year" ], "required": false }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/reports\/top_sellers" } ] } }, "\/wc\/v1\/reports": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/reports" } ] } }, "\/wc\/v1\/taxes\/classes": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Tax class name.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/taxes\/classes" } ] } }, "\/wc\/v1\/taxes\/classes\/(?P\\w[\\w\\s\\-]*)": { "namespace": "wc\/v1", "methods": [ "DELETE" ], "endpoints": [ { "methods": [ "DELETE" ], "args": { "slug": { "description": "Unique slug for the resource.", "type": "string", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/taxes": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "type": "string", "required": false }, "class": { "description": "Sort by tax class.", "enum": [ "standard", "reduced-rate", "zero-rate" ], "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode \/ ZIP.", "type": "string", "required": false }, "city": { "description": "City name.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "default": 1, "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "default": "standard", "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/taxes" } ] } }, "\/wc\/v1\/taxes\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode \/ ZIP.", "type": "string", "required": false }, "city": { "description": "City name.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/taxes\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode \/ ZIP.", "type": "string", "required": false }, "city": { "description": "City name.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/taxes\/batch" } ] } }, "\/wc\/v1\/webhooks": { "namespace": "wc\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "title" ], "required": false }, "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", "type": "string", "enum": [ "all", "active", "paused", "disabled" ], "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "default": "active", "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "type": "string", "description": "Webhook topic.", "required": true }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false }, "delivery_url": { "type": "string", "description": "Webhook delivery URL.", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/webhooks" } ] } }, "\/wc\/v1\/webhooks\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "description": "Webhook topic.", "type": "string", "required": false }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v1\/webhooks\/batch": { "namespace": "wc\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "description": "Webhook topic.", "type": "string", "required": false }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v1\/webhooks\/batch" } ] } }, "\/wc\/v1\/webhooks\/(?P[\\d]+)\/deliveries": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "webhook_id": { "description": "Unique identifier for the webhook.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/v1\/webhooks\/(?P[\\d]+)\/deliveries\/(?P[\\d]+)": { "namespace": "wc\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "webhook_id": { "description": "Unique identifier for the webhook.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/v2\/coupons": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "code": { "description": "Limit result set to resources with a specific code.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": true }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/coupons" } ] } }, "\/wc\/v2\/coupons\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "code": { "description": "Coupon code.", "type": "string", "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v2\/coupons\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/coupons\/batch" } ] } }, "\/wc\/v2\/customers\/(?P[\\d]+)\/downloads": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "customer_id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ] }, "\/wc\/v2\/customers": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", "enum": [ "id", "include", "name", "registered_date" ], "type": "string", "required": false }, "email": { "description": "Limit result set to resources with a specific email.", "type": "string", "format": "email", "required": false }, "role": { "description": "Limit result set to resources with a specific role.", "type": "string", "default": "customer", "enum": [ "all", "administrator", "editor", "author", "contributor", "subscriber", "teacher", "learning_manager", "translator", "fue_manager", "customer", "shop_manager", "group_leader", "wdm_instructor", "group_creator", "wpseo_manager", "wpseo_editor", "events_admin", "give_manager", "give_accountant", "give_worker", "give_donor", "editorlab", "course_creator", "bbp_keymaster", "bbp_moderator", "bbp_participant", "bbp_spectator", "bbp_blocked" ], "required": false } } }, { "methods": [ "POST" ], "args": { "email": { "type": "string", "description": "New user email address.", "required": true }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "New user username.", "type": "string", "required": false }, "password": { "description": "New user password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/customers" } ] } }, "\/wc\/v2\/customers\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "email": { "description": "The email address for the customer.", "type": "string", "format": "email", "required": false }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "Customer login name.", "type": "string", "required": false }, "password": { "description": "Customer password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false }, "reassign": { "default": 0, "type": "integer", "description": "ID to reassign posts to.", "required": false } } } ] }, "\/wc\/v2\/customers\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "email": { "description": "The email address for the customer.", "type": "string", "format": "email", "required": false }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "Customer login name.", "type": "string", "required": false }, "password": { "description": "Customer password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/customers\/batch" } ] } }, "\/wc\/v2\/orders\/(?P[\\d]+)\/notes": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "type": { "default": "any", "description": "Limit result to customers or internal notes.", "type": "string", "enum": [ "any", "customer", "internal" ], "required": false } } }, { "methods": [ "POST" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "note": { "type": "string", "description": "Order note content.", "required": true }, "customer_note": { "default": false, "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean", "required": false } } } ] }, "\/wc\/v2\/orders\/(?P[\\d]+)\/notes\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/orders\/(?P[\\d]+)\/refunds": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "type": "boolean", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "amount": { "description": "Refund amount.", "type": "string", "required": false }, "reason": { "description": "Reason for refund.", "type": "string", "required": false }, "refunded_by": { "description": "User ID of user who created the refund.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "api_refund": { "default": true, "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean", "required": false } } } ] }, "\/wc\/v2\/orders\/(?P[\\d]+)\/refunds\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": true, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/orders": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "status": { "default": "any", "description": "Limit result set to orders assigned a specific status.", "type": "string", "enum": [ "any", "trash", "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "type": "integer", "required": false }, "product": { "description": "Limit result set to orders assigned a specific product.", "type": "integer", "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "type": "boolean", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "status": { "default": "pending", "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ] }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/orders" } ] } }, "\/wc\/v2\/orders\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ] }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v2\/orders\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ] }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/orders\/batch" } ] } }, "\/wc\/v2\/products\/attributes\/(?P[\\d]+)\/terms": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v2\/products\/attributes\/(?P[\\d]+)\/terms\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/products\/attributes\/(?P[\\d]+)\/terms\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v2\/products\/attributes": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Name for the resource.", "type": "string", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "default": "select", "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "default": "menu_order", "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "default": false, "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/attributes" } ] } }, "\/wc\/v2\/products\/attributes\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": true, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/products\/attributes\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/attributes\/batch" } ] } }, "\/wc\/v2\/products\/categories": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "default": "default", "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/categories" } ] } }, "\/wc\/v2\/products\/categories\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/products\/categories\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "title": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/categories\/batch" } ] } }, "\/wc\/v2\/products\/(?P[\\d]+)\/reviews": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "review": { "type": "string", "description": "Review content.", "required": true }, "date_created": { "description": "The date the review was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "type": [ "null", "string" ], "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false }, "name": { "type": "string", "description": "Name of the reviewer.", "required": true }, "email": { "type": "string", "description": "Email of the reviewer.", "required": true } } } ] }, "\/wc\/v2\/products\/(?P[\\d]+)\/reviews\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "review": { "description": "The content of the review.", "type": "string", "required": false }, "date_created": { "description": "The date the review was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "type": [ "null", "string" ], "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false }, "name": { "description": "Reviewer name.", "type": "string", "required": false }, "email": { "description": "Reviewer email.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v2\/products\/(?P[\\d]+)\/reviews\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "review": { "description": "The content of the review.", "type": "string", "required": false }, "date_created": { "description": "The date the review was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "type": [ "null", "string" ], "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false }, "name": { "description": "Reviewer name.", "type": "string", "required": false }, "email": { "description": "Reviewer email.", "type": "string", "required": false } } } ] }, "\/wc\/v2\/products\/shipping_classes": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/shipping_classes" } ] } }, "\/wc\/v2\/products\/shipping_classes\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Shipping class name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/products\/shipping_classes\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Shipping class name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/shipping_classes\/batch" } ] } }, "\/wc\/v2\/products\/tags": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/tags" } ] } }, "\/wc\/v2\/products\/tags\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Tag name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/products\/tags\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Tag name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/tags\/batch" } ] } }, "\/wc\/v2\/products": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "rand", "menu_order", "comment_count", "popularity", "rating", "post__in", "price", "sales", "random", "popularity", "rating", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "brand": { "description": "Limit result set to products assigned a specific brand ID.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a specific category ID.", "type": "string", "required": false }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "type": "string", "required": false }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "type": "string", "required": false }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name\/attribute slug.", "type": "string", "required": false }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "type": "string", "required": false }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "type": "boolean", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "type": { "default": "simple", "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "default": "publish", "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false }, "featured": { "default": false, "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "virtual": { "default": false, "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "default": true, "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean", "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "type": "boolean", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "string" } } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "grouped_products": { "description": "List of grouped products ID.", "type": "array", "items": { "type": "integer" }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products" } ] } }, "\/wc\/v2\/products\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean", "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "string" } } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "grouped_products": { "description": "List of grouped products ID.", "type": "array", "items": { "type": "integer" }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "type": "boolean", "required": false } } } ] }, "\/wc\/v2\/products\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "type": "boolean", "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "string" } } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "grouped_products": { "description": "List of grouped products ID.", "type": "array", "items": { "type": "integer" }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/products\/batch" } ] } }, "\/wc\/v2\/products\/(?P[\\d]+)\/related": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v2\/products\/(?P[\\d]+)\/variations": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a specific category ID.", "type": "string", "required": false }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "type": "string", "required": false }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "type": "string", "required": false }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name\/attribute slug.", "type": "string", "required": false }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "type": "string", "required": false }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "type": "boolean", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "visible": { "default": true, "description": "Define if the variation is visible on the product's page.", "type": "boolean", "required": false }, "virtual": { "default": false, "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean", "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ] }, "\/wc\/v2\/products\/(?P[\\d]+)\/variations\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean", "required": false }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean", "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v2\/products\/(?P[\\d]+)\/variations\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Unique identifier.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "visible": { "description": "Define if the variation is visible on the product's page.", "type": "boolean", "required": false }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean", "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Image position. 0 means that the image is featured.", "type": "integer", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ] }, "\/wc\/v2\/reports\/sales": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "period": { "description": "Report period.", "type": "string", "enum": [ "week", "month", "last_month", "year" ], "required": false }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/reports\/sales" } ] } }, "\/wc\/v2\/reports\/top_sellers": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "period": { "description": "Report period.", "type": "string", "enum": [ "week", "month", "last_month", "year" ], "required": false }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/reports\/top_sellers" } ] } }, "\/wc\/v2\/reports": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/reports" } ] } }, "\/wc\/v2\/settings": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/settings" } ] } }, "\/wc\/v2\/settings\/(?P[\\w-]+)": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false } } } ] }, "\/wc\/v2\/settings\/(?P[\\w-]+)\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "value": { "description": "Setting value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false } } } ] }, "\/wc\/v2\/settings\/(?P[\\w-]+)\/(?P[\\w-]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "value": { "description": "Setting value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false } } } ] }, "\/wc\/v2\/shipping\/zones": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Shipping zone name.", "required": true }, "order": { "description": "Shipping zone order.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/shipping\/zones" } ] } }, "\/wc\/v2\/shipping\/zones\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false }, "name": { "description": "Shipping zone name.", "type": "string", "required": false }, "order": { "description": "Shipping zone order.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v2\/shipping\/zones\/(?P[\\d]+)\/locations": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false }, "code": { "description": "Shipping zone location code.", "type": "string", "required": false }, "type": { "description": "Shipping zone location type.", "type": "string", "enum": [ "postcode", "state", "country", "continent" ], "required": false } } } ] }, "\/wc\/v2\/shipping\/zones\/(?P[\\d]+)\/methods": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "order": { "description": "Shipping method sort order.", "type": "integer", "required": false }, "enabled": { "description": "Shipping method enabled status.", "type": "boolean", "required": false }, "settings": { "description": "Shipping method settings.", "type": "object", "properties": { "id": { "description": "A unique identifier for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "A human readable label for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "description": { "description": "A human readable description for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "type": { "description": "Type of setting.", "type": "string", "context": [ "view", "edit" ], "enum": [ "text", "email", "number", "color", "password", "textarea", "select", "multiselect", "radio", "image_width", "checkbox" ], "readonly": true }, "value": { "description": "Setting value.", "type": "string", "context": [ "view", "edit" ] }, "default": { "description": "Default value for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "tip": { "description": "Additional help text shown to the user about the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "placeholder": { "description": "Placeholder text to be displayed in text inputs.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "method_id": { "description": "Shipping method ID.", "required": true } } } ] }, "\/wc\/v2\/shipping\/zones\/(?P[\\d]+)\/methods\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "instance_id": { "description": "Unique ID for the instance.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "instance_id": { "description": "Unique ID for the instance.", "type": "integer", "required": false }, "order": { "description": "Shipping method sort order.", "type": "integer", "required": false }, "enabled": { "description": "Shipping method enabled status.", "type": "boolean", "required": false }, "settings": { "description": "Shipping method settings.", "type": "object", "properties": { "id": { "description": "A unique identifier for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "A human readable label for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "description": { "description": "A human readable description for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "type": { "description": "Type of setting.", "type": "string", "context": [ "view", "edit" ], "enum": [ "text", "email", "number", "color", "password", "textarea", "select", "multiselect", "radio", "image_width", "checkbox" ], "readonly": true }, "value": { "description": "Setting value.", "type": "string", "context": [ "view", "edit" ] }, "default": { "description": "Default value for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "tip": { "description": "Additional help text shown to the user about the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "placeholder": { "description": "Placeholder text to be displayed in text inputs.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "instance_id": { "description": "Unique ID for the instance.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v2\/taxes\/classes": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Tax class name.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/taxes\/classes" } ] } }, "\/wc\/v2\/taxes\/classes\/(?P\\w[\\w\\s\\-]*)": { "namespace": "wc\/v2", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "Unique slug for the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "slug": { "description": "Unique slug for the resource.", "type": "string", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/taxes": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "type": "string", "required": false }, "class": { "description": "Sort by tax class.", "enum": [ "standard", "reduced-rate", "zero-rate" ], "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode \/ ZIP.", "type": "string", "required": false }, "city": { "description": "City name.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "default": 1, "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "default": "standard", "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/taxes" } ] } }, "\/wc\/v2\/taxes\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode \/ ZIP.", "type": "string", "required": false }, "city": { "description": "City name.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/taxes\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode \/ ZIP.", "type": "string", "required": false }, "city": { "description": "City name.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/taxes\/batch" } ] } }, "\/wc\/v2\/webhooks": { "namespace": "wc\/v2", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "title" ], "required": false }, "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", "type": "string", "enum": [ "all", "active", "paused", "disabled" ], "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "default": "active", "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "type": "string", "description": "Webhook topic.", "required": true }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false }, "delivery_url": { "type": "string", "description": "Webhook delivery URL.", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/webhooks" } ] } }, "\/wc\/v2\/webhooks\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "description": "Webhook topic.", "type": "string", "required": false }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v2\/webhooks\/batch": { "namespace": "wc\/v2", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "description": "Webhook topic.", "type": "string", "required": false }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/webhooks\/batch" } ] } }, "\/wc\/v2\/webhooks\/(?P[\\d]+)\/deliveries": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "webhook_id": { "description": "Unique identifier for the webhook.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/v2\/webhooks\/(?P[\\d]+)\/deliveries\/(?P[\\d]+)": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "webhook_id": { "description": "Unique identifier for the webhook.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/wc\/v2\/system_status": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/system_status" } ] } }, "\/wc\/v2\/system_status\/tools": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/system_status\/tools" } ] } }, "\/wc\/v2\/system_status\/tools\/(?P[\\w-]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique identifier for the tool.", "type": "string", "required": false }, "name": { "description": "Tool name.", "type": "string", "required": false }, "action": { "description": "What running the tool will do.", "type": "string", "required": false }, "description": { "description": "Tool description.", "type": "string", "required": false }, "success": { "description": "Did the tool run successfully?", "type": "boolean", "required": false }, "message": { "description": "Tool return message.", "type": "string", "required": false } } } ] }, "\/wc\/v2\/shipping_methods": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/shipping_methods" } ] } }, "\/wc\/v2\/shipping_methods\/(?P[\\w-]+)": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ] }, "\/wc\/v2\/payment_gateways": { "namespace": "wc\/v2", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v2\/payment_gateways" } ] } }, "\/wc\/v2\/payment_gateways\/(?P[\\w-]+)": { "namespace": "wc\/v2", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "title": { "description": "Payment gateway title on checkout.", "type": "string", "required": false }, "description": { "description": "Payment gateway description on checkout.", "type": "string", "required": false }, "order": { "description": "Payment gateway sort order.", "type": "integer", "required": false }, "enabled": { "description": "Payment gateway enabled status.", "type": "boolean", "required": false }, "settings": { "description": "Payment gateway settings.", "type": "object", "properties": { "id": { "description": "A unique identifier for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "A human readable label for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "description": { "description": "A human readable description for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "type": { "description": "Type of setting.", "type": "string", "context": [ "view", "edit" ], "enum": [ "text", "email", "number", "color", "password", "textarea", "select", "multiselect", "radio", "image_width", "checkbox" ], "readonly": true }, "value": { "description": "Setting value.", "type": "string", "context": [ "view", "edit" ] }, "default": { "description": "Default value for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "tip": { "description": "Additional help text shown to the user about the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "placeholder": { "description": "Placeholder text to be displayed in text inputs.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false } } } ] }, "\/wc\/v3\/coupons": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "code": { "description": "Limit result set to resources with a specific code.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": true }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/coupons" } ] } }, "\/wc\/v3\/coupons\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "code": { "description": "Coupon code.", "type": "string", "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v3\/coupons\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "code": { "description": "Coupon code.", "type": "string", "required": false }, "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "type": [ "number", "string" ], "required": false }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "type": "string", "required": false }, "discount_type": { "description": "Determines the type of discount that will be applied.", "type": "string", "enum": [ "percent", "fixed_cart", "fixed_product" ], "required": false }, "description": { "description": "Coupon description.", "type": "string", "required": false }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "type": [ "null", "string" ], "required": false }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "type": "boolean", "required": false }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "type": "array", "items": { "type": "integer" }, "required": false }, "usage_limit": { "description": "How many times the coupon can be used in total.", "type": "integer", "required": false }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "type": "integer", "required": false }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "type": "integer", "required": false }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "type": "boolean", "required": false }, "product_categories": { "description": "List of category IDs the coupon applies to.", "type": "array", "items": { "type": "integer" }, "required": false }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "type": "boolean", "required": false }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "type": [ "number", "string" ], "required": false }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "type": [ "number", "string" ], "required": false }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "type": "array", "items": { "type": "string" }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/coupons\/batch" } ] } }, "\/wc\/v3\/customers\/(?P[\\d]+)\/downloads": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "customer_id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ] }, "\/wc\/v3\/customers": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", "enum": [ "id", "include", "name", "registered_date" ], "type": "string", "required": false }, "email": { "description": "Limit result set to resources with a specific email.", "type": "string", "format": "email", "required": false }, "role": { "description": "Limit result set to resources with a specific role.", "type": "string", "default": "customer", "enum": [ "all", "administrator", "editor", "author", "contributor", "subscriber", "teacher", "learning_manager", "translator", "fue_manager", "customer", "shop_manager", "group_leader", "wdm_instructor", "group_creator", "wpseo_manager", "wpseo_editor", "events_admin", "give_manager", "give_accountant", "give_worker", "give_donor", "editorlab", "course_creator", "bbp_keymaster", "bbp_moderator", "bbp_participant", "bbp_spectator", "bbp_blocked" ], "required": false } } }, { "methods": [ "POST" ], "args": { "email": { "type": "string", "description": "New user email address.", "required": true }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "New user username.", "type": "string", "required": false }, "password": { "description": "New user password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/customers" } ] } }, "\/wc\/v3\/customers\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "email": { "description": "The email address for the customer.", "type": "string", "format": "email", "required": false }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "Customer login name.", "type": "string", "required": false }, "password": { "description": "Customer password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false }, "reassign": { "default": 0, "type": "integer", "description": "ID to reassign posts to.", "required": false } } } ] }, "\/wc\/v3\/customers\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "email": { "description": "The email address for the customer.", "type": "string", "format": "email", "required": false }, "first_name": { "description": "Customer first name.", "type": "string", "required": false }, "last_name": { "description": "Customer last name.", "type": "string", "required": false }, "username": { "description": "Customer login name.", "type": "string", "required": false }, "password": { "description": "Customer password.", "type": "string", "required": false }, "billing": { "description": "List of billing address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": "string", "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "List of shipping address data.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "ISO code of the country.", "type": "string", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/customers\/batch" } ] } }, "\/wc\/v3\/layout-templates": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "area": { "description": "Area to get templates for.", "type": "string", "default": "", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/layout-templates" } ] } }, "\/wc\/v3\/layout-templates\/(?P\\w[\\w\\s\\-]*)": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false } } } ] }, "\/wc\/v3\/orders\/(?P[\\d]+)\/notes": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "type": { "default": "any", "description": "Limit result to customers or internal notes.", "type": "string", "enum": [ "any", "customer", "internal" ], "required": false } } }, { "methods": [ "POST" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "note": { "type": "string", "description": "Order note content.", "required": true }, "customer_note": { "default": false, "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "type": "boolean", "required": false }, "added_by_user": { "default": false, "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.", "type": "boolean", "required": false } } } ] }, "\/wc\/v3\/orders\/(?P[\\d]+)\/notes\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/orders\/(?P[\\d]+)\/refunds": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "type": "boolean", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "amount": { "description": "Refund amount.", "type": "string", "required": false }, "reason": { "description": "Reason for refund.", "type": "string", "required": false }, "refunded_by": { "description": "User ID of user who created the refund.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "api_refund": { "default": true, "description": "When true, the payment gateway API is used to generate the refund.", "type": "boolean", "required": false }, "api_restock": { "default": true, "description": "When true, refunded items are restocked.", "type": "boolean", "required": false } } } ] }, "\/wc\/v3\/orders\/(?P[\\d]+)\/refunds\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "order_id": { "description": "The order ID.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": true, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/orders": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "status": { "default": "any", "description": "Limit result set to orders which have specific statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "trash", "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ] }, "required": false }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "type": "integer", "required": false }, "product": { "description": "Limit result set to orders assigned a specific product.", "type": "integer", "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "type": "boolean", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "created_via": { "description": "Limit result set to orders created via specific sources (e.g. checkout, admin).", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "POST" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "created_via": { "description": "Shows where the order was created.", "type": "string", "required": false }, "status": { "default": "pending", "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "manual_update": { "default": false, "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/orders" } ] } }, "\/wc\/v3\/orders\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "created_via": { "description": "Shows where the order was created.", "type": "string", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v3\/orders\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "parent_id": { "description": "Parent order ID.", "type": "integer", "required": false }, "created_via": { "description": "Shows where the order was created.", "type": "string", "required": false }, "status": { "description": "Order status.", "type": "string", "enum": [ "auto-draft", "pending", "processing", "on-hold", "completed", "cancelled", "refunded", "failed", "checkout-draft" ], "required": false }, "currency": { "description": "Currency the order was created with, in ISO format.", "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYR", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "type": "integer", "required": false }, "customer_note": { "description": "Note left by customer during checkout.", "type": "string", "required": false }, "billing": { "description": "Billing address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] }, "email": { "description": "Email address.", "type": [ "string", "null" ], "format": "email", "context": [ "view", "edit" ] }, "phone": { "description": "Phone number.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping": { "description": "Shipping address.", "type": "object", "properties": { "first_name": { "description": "First name.", "type": "string", "context": [ "view", "edit" ] }, "last_name": { "description": "Last name.", "type": "string", "context": [ "view", "edit" ] }, "company": { "description": "Company name.", "type": "string", "context": [ "view", "edit" ] }, "address_1": { "description": "Address line 1", "type": "string", "context": [ "view", "edit" ] }, "address_2": { "description": "Address line 2", "type": "string", "context": [ "view", "edit" ] }, "city": { "description": "City name.", "type": "string", "context": [ "view", "edit" ] }, "state": { "description": "ISO code or name of the county, state, province or district.", "type": "string", "context": [ "view", "edit" ] }, "postcode": { "description": "Postal code.", "type": "string", "context": [ "view", "edit" ] }, "country": { "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "payment_method": { "description": "Payment method ID.", "type": "string", "required": false }, "payment_method_title": { "description": "Payment method title.", "type": "string", "required": false }, "transaction_id": { "description": "Unique transaction ID.", "type": "string", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false }, "line_items": { "description": "Line items data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Product name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "parent_name": { "description": "Parent product name if the product is a variation.", "type": "string", "context": [ "view", "edit" ] }, "product_id": { "description": "Product ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "variation_id": { "description": "Variation ID, if applicable.", "type": "integer", "context": [ "view", "edit" ] }, "quantity": { "description": "Quantity ordered.", "type": "integer", "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of product.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Line subtotal (before discounts).", "type": "string", "context": [ "view", "edit" ] }, "subtotal_tax": { "description": "Line subtotal tax (before discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ] }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ] }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ] } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "display_key": { "description": "Meta key for UI display.", "type": "string", "context": [ "view", "edit" ] }, "display_value": { "description": "Meta value for UI display.", "type": "string", "context": [ "view", "edit" ] } } } }, "sku": { "description": "Product SKU.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "price": { "description": "Product price.", "type": "number", "context": [ "view", "edit" ], "readonly": true }, "image": { "description": "Properties of the main product image.", "type": "object", "context": [ "view", "edit" ], "readonly": true, "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] } } } } }, "required": false }, "shipping_lines": { "description": "Shipping lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "method_title": { "description": "Shipping method name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "method_id": { "description": "Shipping method ID.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "instance_id": { "description": "Shipping instance ID.", "type": "string", "context": [ "view", "edit" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "fee_lines": { "description": "Fee lines data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "name": { "description": "Fee name.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "tax_class": { "description": "Tax class of fee.", "type": "string", "context": [ "view", "edit" ] }, "tax_status": { "description": "Tax status of fee.", "type": "string", "context": [ "view", "edit" ], "enum": [ "taxable", "none" ] }, "total": { "description": "Line total (after discounts).", "type": "string", "context": [ "view", "edit" ] }, "total_tax": { "description": "Line total tax (after discounts).", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "taxes": { "description": "Line taxes.", "type": "array", "context": [ "view", "edit" ], "readonly": true, "items": { "type": "object", "properties": { "id": { "description": "Tax rate ID", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "total": { "description": "Tax total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "subtotal": { "description": "Tax subtotal.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } } }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "coupon_lines": { "description": "Coupons line data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Item ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "code": { "description": "Coupon code.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] }, "discount": { "description": "Discount total.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_tax": { "description": "Discount total tax.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "discount_type": { "description": "Discount type.", "type": "string", "context": [ "view" ], "readonly": true }, "nominal_amount": { "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "type": "number", "context": [ "view" ], "readonly": true }, "free_shipping": { "description": "Whether the coupon grants free shipping or not.", "type": "boolean", "context": [ "view" ], "readonly": true }, "meta_data": { "description": "Meta data.", "type": "array", "context": [ "view", "edit" ], "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } } }, "required": false }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "type": "boolean", "required": false }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/orders\/batch" } ] } }, "\/wc\/v3\/products\/attributes\/(?P[\\d]+)\/terms": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v3\/products\/attributes\/(?P[\\d]+)\/terms\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/products\/attributes\/(?P[\\d]+)\/terms\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "type": "integer", "required": false }, "name": { "description": "Term name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v3\/products\/attributes": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Name for the resource.", "type": "string", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "default": "select", "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "default": "menu_order", "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "default": false, "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/attributes" } ] } }, "\/wc\/v3\/products\/attributes\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": true, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/products\/attributes\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Attribute name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "type": { "description": "Type of attribute.", "type": "string", "enum": [ "select" ], "required": false }, "order_by": { "description": "Default sort order.", "type": "string", "enum": [ "menu_order", "name", "name_num", "id" ], "required": false }, "has_archives": { "description": "Enable\/Disable attribute archives.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/attributes\/batch" } ] } }, "\/wc\/v3\/products\/categories": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "default": "default", "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/categories" } ] } }, "\/wc\/v3\/products\/categories\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/products\/categories\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Category name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "parent": { "description": "The ID for the parent of the resource.", "type": "integer", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false }, "display": { "description": "Category archive display type.", "type": "string", "enum": [ "default", "products", "subcategories", "both" ], "required": false }, "image": { "description": "Image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/categories\/batch" } ] } }, "\/wc\/v3\/products\/custom-fields\/names": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "order": { "description": "Order sort items ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/custom-fields\/names" } ] } }, "\/wc\/v3\/products\/reviews": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date_gmt", "enum": [ "date", "date_gmt", "id", "include", "product" ], "required": false }, "reviewer": { "description": "Limit result set to reviews assigned to specific user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "reviewer_exclude": { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "reviewer_email": { "default": null, "description": "Limit result set to that from a specific author email.", "format": "email", "type": "string", "required": false }, "product": { "default": [], "description": "Limit result set to reviews assigned to specific product IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", "type": "string", "enum": [ "all", "hold", "approved", "spam", "trash" ], "required": false } } }, { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the product.", "type": "integer", "required": true }, "product_name": { "description": "Product name.", "type": "string", "required": false }, "status": { "default": "approved", "description": "Status of the review.", "type": "string", "enum": [ "approved", "hold", "spam", "unspam", "trash", "untrash" ], "required": false }, "reviewer": { "type": "string", "description": "Name of the reviewer.", "required": true }, "reviewer_email": { "type": "string", "description": "Email of the reviewer.", "required": true }, "review": { "type": "string", "description": "Review content.", "required": true }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/reviews" } ] } }, "\/wc\/v3\/products\/reviews\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "product_id": { "description": "Unique identifier for the product that the review belongs to.", "type": "integer", "required": false }, "product_name": { "description": "Product name.", "type": "string", "required": false }, "status": { "description": "Status of the review.", "type": "string", "enum": [ "approved", "hold", "spam", "unspam", "trash", "untrash" ], "required": false }, "reviewer": { "description": "Reviewer name.", "type": "string", "required": false }, "reviewer_email": { "description": "Reviewer email.", "type": "string", "format": "email", "required": false }, "review": { "description": "The content of the review.", "type": "string", "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v3\/products\/reviews\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the product that the review belongs to.", "type": "integer", "required": false }, "product_name": { "description": "Product name.", "type": "string", "required": false }, "status": { "description": "Status of the review.", "type": "string", "enum": [ "approved", "hold", "spam", "unspam", "trash", "untrash" ], "required": false }, "reviewer": { "description": "Reviewer name.", "type": "string", "required": false }, "reviewer_email": { "description": "Reviewer email.", "type": "string", "format": "email", "required": false }, "review": { "description": "The content of the review.", "type": "string", "required": false }, "rating": { "description": "Review rating (0 to 5).", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/reviews\/batch" } ] } }, "\/wc\/v3\/products\/shipping_classes": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/shipping_classes" } ] } }, "\/wc\/v3\/products\/shipping_classes\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Shipping class name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/products\/shipping_classes\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Shipping class name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/shipping_classes\/batch" } ] } }, "\/wc\/v3\/products\/shipping_classes\/slug-suggestion": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "name": { "description": "Shipping class name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/shipping_classes\/slug-suggestion" } ] } }, "\/wc\/v3\/products\/tags": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by resource attribute.", "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "term_group", "description", "count" ], "required": false }, "hide_empty": { "description": "Whether to hide resources not assigned to any products.", "type": "boolean", "default": false, "required": false }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "type": "integer", "required": false }, "product": { "description": "Limit result set to resources assigned to a specific product.", "type": "integer", "default": null, "required": false }, "slug": { "description": "Limit result set to resources with a specific slug.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Name for the resource.", "required": true }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/tags" } ] } }, "\/wc\/v3\/products\/tags\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Tag name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/products\/tags\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Tag name.", "type": "string", "required": false }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "type": "string", "required": false }, "description": { "description": "HTML description of the resource.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/tags\/batch" } ] } }, "\/wc\/v3\/products": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "rand", "menu_order", "comment_count", "popularity", "rating", "post__in", "price", "sales", "random", "popularity", "rating", "menu_order", "price", "popularity", "rating" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "brand": { "description": "Limit result set to products assigned a specific brand ID.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a specific category ID.", "type": "string", "required": false }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "type": "string", "required": false }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "type": "string", "required": false }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name\/attribute slug.", "type": "string", "required": false }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "type": "string", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "search_sku": { "description": "Limit results to those with a SKU that partial matches a string. This argument takes precedence over 'sku'.", "type": "string", "required": false }, "search_name_or_sku": { "description": "Limit results to those with a name or SKU that partial matches a string. This argument takes precedence over 'search', 'sku' and 'search_sku'.", "type": "string", "required": false }, "search_fields": { "description": "Limit search to specific fields when used with search parameter. Available fields: name, sku, global_unique_id, description, short_description. This argument takes precedence over all other search parameters.", "type": "array", "items": { "type": "string", "enum": [ "name", "global_unique_id", "description", "short_description", "sku" ] }, "default": [], "required": false }, "include_status": { "description": "Limit result set to products with any of the statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "exclude_status": { "description": "Exclude products with any of the statuses from result set.", "type": "array", "items": { "type": "string", "enum": [ "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "include_types": { "description": "Limit result set to products with any of the types.", "type": "array", "items": { "type": "string", "enum": [ "simple", "grouped", "external", "variable" ] }, "required": false }, "exclude_types": { "description": "Exclude products with any of the types from result set.", "type": "array", "items": { "type": "string", "enum": [ "simple", "grouped", "external", "variable" ] }, "required": false }, "downloadable": { "description": "Limit result set to downloadable products.", "type": "boolean", "required": false }, "virtual": { "description": "Limit result set to virtual products.", "type": "boolean", "required": false }, "pos_products_only": { "description": "Limit result set to products visible in Point of Sale.", "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "default": "simple", "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "default": "publish", "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "default": false, "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "default": false, "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products" } ] } }, "\/wc\/v3\/products\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "type": "boolean", "required": false } } } ] }, "\/wc\/v3\/products\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/batch" } ] } }, "\/wc\/v3\/products\/(?P[\\d]+)\/related": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false } } } ] }, "\/wc\/v3\/products\/suggested-products": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "rand", "menu_order", "comment_count", "popularity", "rating", "post__in", "price", "sales", "random", "popularity", "rating", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "brand": { "description": "Limit result set to products assigned a specific brand ID.", "type": "string", "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "type": { "description": "Limit result set to products assigned a specific type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "featured": { "description": "Limit result set to featured products.", "type": "boolean", "required": false }, "category": { "description": "Limit result set to products assigned a specific category ID.", "type": "string", "required": false }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "type": "string", "required": false }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "type": "string", "required": false }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name\/attribute slug.", "type": "string", "required": false }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "type": "string", "required": false }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "type": "boolean", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "categories": { "description": "Limit result set to specific product categorie ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "tags": { "description": "Limit result set to specific product tag ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "limit": { "description": "Limit result set to specific amount of suggested products.", "type": "integer", "default": 5, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/products\/suggested-products" } ] } }, "\/wc\/v3\/products\/(?P[\\d]+)\/duplicate": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "Product name.", "type": "string", "required": false }, "slug": { "description": "Product slug.", "type": "string", "required": false }, "date_created": { "description": "The date the product was created, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "type": [ "null", "string" ], "required": false }, "type": { "description": "Product type.", "type": "string", "enum": [ "simple", "grouped", "external", "variable" ], "required": false }, "status": { "description": "Product status (post status).", "type": "string", "enum": [ "draft", "pending", "private", "publish", "future", "auto-draft", "trash" ], "required": false }, "featured": { "description": "Featured product.", "type": "boolean", "required": false }, "catalog_visibility": { "description": "Catalogue visibility.", "type": "string", "enum": [ "visible", "catalog", "search", "hidden" ], "required": false }, "description": { "description": "Product description.", "type": "string", "required": false }, "short_description": { "description": "Product short description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Product regular price.", "type": "string", "required": false }, "sale_price": { "description": "Product sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "virtual": { "description": "If the product is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the product is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "external_url": { "description": "Product external URL. Only for external products.", "type": "string", "format": "uri", "required": false }, "button_text": { "description": "Product external button text. Only for external products.", "type": "string", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at product level.", "type": "boolean", "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the product.", "type": [ "integer", "null" ], "required": false }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "type": "boolean", "required": false }, "weight": { "description": "Product weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Product dimensions.", "type": "object", "properties": { "length": { "description": "Product length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Product width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Product height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "reviews_allowed": { "description": "Allow reviews.", "type": "boolean", "required": false }, "post_password": { "description": "Post password.", "type": "string", "required": false }, "upsell_ids": { "description": "List of up-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "type": "array", "items": { "type": "integer" }, "required": false }, "parent_id": { "description": "Product parent ID.", "type": "integer", "required": false }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "type": "string", "required": false }, "categories": { "description": "List of categories.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Category ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Category name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Category slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "brands": { "description": "List of brands.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Brand ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Brand name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Brand slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "tags": { "description": "List of tags.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Tag ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Tag name.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "slug": { "description": "Tag slug.", "type": "string", "context": [ "view", "edit" ], "readonly": true } } }, "required": false }, "images": { "description": "List of images.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "position": { "description": "Attribute position.", "type": "integer", "context": [ "view", "edit" ] }, "visible": { "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "variation": { "description": "Define if the attribute can be used as variation.", "type": "boolean", "default": false, "context": [ "view", "edit" ] }, "options": { "description": "List of available term names of the attribute.", "type": "array", "items": { "type": "string" }, "context": [ "view", "edit" ] } } }, "required": false }, "default_attributes": { "description": "Defaults variation attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ] }, "\/wc\/v3\/products\/(?P[\\d]+)\/variations": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "has_price": { "description": "Limit result set to products with or without price.", "type": "boolean", "required": false }, "attributes": { "description": "Limit result set to products with specified attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Attribute slug." }, "term": { "type": "string", "description": "Attribute term." }, "terms": { "type": "array", "description": "Attribute terms." } } }, "required": false }, "virtual": { "description": "Limit result set to virtual product variations.", "type": "boolean", "required": false }, "downloadable": { "description": "Limit result set to downloadable product variations.", "type": "boolean", "required": false }, "include_status": { "description": "Limit result set to product variations with any of the statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "exclude_status": { "description": "Exclude product variations with any of the statuses from result set.", "type": "array", "items": { "type": "string", "enum": [ "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "pos_products_only": { "description": "Limit result set to variations visible in Point of Sale.", "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "default": "publish", "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "default": false, "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ] }, "\/wc\/v3\/products\/(?P[\\d]+)\/variations\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "id": { "description": "Unique identifier for the variation.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v3\/products\/(?P[\\d]+)\/variations\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ] }, "\/wc\/v3\/products\/(?P[\\d]+)\/variations\/generate": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "product_id": { "description": "Unique identifier for the variable product.", "type": "integer", "required": false }, "delete": { "description": "Deletes unused variations.", "type": "boolean", "required": false }, "default_values": { "description": "Default values for generated variations.", "type": "object", "properties": { "description": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation description.", "type": "string" }, "sku": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Stock Keeping Unit.", "type": "string" }, "global_unique_id": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "GTIN, UPC, EAN or ISBN.", "type": "string" }, "regular_price": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation regular price.", "type": "string" }, "sale_price": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation sale price.", "type": "string" }, "date_on_sale_from": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ] }, "date_on_sale_to": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ] }, "status": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ] }, "virtual": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "If the variation is virtual.", "type": "boolean" }, "downloadable": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } } }, "download_limit": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "download_expiry": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "tax_status": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ] }, "tax_class": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Tax class.", "type": "string" }, "manage_stock": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Stock management at variation level.", "type": [ "boolean", "string" ] }, "stock_quantity": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Stock quantity.", "type": "integer" }, "stock_status": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ] }, "backorders": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ] }, "low_stock_amount": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ] }, "weight": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation weight (kg).", "type": "string" }, "dimensions": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } } }, "shipping_class": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Shipping class slug.", "type": "string" }, "image": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } } }, "attributes": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } } }, "menu_order": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Menu order, used to custom sort products.", "type": "integer" }, "meta_data": { "validate_callback": "rest_validate_request_arg", "sanitize_callback": "rest_sanitize_request_arg", "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } } } }, "required": false }, "description": { "description": "Variation description.", "type": "string", "required": false }, "sku": { "description": "Stock Keeping Unit.", "type": "string", "required": false }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "type": "string", "required": false }, "regular_price": { "description": "Variation regular price.", "type": "string", "required": false }, "sale_price": { "description": "Variation sale price.", "type": "string", "required": false }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "type": [ "null", "string" ], "required": false }, "status": { "default": "publish", "description": "Variation status.", "type": "string", "enum": [ "draft", "pending", "private", "publish" ], "required": false }, "virtual": { "default": false, "description": "If the variation is virtual.", "type": "boolean", "required": false }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "type": "boolean", "required": false }, "downloads": { "description": "List of downloadable files.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "File ID.", "type": "string", "context": [ "view", "edit" ] }, "name": { "description": "File name.", "type": "string", "context": [ "view", "edit" ] }, "file": { "description": "File URL.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer", "required": false }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "type": "integer", "required": false }, "tax_status": { "default": "taxable", "description": "Tax status.", "type": "string", "enum": [ "taxable", "shipping", "none" ], "required": false }, "tax_class": { "description": "Tax class.", "type": "string", "required": false }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "type": [ "boolean", "string" ], "required": false }, "stock_quantity": { "description": "Stock quantity.", "type": "integer", "required": false }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "type": "string", "enum": [ "no", "notify", "yes" ], "required": false }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "type": [ "integer", "null" ], "required": false }, "weight": { "description": "Variation weight (kg).", "type": "string", "required": false }, "dimensions": { "description": "Variation dimensions.", "type": "object", "properties": { "length": { "description": "Variation length (cm).", "type": "string", "context": [ "view", "edit" ] }, "width": { "description": "Variation width (cm).", "type": "string", "context": [ "view", "edit" ] }, "height": { "description": "Variation height (cm).", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "shipping_class": { "description": "Shipping class slug.", "type": "string", "required": false }, "image": { "description": "Variation image data.", "type": "object", "properties": { "id": { "description": "Image ID.", "type": "integer", "context": [ "view", "edit" ] }, "date_created": { "description": "The date the image was created, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_created_gmt": { "description": "The date the image was created, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified": { "description": "The date the image was last modified, in the site's timezone.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "date_modified_gmt": { "description": "The date the image was last modified, as GMT.", "type": [ "null", "string" ], "context": [ "view", "edit" ], "readonly": true }, "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": [ "view", "edit" ] }, "name": { "description": "Image name.", "type": "string", "context": [ "view", "edit" ] }, "alt": { "description": "Image alternative text.", "type": "string", "context": [ "view", "edit" ] } }, "required": false }, "attributes": { "description": "List of attributes.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Attribute ID.", "type": "integer", "context": [ "view", "edit" ] }, "name": { "description": "Attribute name.", "type": "string", "context": [ "view", "edit" ] }, "option": { "description": "Selected attribute term name.", "type": "string", "context": [ "view", "edit" ] } } }, "required": false }, "menu_order": { "description": "Menu order, used to custom sort products.", "type": "integer", "required": false }, "meta_data": { "description": "Meta data.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Meta ID.", "type": "integer", "context": [ "view", "edit" ], "readonly": true }, "key": { "description": "Meta key.", "type": "string", "context": [ "view", "edit" ] }, "value": { "description": "Meta value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "context": [ "view", "edit" ] } } }, "required": false } } } ] }, "\/wc\/v3\/refunds": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "type": "integer", "required": false }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "type": "boolean", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/refunds" } ] } }, "\/wc\/v3\/reports\/sales": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "period": { "description": "Report period.", "type": "string", "enum": [ "week", "month", "last_month", "year" ], "required": false }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports\/sales" } ] } }, "\/wc\/v3\/reports\/top_sellers": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false }, "period": { "description": "Report period.", "type": "string", "enum": [ "week", "month", "last_month", "year" ], "required": false }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "type": "string", "format": "date", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports\/top_sellers" } ] } }, "\/wc\/v3\/reports\/orders\/totals": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports\/orders\/totals" } ] } }, "\/wc\/v3\/reports\/products\/totals": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports\/products\/totals" } ] } }, "\/wc\/v3\/reports\/customers\/totals": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports\/customers\/totals" } ] } }, "\/wc\/v3\/reports\/coupons\/totals": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports\/coupons\/totals" } ] } }, "\/wc\/v3\/reports\/reviews\/totals": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports\/reviews\/totals" } ] } }, "\/wc\/v3\/reports": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/reports" } ] } }, "\/wc\/v3\/settings": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/settings" } ] } }, "\/wc\/v3\/settings\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/settings\/batch" } ] } }, "\/wc\/v3\/settings\/(?P[\\w-]+)": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false } } } ] }, "\/wc\/v3\/settings\/(?P[\\w-]+)\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "value": { "description": "Setting value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false } } } ] }, "\/wc\/v3\/settings\/(?P[\\w-]+)\/(?P[\\w-]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "group": { "description": "Settings group ID.", "type": "string", "required": false }, "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "value": { "description": "Setting value.", "type": [ "null", "object", "string", "number", "boolean", "integer", "array" ], "required": false } } } ] }, "\/wc\/v3\/shipping\/zones": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "description": "Shipping zone name.", "required": true }, "order": { "description": "Shipping zone order.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/shipping\/zones" } ] } }, "\/wc\/v3\/shipping\/zones\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false }, "name": { "description": "Shipping zone name.", "type": "string", "required": false }, "order": { "description": "Shipping zone order.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v3\/shipping\/zones\/(?P[\\d]+)\/locations": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique ID for the resource.", "type": "integer", "required": false }, "code": { "description": "Shipping zone location code.", "type": "string", "required": false }, "type": { "description": "Shipping zone location type.", "type": "string", "enum": [ "postcode", "state", "country", "continent" ], "required": false } } } ] }, "\/wc\/v3\/shipping\/zones\/(?P[\\d]+)\/methods": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "order": { "description": "Shipping method sort order.", "type": "integer", "required": false }, "enabled": { "description": "Shipping method enabled status.", "type": "boolean", "required": false }, "settings": { "description": "Shipping method settings.", "type": "object", "properties": { "id": { "description": "A unique identifier for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "A human readable label for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "description": { "description": "A human readable description for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "type": { "description": "Type of setting.", "type": "string", "context": [ "view", "edit" ], "enum": [ "text", "email", "number", "color", "password", "textarea", "select", "multiselect", "radio", "image_width", "checkbox", "class", "order" ], "readonly": true }, "value": { "description": "Setting value.", "type": "string", "context": [ "view", "edit" ] }, "default": { "description": "Default value for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "tip": { "description": "Additional help text shown to the user about the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "placeholder": { "description": "Placeholder text to be displayed in text inputs.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false }, "method_id": { "description": "Shipping method ID.", "required": true } } } ] }, "\/wc\/v3\/shipping\/zones\/(?P[\\d]+)\/methods\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "instance_id": { "description": "Unique ID for the instance.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "instance_id": { "description": "Unique ID for the instance.", "type": "integer", "required": false }, "order": { "description": "Shipping method sort order.", "type": "integer", "required": false }, "enabled": { "description": "Shipping method enabled status.", "type": "boolean", "required": false }, "settings": { "description": "Shipping method settings.", "type": "object", "properties": { "id": { "description": "A unique identifier for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "A human readable label for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "description": { "description": "A human readable description for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "type": { "description": "Type of setting.", "type": "string", "context": [ "view", "edit" ], "enum": [ "text", "email", "number", "color", "password", "textarea", "select", "multiselect", "radio", "image_width", "checkbox", "class", "order" ], "readonly": true }, "value": { "description": "Setting value.", "type": "string", "context": [ "view", "edit" ] }, "default": { "description": "Default value for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "tip": { "description": "Additional help text shown to the user about the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "placeholder": { "description": "Placeholder text to be displayed in text inputs.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "zone_id": { "description": "Unique ID for the zone.", "type": "integer", "required": false }, "instance_id": { "description": "Unique ID for the instance.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Whether to bypass bin and force deletion.", "required": false } } } ] }, "\/wc\/v3\/taxes\/classes": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Tax class name.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/taxes\/classes" } ] } }, "\/wc\/v3\/taxes\/classes\/(?P\\w[\\w\\s\\-]*)": { "namespace": "wc\/v3", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "Unique slug for the resource.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "slug": { "description": "Unique slug for the resource.", "type": "string", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/taxes": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "type": "string", "required": false }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "type": "string", "required": false }, "class": { "description": "Sort by tax class.", "enum": [ "standard", "reduced-rate", "zero-rate" ], "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode\/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string", "required": false }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "default": 1, "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "default": "standard", "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false }, "postcodes": { "description": "List of postcodes \/ ZIPs. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false }, "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/taxes" } ] } }, "\/wc\/v3\/taxes\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode\/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string", "required": false }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false }, "postcodes": { "description": "List of postcodes \/ ZIPs. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false }, "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/taxes\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "country": { "description": "Country ISO 3166 code.", "type": "string", "required": false }, "state": { "description": "State code.", "type": "string", "required": false }, "postcode": { "description": "Postcode\/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "type": "string", "required": false }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "type": "string", "required": false }, "rate": { "description": "Tax rate.", "type": "string", "required": false }, "name": { "description": "Tax rate name.", "type": "string", "required": false }, "priority": { "description": "Tax priority.", "type": "integer", "required": false }, "compound": { "description": "Whether or not this is a compound rate.", "type": "boolean", "required": false }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "type": "boolean", "required": false }, "order": { "description": "Indicates the order that will appear in queries.", "type": "integer", "required": false }, "class": { "description": "Tax class.", "type": "string", "enum": [ "standard", "reduced-rate", "zero-rate" ], "required": false }, "postcodes": { "description": "List of postcodes \/ ZIPs. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false }, "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/taxes\/batch" } ] } }, "\/wc\/v3\/variations": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "dates_are_gmt": { "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "type": "boolean", "default": false, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "include", "title", "slug", "modified", "menu_order" ], "required": false }, "parent": { "description": "Limit result set to those of particular parent IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "parent_exclude": { "description": "Limit result set to all items except those of a particular parent ID.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "slug": { "description": "Limit result set to products with a specific slug.", "type": "string", "required": false }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ], "required": false }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "type": "string", "required": false }, "on_sale": { "description": "Limit result set to products on sale.", "type": "boolean", "required": false }, "min_price": { "description": "Limit result set to products based on a minimum price.", "type": "string", "required": false }, "max_price": { "description": "Limit result set to products based on a maximum price.", "type": "string", "required": false }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "type": "array", "items": { "type": "string" }, "required": false }, "stock_status": { "description": "Limit result set to products with specified stock status.", "type": "string", "enum": [ "instock", "outofstock", "onbackorder" ], "required": false }, "has_price": { "description": "Limit result set to products with or without price.", "type": "boolean", "required": false }, "attributes": { "description": "Limit result set to products with specified attributes.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Attribute slug." }, "term": { "type": "string", "description": "Attribute term." }, "terms": { "type": "array", "description": "Attribute terms." } } }, "required": false }, "virtual": { "description": "Limit result set to virtual product variations.", "type": "boolean", "required": false }, "downloadable": { "description": "Limit result set to downloadable product variations.", "type": "boolean", "required": false }, "include_status": { "description": "Limit result set to product variations with any of the statuses.", "type": "array", "items": { "type": "string", "enum": [ "any", "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "exclude_status": { "description": "Exclude product variations with any of the statuses from result set.", "type": "array", "items": { "type": "string", "enum": [ "future", "trash", "draft", "pending", "private", "publish" ] }, "required": false }, "pos_products_only": { "description": "Limit result set to variations visible in Point of Sale.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/variations" } ] } }, "\/wc\/v3\/webhooks": { "namespace": "wc\/v3", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "type": "string", "format": "date-time", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "include": { "description": "Limit result set to specific ids.", "type": "array", "items": { "type": "integer" }, "default": [], "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "type": "string", "default": "desc", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Sort collection by object attribute.", "type": "string", "default": "date", "enum": [ "date", "id", "title" ], "required": false }, "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", "type": "string", "enum": [ "all", "active", "paused", "disabled" ], "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "default": "active", "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "type": "string", "description": "Webhook topic.", "required": true }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false }, "delivery_url": { "type": "string", "description": "Webhook delivery URL.", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/webhooks" } ] } }, "\/wc\/v3\/webhooks\/(?P[\\d]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "description": "Webhook topic.", "type": "string", "required": false }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "integer", "required": false }, "force": { "default": false, "type": "boolean", "description": "Required to be true, as resource does not support binning.", "required": false } } } ] }, "\/wc\/v3\/webhooks\/batch": { "namespace": "wc\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "A friendly name for the webhook.", "type": "string", "required": false }, "status": { "description": "Webhook status.", "type": "string", "enum": [ "active", "paused", "disabled" ], "required": false }, "topic": { "description": "Webhook topic.", "type": "string", "required": false }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/webhooks\/batch" } ] } }, "\/wc\/v3\/system_status": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/system_status" } ] } }, "\/wc\/v3\/system_status\/tools": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/system_status\/tools" } ] } }, "\/wc\/v3\/system_status\/tools\/(?P[\\w-]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique identifier for the tool.", "type": "string", "required": false }, "name": { "description": "Tool name.", "type": "string", "required": false }, "action": { "description": "What running the tool will do.", "type": "string", "required": false }, "description": { "description": "Tool description.", "type": "string", "required": false }, "success": { "description": "Did the tool run successfully?", "type": "boolean", "required": false }, "message": { "description": "Tool return message.", "type": "string", "required": false } } } ] }, "\/wc\/v3\/shipping_methods": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/shipping_methods" } ] } }, "\/wc\/v3\/shipping_methods\/(?P[\\w-]+)": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } } ] }, "\/wc\/v3\/payment_gateways": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/payment_gateways" } ] } }, "\/wc\/v3\/payment_gateways\/(?P[\\w-]+)": { "namespace": "wc\/v3", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the resource.", "type": "string", "required": false }, "title": { "description": "Payment gateway title on checkout.", "type": "string", "required": false }, "description": { "description": "Payment gateway description on checkout.", "type": "string", "required": false }, "order": { "description": "Payment gateway sort order.", "type": "integer", "required": false }, "enabled": { "description": "Payment gateway enabled status.", "type": "boolean", "required": false }, "settings": { "description": "Payment gateway settings.", "type": "object", "properties": { "id": { "description": "A unique identifier for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "label": { "description": "A human readable label for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "description": { "description": "A human readable description for the setting used in interfaces.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "type": { "description": "Type of setting.", "type": "string", "context": [ "view", "edit" ], "enum": [ "text", "email", "number", "color", "password", "textarea", "select", "multiselect", "radio", "image_width", "checkbox" ], "readonly": true }, "value": { "description": "Setting value.", "type": "string", "context": [ "view", "edit" ] }, "default": { "description": "Default value for the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "tip": { "description": "Additional help text shown to the user about the setting.", "type": "string", "context": [ "view", "edit" ], "readonly": true }, "placeholder": { "description": "Placeholder text to be displayed in text inputs.", "type": "string", "context": [ "view", "edit" ], "readonly": true } }, "required": false } } } ] }, "\/wc\/v3\/data": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/data" } ] } }, "\/wc\/v3\/data\/continents": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/data\/continents" } ] } }, "\/wc\/v3\/data\/continents\/(?P[\\w-]+)": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "continent": { "description": "2 character continent code.", "type": "string", "required": false } } } ] }, "\/wc\/v3\/data\/countries": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/data\/countries" } ] } }, "\/wc\/v3\/data\/countries\/(?P[\\w-]+)": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "location": { "description": "ISO3166 alpha-2 country code.", "type": "string", "required": false } } } ] }, "\/wc\/v3\/data\/currencies": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/data\/currencies" } ] } }, "\/wc\/v3\/data\/currencies\/current": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/data\/currencies\/current" } ] } }, "\/wc\/v3\/data\/currencies\/(?P[\\w-]{3})": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "location": { "description": "ISO4217 currency code.", "type": "string", "required": false } } } ] }, "\/wc\/v3\/paypal-standard\/update-shipping": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/paypal-standard\/update-shipping" } ] } }, "\/wc\/v3\/paypal-webhooks": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/paypal-webhooks" } ] } }, "\/wc\/v3\/paypal-buttons\/create-order": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/paypal-buttons\/create-order" } ] } }, "\/wc\/v3\/paypal-buttons\/cancel-payment": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/paypal-buttons\/cancel-payment" } ] } }, "\/wc\/v3\/orders\/(?P[\\d]+)\/receipt": { "namespace": "wc\/v3", "methods": [ "POST", "GET" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier of the order.", "type": "integer", "required": false }, "expiration_date": { "description": "Expiration date formatted as dd-mm-yyyy.", "type": "string", "default": null, "required": false }, "expiration_days": { "description": "Number of days to be added to the current date to get the expiration date.", "type": "integer", "default": 1, "required": false }, "force_new": { "description": "True to force the creation of a new receipt even if one already exists and has not expired yet.", "type": "boolean", "default": false, "required": false } } }, { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier of the order.", "type": "integer", "required": false } } } ] }, "\/wc\/v3\/orders\/(?P[\\d]+)\/actions\/email_templates": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier of the order.", "type": "integer", "required": false } } } ] }, "\/wc\/v3\/orders\/(?P[\\d]+)\/actions\/send_email": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier of the order.", "type": "integer", "required": false }, "email": { "description": "Email address to send the order details to.", "type": "string", "format": "email", "required": false }, "force_email_update": { "description": "Whether to update the billing email of the order, even if it already has one.", "type": "boolean", "required": false }, "template_id": { "description": "The ID of the template to use for sending the email.", "type": "string", "enum": [ "new_order", "cancelled_order", "customer_cancelled_order", "failed_order", "customer_failed_order", "customer_on_hold_order", "customer_processing_order", "customer_completed_order", "customer_refunded_order", "customer_invoice", "customer_note", "customer_reset_password", "customer_new_account", "customer_pos_completed_order", "customer_pos_refunded_order" ], "required": true } } } ] }, "\/wc\/v3\/orders\/(?P[\\d]+)\/actions\/send_order_details": { "namespace": "wc\/v3", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "description": "Unique identifier of the order.", "type": "integer", "required": false }, "email": { "description": "Email address to send the order details to.", "type": "string", "format": "email", "required": false }, "force_email_update": { "description": "Whether to update the billing email of the order, even if it already has one.", "type": "boolean", "required": false } } } ] }, "\/wc\/v3\/orders\/statuses": { "namespace": "wc\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc\/v3\/orders\/statuses" } ] } }, "\/wc-admin\/settings\/payments\/country": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "location": { "description": "The ISO3166 alpha-2 country code to save for the current user.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/country" } ] } }, "\/wc-admin\/settings\/payments\/providers": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to WooCommerce's base location country.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/providers" } ] } }, "\/wc-admin\/settings\/payments\/providers\/order": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "order_map": { "description": "A map of provider ID to integer values representing the sort order.", "type": "object", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/providers\/order" } ] } }, "\/wc-admin\/settings\/payments\/suggestion\/(?P[\\w\\d\\-]+)\/attach": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/settings\/payments\/suggestion\/(?P[\\w\\d\\-]+)\/hide": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ] }, "\/wc-admin\/settings\/payments\/suggestion\/(?P[\\w\\d\\-]+)\/incentive\/(?P[\\w\\d\\-]+)\/dismiss": { "namespace": "wc-admin", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "context": { "description": "The context ID for which to dismiss the incentive. If not provided, will dismiss the incentive for all contexts.", "type": "string", "required": false }, "do_not_track": { "description": "If true, the incentive dismissal will be ignored by tracking.", "type": "boolean", "default": false, "required": false } } } ] }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/(?P[a-zA-Z0-9_-]+)\/start": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ] }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/(?P[a-zA-Z0-9_-]+)\/save": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ] }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/(?P[a-zA-Z0-9_-]+)\/check": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false } } } ] }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/(?P[a-zA-Z0-9_-]+)\/finish": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ] }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/(?P[a-zA-Z0-9_-]+)\/clean": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false } } } ] }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/test_account\/init": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/test_account\/init" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/test_account\/reset": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/test_account\/reset" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/business_verification\/kyc_session": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/business_verification\/kyc_session" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/business_verification\/kyc_session\/finish": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/business_verification\/kyc_session\/finish" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/business_verification\/test_account\/disable": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "from": { "description": "Where from in the onboarding flow this request was triggered.", "type": "string", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/step\/business_verification\/test_account\/disable" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/preload": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/preload" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/reset": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "from": { "description": "Where from in the onboarding flow this request was triggered.", "type": "string", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/reset" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/woopay-eligibility": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/woopay-eligibility" } ] } }, "\/wc-admin\/settings\/payments\/woopayments\/onboarding\/test_account\/disable": { "namespace": "wc-admin", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "location": { "description": "ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.", "type": "string", "pattern": "[a-zA-Z]{2}", "required": false }, "from": { "description": "Where from in the onboarding flow this request was triggered.", "type": "string", "required": false }, "source": { "description": "The upmost entry point from where the merchant entered the onboarding flow.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin\/settings\/payments\/woopayments\/onboarding\/test_account\/disable" } ] } }, "\/wc-admin-email": { "namespace": "wc-admin-email", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc-admin-email", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin-email" } ] } }, "\/wc-admin-email\/settings\/email\/send-preview": { "namespace": "wc-admin-email", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "type": { "description": "The email type to preview.", "type": "string", "required": true }, "email": { "description": "Email address to send the email preview to.", "type": "string", "format": "email", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin-email\/settings\/email\/send-preview" } ] } }, "\/wc-admin-email\/settings\/email\/preview-subject": { "namespace": "wc-admin-email", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "type": { "description": "The email type to get subject for.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin-email\/settings\/email\/preview-subject" } ] } }, "\/wc-admin-email\/settings\/email\/save-transient": { "namespace": "wc-admin-email", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "key": { "type": "string", "description": "The key for the transient. Must be one of the allowed options.", "required": true }, "value": { "type": "string", "description": "The value to be saved for the transient.", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin-email\/settings\/email\/save-transient" } ] } }, "\/wc-admin-email\/settings\/email\/listing\/recreate-email-post": { "namespace": "wc-admin-email", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "email_id": { "description": "The email ID to recreate the post for.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-admin-email\/settings\/email\/listing\/recreate-email-post" } ] } }, "\/wc-telemetry": { "namespace": "wc-telemetry", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wc-telemetry", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-telemetry" } ] } }, "\/wc-telemetry\/tracker": { "namespace": "wc-telemetry", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "platform": { "description": "Platform to track.", "type": "string", "required": true }, "version": { "description": "Platform version to track.", "type": "string", "required": true }, "installation_date": { "description": "Installation date of the WooCommerce mobile app.", "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wc-telemetry\/tracker" } ] } }, "\/wccom-site\/v3": { "namespace": "wccom-site\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wccom-site\/v3", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wccom-site\/v3" } ] } }, "\/wccom-site\/v3\/installer\/(?P\\d+)\/state": { "namespace": "wccom-site\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "product_id": { "type": "integer", "required": true } } } ] }, "\/wccom-site\/v3\/installer": { "namespace": "wccom-site\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product-id": { "type": "integer", "required": true }, "run-until-step": { "type": "string", "enum": [ "get_product_info", "download_product", "unpack_product", "move_product", "activate_product" ], "required": true }, "idempotency-key": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wccom-site\/v3\/installer" } ] } }, "\/wccom-site\/v3\/installer\/reset": { "namespace": "wccom-site\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "product-id": { "type": "integer", "required": true }, "idempotency-key": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wccom-site\/v3\/installer\/reset" } ] } }, "\/wccom-site\/v3\/ssr": { "namespace": "wccom-site\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wccom-site\/v3\/ssr" } ] } }, "\/wccom-site\/v3\/status": { "namespace": "wccom-site\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wccom-site\/v3\/status" } ] } }, "\/wccom-site\/v3\/connection\/disconnect": { "namespace": "wccom-site\/v3", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wccom-site\/v3\/connection\/disconnect" } ] } }, "\/wccom-site\/v3\/connection\/status": { "namespace": "wccom-site\/v3", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wccom-site\/v3\/connection\/status" } ] } }, "\/mailpoet\/v1": { "namespace": "mailpoet\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "mailpoet\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/mailpoet\/v1" } ] } }, "\/mailpoet\/v1\/automations": { "namespace": "mailpoet\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "status": { "type": "array", "items": { "type": "string" }, "required": false }, "orderby": { "type": "string", "required": false }, "order": { "type": "string", "required": false }, "page": { "type": "integer", "required": false }, "per_page": { "type": "integer", "required": false }, "search": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/mailpoet\/v1\/automations" } ] } }, "\/mailpoet\/v1\/automations\/(?P\\d+)": { "namespace": "mailpoet\/v1", "methods": [ "PUT", "DELETE" ], "endpoints": [ { "methods": [ "PUT" ], "args": { "id": { "type": "integer", "required": true }, "name": { "type": "string", "minLength": 1, "required": false }, "status": { "type": "string", "required": false }, "steps": { "type": "object", "properties": { "root": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^root$" }, "type": { "type": "string", "pattern": "^root$" }, "key": { "type": "string", "pattern": "^core:root$" }, "args": { "type": "object", "additionalProperties": false }, "next_steps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "required": true } } }, "required": true } }, "required": true } }, "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "required": true }, "type": { "type": "string", "required": true }, "key": { "type": "string", "required": true }, "args": { "type": "object", "required": true }, "next_steps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "required": true } } }, "required": true }, "filters": { "type": [ "object", "null" ], "properties": { "operator": { "type": "string", "pattern": "^and|or$", "required": true }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "required": true }, "operator": { "type": "string", "pattern": "^and|or$", "required": true }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "required": true }, "field_type": { "type": "string", "required": true }, "field_key": { "type": "string", "required": true }, "condition": { "type": "string", "required": true }, "args": { "type": "object", "required": true } } }, "minItems": 1, "required": true } } }, "minItems": 1, "required": true } }, "required": true } } }, "required": false }, "meta": { "type": "object", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "required": true } } } ] }, "\/mailpoet\/v1\/automations\/(?P\\d+)\/duplicate": { "namespace": "mailpoet\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "type": "integer", "required": true } } } ] }, "\/mailpoet\/v1\/automations\/create-from-template": { "namespace": "mailpoet\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "slug": { "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/mailpoet\/v1\/automations\/create-from-template" } ] } }, "\/mailpoet\/v1\/automation-templates": { "namespace": "mailpoet\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "category": { "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/mailpoet\/v1\/automation-templates" } ] } }, "\/mailpoet\/v1\/automation-templates\/(?P.+)": { "namespace": "mailpoet\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "type": "string", "required": true }, "preview": { "type": "boolean", "required": false } } } ] }, "\/mailpoet\/v1\/automation\/analytics\/automation_flow": { "namespace": "mailpoet\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "required": true }, "query": { "type": "object", "properties": { "primary": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time", "required": true }, "before": { "type": "string", "format": "date-time", "required": true } } }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "order_by": { "type": "string" }, "order": { "type": "string" }, "page": { "type": "integer", "minimum": 1 }, "filter": { "type": "object", "properties": [] }, "search": { "type": [ "string", "null" ] } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/mailpoet\/v1\/automation\/analytics\/automation_flow" } ] } }, "\/mailpoet\/v1\/automation\/analytics\/overview": { "namespace": "mailpoet\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "required": true }, "query": { "type": "object", "properties": { "primary": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time", "required": true }, "before": { "type": "string", "format": "date-time", "required": true } } }, "secondary": { "type": "object", "properties": { "after": { "type": "string", "format": "date-time", "required": true }, "before": { "type": "string", "format": "date-time", "required": true } } }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "orderBy": { "type": "string" }, "orderDirection": { "type": "string" }, "page": { "type": "integer", "minimum": 1 }, "filter": { "type": "object" }, "search": { "type": [ "string", "null" ] } }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/mailpoet\/v1\/automation\/analytics\/overview" } ] } }, "\/mailpoet\/v1\/automation\/analytics\/runs\/(?P\\d+)\/status": { "namespace": "mailpoet\/v1", "methods": [ "PUT" ], "endpoints": [ { "methods": [ "PUT" ], "args": { "id": { "type": "integer", "required": true }, "status": { "type": "string", "required": true } } } ] }, "\/ithemes-security\/v1\/firewall\/rules": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "provider": { "type": "array", "items": { "type": "string" }, "required": false }, "vulnerability": { "type": "array", "items": { "type": "string" }, "required": false }, "paused": { "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "type": "string", "minLength": 1, "required": true }, "config": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": [ "string", "array" ], "required": true, "items": { "type": "string" } } } }, "required": true, "minItems": 1, "uniqueItems": true }, "type": { "type": "string", "enum": [ "BLOCK", "LOG", "REDIRECT", "WHITELIST" ], "required": true }, "type_params": { "type": "string", "format": "uri" } }, "required": true }, "paused_at": { "type": [ "string", "null" ], "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/firewall\/rules" } ] } }, "\/ithemes-security\/v1\/firewall\/rules\/(?P[\\d]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "PUT" ], "args": { "name": { "type": "string", "minLength": 1, "required": false }, "config": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "object", "properties": { "parameter": { "type": [ "string", "array" ], "required": true, "items": { "type": "string" } } } }, "required": true, "minItems": 1, "uniqueItems": true }, "type": { "type": "string", "enum": [ "BLOCK", "LOG", "REDIRECT", "WHITELIST" ], "required": true }, "type_params": { "type": "string", "format": "uri" } }, "required": false }, "paused_at": { "type": [ "string", "null" ], "format": "date-time", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "type": "integer", "required": false } } } ] }, "\/ithemes-security\/v1\/user-groups": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "allow_batch": { "v1": true }, "args": { "label": { "type": "string", "minLength": 1, "required": true }, "users": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "uniqueItems": true, "required": false }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "administrator", "editor", "author", "contributor", "subscriber", "teacher", "learning_manager", "translator", "fue_manager", "customer", "shop_manager", "group_leader", "wdm_instructor", "group_creator", "wpseo_manager", "wpseo_editor", "events_admin", "give_manager", "give_accountant", "give_worker", "give_donor", "editorlab", "course_creator", "bbp_keymaster", "bbp_moderator", "bbp_participant", "bbp_spectator", "bbp_blocked" ] }, "required": false }, "canonical": { "type": "array", "items": { "type": "string", "enum": [ "administrator", "editor", "author", "contributor", "subscriber" ] }, "required": false }, "min_role": { "type": "string", "enum": [ "", "administrator", "editor", "author", "contributor", "subscriber", "teacher", "learning_manager", "translator", "fue_manager", "customer", "shop_manager", "group_leader", "wdm_instructor", "group_creator", "wpseo_manager", "wpseo_editor", "events_admin", "give_manager", "give_accountant", "give_worker", "give_donor", "editorlab", "course_creator", "bbp_keymaster", "bbp_moderator", "bbp_participant", "bbp_spectator", "bbp_blocked" ], "required": false }, "ignore_duplicate": { "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/user-groups" } ] } }, "\/ithemes-security\/v1\/user-groups\/(?P[\\w_:-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "PUT" ], "allow_batch": { "v1": true }, "args": { "id": { "type": "string", "required": false }, "label": { "type": "string", "minLength": 1, "required": false }, "users": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "uniqueItems": true, "required": false }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "administrator", "editor", "author", "contributor", "subscriber", "teacher", "learning_manager", "translator", "fue_manager", "customer", "shop_manager", "group_leader", "wdm_instructor", "group_creator", "wpseo_manager", "wpseo_editor", "events_admin", "give_manager", "give_accountant", "give_worker", "give_donor", "editorlab", "course_creator", "bbp_keymaster", "bbp_moderator", "bbp_participant", "bbp_spectator", "bbp_blocked" ] }, "required": false }, "canonical": { "type": "array", "items": { "type": "string", "enum": [ "administrator", "editor", "author", "contributor", "subscriber" ] }, "required": false }, "min_role": { "type": "string", "enum": [ "", "administrator", "editor", "author", "contributor", "subscriber", "teacher", "learning_manager", "translator", "fue_manager", "customer", "shop_manager", "group_leader", "wdm_instructor", "group_creator", "wpseo_manager", "wpseo_editor", "events_admin", "give_manager", "give_accountant", "give_worker", "give_donor", "editorlab", "course_creator", "bbp_keymaster", "bbp_moderator", "bbp_participant", "bbp_spectator", "bbp_blocked" ], "required": false } } }, { "methods": [ "DELETE" ], "allow_batch": { "v1": true }, "args": { "id": { "type": "string", "required": false } } } ] }, "\/ithemes-security\/v1\/user-matchables": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/user-matchables" } ] } }, "\/ithemes-security\/v1\/user-matchable-settings": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "include": { "type": "array", "items": { "type": "string" }, "required": false } } }, { "methods": [ "PATCH" ], "args": { "global": { "title": "Global Settings", "type": "object", "properties": { "manage_group": { "title": "Manage Solid Security", "description": "Allow users to manage Solid Security.", "type": "boolean", "context": [ "view", "edit", "embed" ] } }, "additionalProperties": false, "required": false }, "dashboard": { "title": "Security Dashboard", "type": "object", "properties": { "group": { "title": "Enable Dashboard Creation", "description": "Allow users to create new Solid Security Dashboards.", "type": "boolean", "context": [ "view", "edit", "embed" ] } }, "additionalProperties": false, "required": false }, "password-requirements": { "title": "Password Requirements", "type": "object", "properties": { "requirement_settings.strength.group": { "title": "Strong Passwords", "description": "Require strong passwords approved by the WordPress password strength meter.", "type": "boolean", "context": [ "view", "edit", "embed" ] }, "requirement_settings.hibp.group": { "title": "Refuse Compromised Passwords", "description": "Reject passwords that have appeared in password breaches tracked by haveibeenpwned.com. This is a secure API call that does not transmit complete, unhashed passwords.", "type": "boolean", "context": [ "view", "edit", "embed" ] } }, "additionalProperties": false, "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "include": { "type": "array", "items": { "type": "string" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/user-matchable-settings" } ] } }, "\/ithemes-security\/v1\/user-matchable-settings\/(?P.*)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "PUT" ], "endpoints": [ { "methods": [ "GET" ], "allow_batch": { "v1": true }, "args": { "id": { "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "PUT" ], "allow_batch": { "v1": true }, "args": { "id": { "type": "string", "required": false }, "global": { "title": "Global Settings", "type": "object", "properties": { "manage_group": { "title": "Manage Solid Security", "description": "Allow users to manage Solid Security.", "type": "boolean", "context": [ "view", "edit", "embed" ] } }, "additionalProperties": false, "required": false }, "dashboard": { "title": "Security Dashboard", "type": "object", "properties": { "group": { "title": "Enable Dashboard Creation", "description": "Allow users to create new Solid Security Dashboards.", "type": "boolean", "context": [ "view", "edit", "embed" ] } }, "additionalProperties": false, "required": false }, "password-requirements": { "title": "Password Requirements", "type": "object", "properties": { "requirement_settings.strength.group": { "title": "Strong Passwords", "description": "Require strong passwords approved by the WordPress password strength meter.", "type": "boolean", "context": [ "view", "edit", "embed" ] }, "requirement_settings.hibp.group": { "title": "Refuse Compromised Passwords", "description": "Reject passwords that have appeared in password breaches tracked by haveibeenpwned.com. This is a secure API call that does not transmit complete, unhashed passwords.", "type": "boolean", "context": [ "view", "edit", "embed" ] } }, "additionalProperties": false, "required": false } } } ] }, "\/ithemes-security\/v1\/strong-passwords\/scan": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/strong-passwords\/scan" } ] } }, "\/ithemes-security\/v1\/strong-passwords\/scan\/(?P[\\d]+)\/mute": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/ithemes-security\/v1\/strong-passwords\/scan\/(?P[\\d]+)\/unmute": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/ithemes-security\/v1\/site-scanner\/scans": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "code": { "type": "array", "items": { "type": "string" }, "required": false }, "before": { "type": "string", "format": "date-time", "required": false }, "after": { "type": "string", "format": "date-time", "required": false } } }, { "methods": [ "POST" ], "args": { "site_id": { "type": "integer", "default": 0, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/site-scanner\/scans" } ] } }, "\/ithemes-security\/v1\/site-scanner\/scans\/(?P\\d+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/scans\/(?P\\d+)\/issues": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false }, "entry": { "type": "array", "items": { "type": "string", "enum": [ "vulnerabilities", "blacklist", "malware" ] }, "required": false }, "scan_id": { "type": "integer", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/scans\/(?P\\d+)\/issues\/(?P[\\w_-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "scan_id": { "type": "integer", "required": false }, "issue_id": { "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed" ], "default": "view", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/scans\/(?P\\d+)\/issues\/(?P[\\w_-]+)\/fix": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "scan_id": { "type": "integer", "required": false }, "issue_id": { "type": "string", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/muted-issues": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST" ], "args": { "id": { "type": "string", "required": false }, "muted_by": { "type": "integer", "required": false }, "muted_at": { "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/site-scanner\/muted-issues" } ] } }, "\/ithemes-security\/v1\/site-scanner\/muted-issues\/(?P[\\w-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "DELETE" ], "args": [] } ] }, "\/ithemes-security\/v1\/site-scanner\/vulnerabilities": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "resolution": { "type": "array", "items": { "type": "string", "enum": [ "", "unresolved", "patched", "muted", "deactivated", "deleted", "updated", "auto-updated" ] }, "required": false }, "software_type": { "type": "array", "items": { "type": "string", "enum": [ "plugin", "theme", "wordpress" ] }, "required": false }, "patchable": { "type": "boolean", "required": false }, "first_seen_after": { "type": "string", "format": "date-time", "required": false }, "first_seen_before": { "type": "string", "format": "date-time", "required": false }, "last_seen_after": { "type": "string", "format": "date-time", "required": false }, "last_seen_before": { "type": "string", "format": "date-time", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/site-scanner\/vulnerabilities" } ] } }, "\/ithemes-security\/v1\/site-scanner\/vulnerabilities\/(?P[\\w-]+)": { "namespace": "ithemes-security\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/vulnerabilities\/(?P[\\w-]+)\/mute": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "type": "string", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/vulnerabilities\/(?P[\\w-]+)\/unmute": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "type": "string", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/vulnerabilities\/(?P[\\w-]+)\/fix": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "type": "string", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/vulnerabilities\/(?P[\\w-]+)\/deactivate-software": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "id": { "type": "string", "required": false } } } ] }, "\/ithemes-security\/v1\/site-scanner\/verify-scan": { "namespace": "ithemes-security\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "secret": { "type": "string", "minLength": 1, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/ithemes-security\/v1\/site-scanner\/verify-scan" } ] } }, "\/elementor\/v1\/library\/connect": { "namespace": "elementor\/v1", "methods": [ "POST", "DELETE" ], "endpoints": [ { "methods": [ "POST" ], "args": { "token": { "type": "string", "description": "Connect CLI token", "required": true } } }, { "methods": [ "DELETE" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/library\/connect" } ] } }, "\/elementor\/v1\/send-event": { "namespace": "elementor\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "event_data": { "description": "All the recorded event data in JSON format", "type": "object", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/elementor\/v1\/send-event" } ] } }, "\/wp-abilities\/v1": { "namespace": "wp-abilities\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wp-abilities\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp-abilities\/v1" } ] } }, "\/wp-abilities\/v1\/categories": { "namespace": "wp-abilities\/v1", "methods": [ "GET", "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 50, "minimum": 1, "maximum": 100, "required": false } } }, { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 50, "minimum": 1, "maximum": 100, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp-abilities\/v1\/categories" } ] } }, "\/wp-abilities\/v1\/categories\/(?P[a-z0-9]+(?:-[a-z0-9]+)*)": { "namespace": "wp-abilities\/v1", "methods": [ "GET", "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "slug": { "description": "Unique identifier for the ability category.", "type": "string", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "required": false } } }, { "methods": [ "GET" ], "args": { "slug": { "description": "Unique identifier for the ability category.", "type": "string", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "required": false } } } ] }, "\/wp-abilities\/v1\/abilities\/(?P[a-zA-Z0-9\\-\\\/]+?)\/run": { "namespace": "wp-abilities\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE", "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "args": { "name": { "description": "Unique identifier for the ability.", "type": "string", "pattern": "^[a-zA-Z0-9\\-\\\/]+$", "required": false }, "input": { "description": "Input parameters for the ability execution.", "type": [ "integer", "number", "boolean", "string", "array", "object", "null" ], "default": null, "required": false } } }, { "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "args": { "name": { "description": "Unique identifier for the ability.", "type": "string", "pattern": "^[a-zA-Z0-9\\-\\\/]+$", "required": false }, "input": { "description": "Input parameters for the ability execution.", "type": [ "integer", "number", "boolean", "string", "array", "object", "null" ], "default": null, "required": false } } } ] }, "\/wp-abilities\/v1\/abilities": { "namespace": "wp-abilities\/v1", "methods": [ "GET", "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 50, "minimum": 1, "maximum": 100, "required": false }, "category": { "description": "Limit results to abilities in specific ability category.", "type": "string", "required": false } } }, { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 50, "minimum": 1, "maximum": 100, "required": false }, "category": { "description": "Limit results to abilities in specific ability category.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/wp-abilities\/v1\/abilities" } ] } }, "\/wp-abilities\/v1\/abilities\/(?P[a-zA-Z0-9\\-\\\/]+)": { "namespace": "wp-abilities\/v1", "methods": [ "GET", "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "name": { "description": "Unique identifier for the ability.", "type": "string", "pattern": "^[a-zA-Z0-9\\-\\\/]+$", "required": false } } }, { "methods": [ "GET" ], "args": { "name": { "description": "Unique identifier for the ability.", "type": "string", "pattern": "^[a-zA-Z0-9\\-\\\/]+$", "required": false } } } ] }, "\/jetpack\/v4\/verify_registration": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/verify_registration" } ] } }, "\/jetpack\/v4\/remote_authorize": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/remote_authorize" } ] } }, "\/jetpack\/v4\/remote_provision": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/remote_provision" } ] } }, "\/jetpack\/v4\/remote_register": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/remote_register" } ] } }, "\/jetpack\/v4\/remote_connect": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/remote_connect" } ] } }, "\/jetpack\/v4\/connection\/check": { "namespace": "jetpack\/v4", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/check" } ] } }, "\/jetpack\/v4\/connection": { "namespace": "jetpack\/v4", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": [] }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection" } ] } }, "\/jetpack\/v4\/connection\/user": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/user" } ] } }, "\/jetpack\/v4\/connection\/data": { "namespace": "jetpack\/v4", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/data" } ] } }, "\/jetpack\/v4\/connection\/plugins": { "namespace": "jetpack\/v4", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/plugins" } ] } }, "\/jetpack\/v4\/connection\/reconnect": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/reconnect" } ] } }, "\/jetpack\/v4\/connection\/register": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "from": { "description": "Indicates where the registration action was triggered for tracking\/segmentation purposes", "type": "string", "required": false }, "redirect_uri": { "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string", "required": false }, "plugin_slug": { "description": "Indicates from what plugin the request is coming from", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/register" } ] } }, "\/jetpack\/v4\/connection\/authorize_url": { "namespace": "jetpack\/v4", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "redirect_uri": { "description": "URI of the admin page where the user should be redirected after connection flow", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/authorize_url" } ] } }, "\/jetpack\/v4\/user-token": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "user_token": { "description": "New user token", "type": "string", "required": true }, "is_connection_owner": { "description": "Is connection owner", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/user-token" } ] } }, "\/jetpack\/v4\/connection\/owner": { "namespace": "jetpack\/v4", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "owner": { "description": "New owner", "type": "integer", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/jetpack\/v4\/connection\/owner" } ] } }, "\/buddyboss\/v1": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "buddyboss\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1" } ] } }, "\/buddyboss\/v1\/moderation": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "item_id": { "description": "Get the result by reported item.", "type": "integer", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "desc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "order_by": { "description": "Column name to order the results by.", "default": "last_updated", "type": "string", "enum": [ "id", "item_type", "item_id", "last_updated", "hide_sitewide" ], "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "include": { "description": "Ensure result set includes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "reporters": { "description": "Whether to show the reporter ids or not.", "default": false, "type": "boolean", "required": false }, "status": { "description": "Whether to show the blocked or suspended. 0-Blocked, 1-Suspended", "type": "boolean", "required": false }, "blog_id": { "description": "Fetch the data for specific blog ID.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "item_id": { "description": "Item ID which needs to be blocked.", "type": "integer", "required": true }, "type": { "default": "user", "description": "Item type for the block.", "type": "string", "enum": [ "user" ], "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/moderation" } ] } }, "\/buddyboss\/v1\/moderation\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the moderation.", "type": "integer", "required": true } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the moderation.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/moderation\/report": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view" ], "default": "view", "required": false } } }, { "methods": [ "POST" ], "args": { "context": { "enum": [ "edit" ], "required": false }, "report_category": { "description": "Report Content", "type": "string", "enum": [ "789", "786", "787", "785", "788", "other" ], "required": true }, "note": { "description": "User Notes for the other type of report.", "type": "string", "default": "", "required": false }, "item_id": { "description": "Unique identifier for the content to report.", "type": "integer", "required": true }, "item_type": { "description": "Component type to report.", "type": "string", "enum": [ "activity", "activity_comment", "groups", "forum", "forum_topic", "forum_reply", "document", "media", "video", "comment" ], "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/moderation\/report" } ] } }, "\/buddyboss\/v1\/components": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "status": { "description": "Limit result set to items with a specific status.", "default": "all", "type": "string", "enum": [ "all", "active", "inactive" ], "required": false }, "type": { "description": "Limit result set to items with a specific type.", "default": "all", "type": "string", "enum": [ "all", "optional", "retired", "required" ], "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "type": "string", "description": "Name of the component.", "required": true }, "action": { "description": "Whether to activate or deactivate the component.", "type": "string", "enum": [ "activate", "deactivate" ], "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/components" } ] } }, "\/buddyboss\/v1\/settings": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/settings" } ] } }, "\/buddyboss\/v1\/members": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "type": { "description": "Shorthand for certain orderby\/order combinations.", "default": "newest", "type": "string", "enum": [ "active", "newest", "alphabetical", "random", "online", "popular", "include" ], "required": false }, "user_id": { "description": "Limit results to friends of a user.", "default": 0, "type": "integer", "required": false }, "user_ids": { "description": "Pass IDs of users to limit result set.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "include": { "description": "Ensure result set includes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "member_type": { "description": "Limit results set to certain type(s).", "default": [], "type": "array", "items": { "type": "string" }, "required": false }, "xprofile": { "description": "Limit results set to a certain xProfile field.", "default": "", "type": "string", "required": false }, "bp_ps_search": { "description": "Profile Search form field data(s).", "default": [], "type": "object", "required": false }, "scope": { "description": "Limit result set to items with a specific scope.", "type": "string", "default": "all", "enum": [ "all", "personal", "following", "followers" ], "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "Display name for the member.", "type": "string", "required": false }, "user_login": { "description": "An alphanumeric identifier for the Member.", "type": "string", "required": true }, "password": { "description": "Password for the member (never included).", "type": "string", "required": true }, "roles": { "description": "Roles assigned to the member.", "type": "array", "items": { "type": "string" }, "required": false }, "types": { "description": "Set type(s) for a member.", "type": "string", "enum": { "student": "student", "public-servant": "public-servant", "sse-practitioner": "sse-practitioner", "trainer": "trainer", "policy-maker": "policy-maker", "researcher": "researcher", "private-sector": "private-sector", "non-profit": "non-profit", "teacher": "teacher" }, "required": false }, "email": { "description": "The email address for the member.", "type": "string", "format": "email", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/members" } ] } }, "\/buddyboss\/v1\/members\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Unique identifier for the user.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "Unique identifier for the user.", "type": "integer", "required": false }, "name": { "description": "Display name for the member.", "type": "string", "required": false }, "roles": { "description": "Roles assigned to the member.", "type": "array", "items": { "type": "string" }, "required": false }, "types": { "description": "Set type(s) for a member.", "type": "string", "enum": { "student": "student", "public-servant": "public-servant", "sse-practitioner": "sse-practitioner", "trainer": "trainer", "policy-maker": "policy-maker", "researcher": "researcher", "private-sector": "private-sector", "non-profit": "non-profit", "teacher": "teacher" }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the Member.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/members\/me": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "name": { "description": "Display name for the member.", "type": "string", "required": false }, "roles": { "description": "Roles assigned to the member.", "type": "array", "items": { "type": "string" }, "required": false }, "types": { "description": "Set type(s) for a member.", "type": "string", "enum": { "student": "student", "public-servant": "public-servant", "sse-practitioner": "sse-practitioner", "trainer": "trainer", "policy-maker": "policy-maker", "researcher": "researcher", "private-sector": "private-sector", "non-profit": "non-profit", "teacher": "teacher" }, "required": false } } }, { "methods": [ "DELETE" ], "args": { "force": { "type": "boolean", "default": false, "description": "Required to be true, as users do not support trashing.", "required": false }, "reassign": { "type": "integer", "description": "Reassign the deleted user's posts and links to this user ID.", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/members\/me" } ] } }, "\/buddyboss\/v1\/members\/me\/permissions": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/members\/me\/permissions" } ] } }, "\/buddyboss\/v1\/members\/action\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the member.", "type": "integer", "required": false }, "action": { "description": "Action name which you want to perform for the member.", "type": "string", "enum": [ "follow", "unfollow" ], "required": false } } } ] }, "\/buddyboss\/v1\/members\/presence": { "namespace": "buddyboss\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "ids": { "description": "A unique users IDs of the member.", "type": "array", "items": { "type": "integer" }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/members\/presence" } ] } }, "\/buddyboss\/v1\/members\/details": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/members\/details" } ] } }, "\/buddyboss\/v1\/members\/(?P[\\d]+)\/detail": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the member.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/members\/profile-dropdown": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "default": { "description": "Whichever menu you have to retrieve.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/members\/profile-dropdown" } ] } }, "\/buddyboss\/v1\/members\/(?P[\\d]+)\/avatar": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "user_id": { "description": "A unique numeric ID for the Member.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "html": { "description": "Whether to return an HTML element, vs a raw URL to an avatar.", "default": false, "type": "boolean", "required": false }, "alt": { "description": "The alt attribute for the element.", "default": "", "type": "string", "required": false }, "no_gravatar": { "description": "Whether to disable the default Gravatar fallback.", "default": false, "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "user_id": { "description": "A unique numeric ID for the Member.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "user_id": { "description": "A unique numeric ID for the Member.", "type": "integer", "required": false } } } ] }, "\/buddyboss\/v1\/subscriptions": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "include": { "description": "Ensure result set includes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "desc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "order_by": { "description": "Order by a specific parameter.", "default": "date_recorded", "type": "string", "enum": [ "id", "type", "item_id", "date_recorded" ], "required": false }, "blog_id": { "description": "The ID of the current blog site.", "default": 1, "type": "integer", "required": false }, "type": { "description": "Limit result set to items with a specific subscription type.", "type": "string", "enum": [ "group", "forum", "topic" ], "required": false }, "item_id": { "description": "Limit result set to items with a specific prime association ID.", "default": 0, "type": "integer", "required": false }, "secondary_id": { "description": "Limit result set to items with a specific secondary association ID.", "default": 0, "type": "integer", "required": false }, "status": { "description": "Limit result set to active subscriptions or not.", "default": 1, "type": "integer", "enum": [ 0, 1 ], "required": false } } }, { "methods": [ "POST" ], "args": { "blog_id": { "default": 1, "description": "The ID of the current blog site.", "type": "integer", "required": false }, "user_id": { "default": 0, "description": "The ID of the user who created the subscription.", "type": "integer", "required": false }, "type": { "description": "The type of the subscription.", "type": "string", "enum": [ "group", "forum", "topic" ], "required": true }, "item_id": { "description": "The ID of subscription item.", "type": "integer", "required": true }, "secondary_item_id": { "description": "ID of the subscription item parent.", "type": "integer", "required": false }, "status": { "description": "Whether to check the subscription is active or not.", "type": "integer", "default": 1, "enum": [ 0, 1 ], "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/subscriptions" } ] } }, "\/buddyboss\/v1\/subscriptions\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the Subscription.", "type": "integer", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the Subscription.", "type": "integer", "required": false }, "blog_id": { "description": "The ID of the current blog site.", "type": "integer", "required": false }, "user_id": { "description": "The ID of the user who created the subscription.", "type": "integer", "required": false }, "type": { "description": "The type of the subscription.", "type": "string", "enum": [ "group", "forum", "topic" ], "required": false }, "item_id": { "description": "The ID of subscription item.", "type": "integer", "required": false }, "secondary_item_id": { "description": "ID of the subscription item parent.", "type": "integer", "required": false }, "status": { "description": "Whether to check the subscription is active or not.", "type": "integer", "required": false } } } ] }, "\/buddyboss\/v1\/subscription-types": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/subscription-types" } ] } }, "\/buddyboss\/v1\/mention": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "term": { "description": "Members @name suggestions.", "type": "string", "required": true }, "only_friends": { "description": "Limit result set to Friends only.", "type": "boolean", "required": false }, "group_id": { "description": "A unique numeric ID for the Group. Limit result set to the group.", "type": "integer", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/mention" } ] } }, "\/buddyboss\/v1\/members\/(?P[\\d]+)\/cover": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "user_id": { "description": "A unique numeric ID for the User.", "type": "integer", "required": false } } }, { "methods": [ "POST" ], "args": { "user_id": { "description": "A unique numeric ID for the User.", "type": "integer", "required": false } } }, { "methods": [ "DELETE" ], "args": { "user_id": { "description": "A unique numeric ID for the User.", "type": "integer", "required": false } } } ] }, "\/buddyboss\/v1\/signup\/form": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/signup\/form" } ] } }, "\/buddyboss\/v1\/signup": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false }, "number": { "description": "Total number of signups to return.", "default": 1, "type": "integer", "required": false }, "offset": { "description": "Offset the result set by a specific number of items.", "default": 0, "type": "integer", "required": false }, "include": { "description": "Ensure result set includes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "desc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Order by a specific parameter (default: signup_id).", "default": "signup_id", "type": "string", "required": false }, "user_login": { "description": "Specific user login to return.", "default": "", "type": "string", "required": false } } }, { "methods": [ "POST" ], "args": { "signup_email": { "description": "New user email address.", "type": "string", "required": true }, "signup_email_confirm": { "description": "New user confirm email address.", "type": "string", "required": true }, "signup_password": { "description": "New user account password.", "type": "string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/signup" } ] } }, "\/buddyboss\/v1\/signup\/(?P[\\w-]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "Identifier for the signup. Can be a signup ID, an email address, or a user_login.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "view", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "Identifier for the signup. Can be a signup ID, an email address, or a user_login.", "type": "string", "required": false }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "edit", "required": false } } } ] }, "\/buddyboss\/v1\/signup\/activate\/(?P[\\w-]+)": { "namespace": "buddyboss\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "activation_key": { "description": "Activation key of the signup.", "type": "string", "required": true }, "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "edit" ], "default": "edit", "required": false } } } ] }, "\/buddyboss\/v1\/xprofile\/fields": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "profile_group_id": { "description": "ID of the profile group of fields that have profile fields", "default": 0, "type": "integer", "required": false }, "hide_empty_groups": { "description": "Whether to hide profile groups of fields that do not have any profile fields or not.", "default": false, "type": "boolean", "required": false }, "user_id": { "description": "Required if you want to load a specific user's data.", "default": 0, "type": "integer", "required": false }, "member_type": { "description": "Limit fields by those restricted to a given member type, or array of member types. If `$user_id` is provided, the value of `$member_type` will be overridden by the member types of the provided user. The special value of 'any' will return only those fields that are unrestricted by member type - i.e., those applicable to any type.", "default": [], "type": "array", "items": { "type": "string" }, "required": false }, "hide_empty_fields": { "description": "Whether to hide profile fields where the user has not provided data or not.", "default": false, "type": "boolean", "required": false }, "fetch_field_data": { "description": "Whether to fetch data for each field. Requires a $user_id.", "default": false, "type": "boolean", "required": false }, "fetch_visibility_level": { "description": "Whether to fetch the visibility level for each field.", "default": false, "type": "boolean", "required": false }, "exclude_groups": { "description": "Ensure result set excludes specific profile field groups.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_fields": { "description": "Ensure result set excludes specific profile fields.", "default": [], "type": "array", "items": { "type": "string" }, "required": false }, "update_meta_cache": { "description": "Whether to pre-fetch xprofilemeta for all retrieved groups, fields, and data.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "group_id": { "description": "The ID of the group the field is part of.", "type": "integer", "required": true }, "parent_id": { "description": "The ID of the parent field.", "type": "integer", "required": false }, "type": { "description": "The type for the profile field.", "type": "string", "enum": [ "checkbox", "datebox", "multiselectbox", "number", "url", "radio", "selectbox", "textarea", "textbox", "telephone", "gender", "socialnetworks", "membertypes", "birthdate", "email", "web", "datepicker", "select_custom_post_type", "country", "multiselect_custom_post_type", "select_custom_taxonomy", "multiselect_custom_taxonomy", "checkbox_acceptance", "image", "file", "color", "decimal_number", "number_minmax", "slider", "fromto", "oembed", "token", "tags", "option" ], "required": true }, "name": { "description": "The name of the profile field.", "type": "string", "required": true }, "alternate_name": { "default": "", "description": "The alternate name of the profile field.", "type": "string", "required": false }, "description": { "description": "The description of the profile field.", "type": "string", "required": false }, "is_required": { "description": "Whether the profile field must have a value.", "type": "boolean", "required": false }, "can_delete": { "default": true, "description": "Whether the profile field can be deleted or not.", "type": "boolean", "required": false }, "field_order": { "description": "The order of the profile field into the group of fields.", "type": "integer", "required": false }, "option_order": { "description": "The order of the option into the profile field list of options", "type": "integer", "required": false }, "order_by": { "default": "asc", "description": "The way profile field's options are ordered.", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "is_default_option": { "description": "Whether the option is the default one for the profile field.", "type": "boolean", "required": false }, "default_visibility": { "default": "public", "description": "Default visibility for the profile field.", "type": "string", "enum": [ "public", "loggedin", "friends", "adminsonly" ], "required": false }, "allow_custom_visibility": { "description": "Whether to allow members to set the visibility for the profile field data or not.", "default": "allowed", "type": "string", "enum": [ "allowed", "disabled" ], "required": false }, "do_autolink": { "description": "Autolink status for this profile field", "default": "off", "type": "string", "enum": [ "on", "off" ], "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/xprofile\/fields" } ] } }, "\/buddyboss\/v1\/xprofile\/fields\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the profile field.", "type": "integer", "required": false }, "user_id": { "description": "Required if you want to load a specific user's data.", "default": 0, "type": "integer", "required": false }, "fetch_field_data": { "description": "Whether to fetch data for the field. Requires a $user_id.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the profile field.", "type": "integer", "required": false }, "group_id": { "description": "The ID of the group the field is part of.", "type": "integer", "required": false }, "parent_id": { "description": "The ID of the parent field.", "type": "integer", "required": false }, "type": { "description": "The type for the profile field.", "type": "string", "enum": [ "checkbox", "datebox", "multiselectbox", "number", "url", "radio", "selectbox", "textarea", "textbox", "telephone", "gender", "socialnetworks", "membertypes", "birthdate", "email", "web", "datepicker", "select_custom_post_type", "country", "multiselect_custom_post_type", "select_custom_taxonomy", "multiselect_custom_taxonomy", "checkbox_acceptance", "image", "file", "color", "decimal_number", "number_minmax", "slider", "fromto", "oembed", "token", "tags", "option" ], "required": false }, "name": { "description": "The name of the profile field.", "type": "string", "required": false }, "alternate_name": { "description": "The alternate name of the profile field.", "type": "string", "required": false }, "description": { "description": "The description of the profile field.", "type": "string", "required": false }, "is_required": { "description": "Whether the profile field must have a value.", "type": "boolean", "required": false }, "can_delete": { "description": "Whether the profile field can be deleted or not.", "type": "boolean", "default": true, "required": false }, "field_order": { "description": "The order of the profile field into the group of fields.", "type": "integer", "required": false }, "option_order": { "description": "The order of the option into the profile field list of options", "type": "integer", "required": false }, "order_by": { "description": "The way profile field's options are ordered.", "type": "string", "enum": [ "asc", "desc" ], "default": "asc", "required": false }, "is_default_option": { "description": "Whether the option is the default one for the profile field.", "type": "boolean", "required": false }, "default_visibility": { "description": "Default visibility for the profile field.", "type": "string", "enum": [ "public", "loggedin", "friends", "adminsonly" ], "default": "public", "required": false }, "allow_custom_visibility": { "description": "Whether to allow members to set the visibility for the profile field data or not.", "default": "allowed", "type": "string", "enum": [ "allowed", "disabled" ], "required": false }, "do_autolink": { "description": "Autolink status for this profile field", "default": "off", "type": "string", "enum": [ "on", "off" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the profile field.", "type": "integer", "required": false }, "delete_data": { "description": "Required if you want to delete users data for the field.", "default": false, "type": "boolean", "required": false } } } ] }, "\/buddyboss\/v1\/xprofile\/groups": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "profile_group_id": { "description": "ID of the field group that have fields.", "default": 0, "type": "integer", "required": false }, "hide_empty_groups": { "description": "Whether to hide profile groups of fields that do not have any profile fields or not.", "default": false, "type": "boolean", "required": false }, "user_id": { "description": "Required if you want to load a specific user's data.", "default": 0, "type": "integer", "required": false }, "member_type": { "description": "Limit fields by those restricted to a given member type, or array of member types. If `$user_id` is provided, the value of `$member_type` will be overridden by the member types of the provided user. The special value of 'any' will return only those fields that are unrestricted by member type - i.e., those applicable to any type.", "default": [], "type": "array", "items": { "type": "string" }, "required": false }, "hide_empty_fields": { "description": "Whether to hide profile groups of fields that do not have any profile fields or not.", "default": false, "type": "boolean", "required": false }, "fetch_fields": { "description": "Whether to fetch the fields for each group.", "default": false, "type": "boolean", "required": false }, "fetch_field_data": { "description": "Whether to fetch data for each field. Requires a $user_id.", "default": false, "type": "boolean", "required": false }, "fetch_visibility_level": { "description": "Whether to fetch the visibility level for each field.", "default": false, "type": "boolean", "required": false }, "exclude_groups": { "description": "Ensure result set excludes specific profile field groups.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_fields": { "description": "Ensure result set excludes specific profile fields.", "default": [], "type": "array", "items": { "type": "string" }, "required": false }, "update_meta_cache": { "description": "Whether to pre-fetch xprofilemeta for all retrieved groups, fields, and data.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "name": { "description": "The name of group of profile fields.", "type": "string", "required": false }, "description": { "description": "The description of the group of profile fields.", "type": "string", "required": false }, "can_delete": { "description": "Whether the group of profile fields can be deleted or not.", "type": "boolean", "required": false }, "repeater_enabled": { "description": "Whether the group of profile fields can be repeated or not.", "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/xprofile\/groups" } ] } }, "\/buddyboss\/v1\/xprofile\/groups\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the group of profile fields.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the group of profile fields.", "type": "integer", "required": false }, "name": { "description": "The name of group of profile fields.", "type": "string", "required": false }, "description": { "description": "The description of the group of profile fields.", "type": "string", "required": false }, "group_order": { "description": "The order of the group of profile fields.", "type": "integer", "required": false }, "can_delete": { "description": "Whether the group of profile fields can be deleted or not.", "type": "boolean", "required": false }, "repeater_enabled": { "description": "Whether the group of profile fields can be repeated or not.", "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the group of profile fields.", "type": "integer", "required": false } } } ] }, "\/buddyboss\/v1\/xprofile\/(?P[\\d]+)\/data\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "field_id": { "description": "The ID of the field the data is from.", "type": "integer", "required": false }, "user_id": { "description": "The ID of user the field data is from.", "type": "integer", "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "field_id": { "description": "The ID of the field the data is from.", "type": "integer", "required": false }, "user_id": { "description": "The ID of user the field data is from.", "type": "integer", "required": false }, "value": { "description": "The list of values for the field data.", "required": false } } }, { "methods": [ "DELETE" ], "args": { "field_id": { "description": "The ID of the field the data is from.", "type": "integer", "required": false }, "user_id": { "description": "The ID of user the field data is from.", "type": "integer", "required": false } } } ] }, "\/buddyboss\/v1\/xprofile\/update": { "namespace": "buddyboss\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "edit" ], "default": "edit", "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "fields": { "description": "Fields array with field_id, group_id, type, value and visibility_level to update the data.", "type": "array", "items": { "type": "object" }, "default": [ { "field_id": "", "group_id": "", "value": "", "visibility_level": "" } ], "properties": { "field_id": { "description": "The ID of the field the data is from.", "type": "integer", "required": true, "sanitize_callback": "absint", "validate_callback": "rest_validate_request_arg" }, "group_id": { "description": "ID of the profile group of fields that have profile fields", "default": 0, "type": "integer", "sanitize_callback": "absint", "validate_callback": "rest_validate_request_arg" }, "value": { "description": "The value of the field data." }, "visibility_level": { "description": "Who may see the saved value for this profile field.", "default": "public", "type": "string", "enum": [ "public", "loggedin", "friends", "adminsonly" ] } }, "required": true }, "profile_group_id": { "description": "ID of the field group that have fields.", "default": 0, "type": "integer", "required": false }, "hide_empty_groups": { "description": "Whether to hide profile groups of fields that do not have any profile fields or not.", "default": false, "type": "boolean", "required": false }, "member_type": { "description": "Limit fields by those restricted to a given member type, or array of member types. If `$user_id` is provided, the value of `$member_type` will be overridden by the member types of the provided user. The special value of 'any' will return only those fields that are unrestricted by member type - i.e., those applicable to any type.", "default": [], "type": "array", "items": { "type": "string" }, "required": false }, "hide_empty_fields": { "description": "Whether to hide profile groups of fields that do not have any profile fields or not.", "default": false, "type": "boolean", "required": false }, "fetch_fields": { "description": "Whether to fetch the fields for each group.", "default": true, "type": "boolean", "required": false }, "fetch_field_data": { "description": "Whether to fetch data for each field. Requires a $user_id.", "default": true, "type": "boolean", "required": false }, "fetch_visibility_level": { "description": "Whether to fetch the visibility level for each field.", "default": true, "type": "boolean", "required": false }, "exclude_groups": { "description": "Ensure result set excludes specific profile field groups.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude_fields": { "description": "Ensure result set excludes specific profile fields.", "default": [], "type": "array", "items": { "type": "string" }, "required": false }, "update_meta_cache": { "description": "Whether to pre-fetch xprofilemeta for all retrieved groups, fields, and data.", "default": true, "type": "boolean", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/xprofile\/update" } ] } }, "\/buddyboss\/v1\/xprofile\/repeater\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "POST", "DELETE" ], "endpoints": [ { "methods": [ "POST" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "edit", "required": false }, "id": { "description": "A unique numeric ID for the group of profile fields.", "type": "integer", "required": false }, "fetch_fields": { "description": "Whether to fetch the fields for each group.", "default": true, "type": "boolean", "required": false }, "fetch_field_data": { "description": "Whether to fetch data for each field. Requires a $user_id.", "default": true, "type": "boolean", "required": false }, "fetch_visibility_level": { "description": "Whether to fetch the visibility level for each field.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "DELETE" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "edit", "required": false }, "id": { "description": "A unique numeric ID for the group of profile fields.", "type": "integer", "required": false }, "fetch_fields": { "description": "Whether to fetch the fields for each group.", "default": true, "type": "boolean", "required": false }, "fetch_field_data": { "description": "Whether to fetch data for each field. Requires a $user_id.", "default": true, "type": "boolean", "required": false }, "fetch_visibility_level": { "description": "Whether to fetch the visibility level for each field.", "default": true, "type": "boolean", "required": false }, "fields": { "description": "Pass Field IDs which you want to delete it.", "type": "array", "items": { "type": "integer" }, "required": true } } } ] }, "\/buddyboss\/v1\/xprofile\/repeater\/order\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "POST", "PUT", "PATCH" ], "endpoints": [ { "methods": [ "POST", "PUT", "PATCH" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "edit", "required": false }, "id": { "description": "A unique numeric ID for the group of profile fields.", "type": "integer", "required": false }, "fetch_fields": { "description": "Whether to fetch the fields for each group.", "default": true, "type": "boolean", "required": false }, "fetch_field_data": { "description": "Whether to fetch data for each field. Requires a $user_id.", "default": true, "type": "boolean", "required": false }, "fetch_visibility_level": { "description": "Whether to fetch the visibility level for each field.", "default": true, "type": "boolean", "required": false }, "fields": { "description": "Fields array with order of field set with field ID and value to reorder.", "type": "array", "items": { "type": "object" }, "required": true } } } ] }, "\/buddyboss\/v1\/xprofile\/search": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "form_id": { "description": "ID of the profile search form.", "type": "string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/xprofile\/search" } ] } }, "\/buddyboss\/v1\/xprofile\/types": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/xprofile\/types" } ] } }, "\/buddyboss\/v1\/video\/upload": { "namespace": "buddyboss\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/video\/upload" } ] } }, "\/buddyboss\/v1\/video": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "desc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Order by a specific parameter.", "default": "date_created", "type": "string", "enum": [ "date_created", "menu_order", "id", "include" ], "required": false }, "user_id": { "description": "Limit result set to items created by a specific user.", "default": 0, "type": "integer", "required": false }, "max": { "description": "Maximum number of results to return.", "type": "integer", "required": false }, "album_id": { "description": "A unique numeric ID for the Album.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "activity_id": { "description": "A unique numeric ID for the Video's Activity.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the video.", "type": "array", "items": { "enum": [ "public", "loggedin", "onlyme", "friends", "grouponly" ], "type": "string" }, "required": false }, "scope": { "description": "Scope of the video.", "type": "array", "items": { "enum": [ "friends", "groups", "personal" ], "type": "string" }, "required": false }, "include": { "description": "Ensure result set includes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude": { "description": "Ensure result set excludes specific video IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "count_total": { "description": "Show total count or not.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "upload_ids": { "description": "Video specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": true }, "activity_id": { "description": "A unique numeric ID for the activity.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "album_id": { "description": "A unique numeric ID for the Video Album.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the video.", "type": "string", "enum": [ "public", "loggedin", "onlyme", "friends", "grouponly" ], "default": "public", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/video" } ] } }, "\/buddyboss\/v1\/video\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the video.", "type": "integer", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the video.", "type": "integer", "required": true }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "album_id": { "description": "A unique numeric ID for the Video Album.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the video.", "type": "string", "enum": [ "public", "loggedin", "onlyme", "friends", "grouponly" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the video.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/video\/(?P[\\d]+)\/upload_poster": { "namespace": "buddyboss\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ] }, "\/buddyboss\/v1\/video\/(?P[\\d]+)\/poster": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the video.", "type": "integer", "required": true } } }, { "methods": [ "POST" ], "args": { "id": { "description": "A unique numeric ID for the video.", "type": "integer", "required": true }, "attachment_id": { "description": "A Unique numeric ID for the video poster.", "type": "integer", "required": false }, "file": { "description": "File path for video poster.", "type": "string", "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the video.", "type": "integer", "required": true }, "attachment_id": { "description": "A Unique numeric ID for the video poster.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/video\/details": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/video\/details" } ] } }, "\/buddyboss\/v1\/media": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "desc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Order media by which attribute.", "default": "date_created", "type": "string", "enum": [ "date_created", "menu_order", "id", "include" ], "required": false }, "user_id": { "description": "Limit results to friends of a user.", "default": 0, "type": "integer", "required": false }, "max": { "description": "Maximum number of results to return", "type": "integer", "required": false }, "album_id": { "description": "A unique numeric ID for the Album.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "activity_id": { "description": "A unique numeric ID for the Media's Activity.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the media.", "type": "array", "items": { "enum": [ "public", "loggedin", "onlyme", "friends", "grouponly" ], "type": "string" }, "required": false }, "scope": { "description": "Scope of the media.", "type": "array", "items": { "enum": [ "friends", "groups", "personal" ], "type": "string" }, "required": false }, "include": { "description": "Ensure result set includes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude": { "description": "Ensure result set excludes specific media IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "count_total": { "description": "Show total count or not.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "upload_ids": { "description": "Media specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": true }, "activity_id": { "description": "A unique numeric ID for the activity.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "album_id": { "description": "A unique numeric ID for the Media Album.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the media.", "type": "string", "enum": [ "public", "loggedin", "onlyme", "friends", "grouponly" ], "default": "public", "required": false } } }, { "methods": [ "DELETE" ], "args": { "media_ids": { "description": "A unique numeric IDs for the media.", "type": "array", "items": { "type": "integer" }, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/media" } ] } }, "\/buddyboss\/v1\/media\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the media.", "type": "integer", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the media.", "type": "integer", "required": true }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "album_id": { "description": "A unique numeric ID for the Media Album.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the media.", "type": "string", "enum": [ "public", "loggedin", "onlyme", "friends", "grouponly" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the media.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/media\/upload": { "namespace": "buddyboss\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/media\/upload" } ] } }, "\/buddyboss\/v1\/media\/albums": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "desc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Order albums by which attribute.", "default": "date_created", "type": "string", "enum": [ "date_created", "menu_order" ], "required": false }, "max": { "description": "Maximum number of results to return", "type": "integer", "required": false }, "user_id": { "description": "Limit results to friends of a user.", "default": 0, "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "privacy": { "description": "The privacy of album.", "default": "public", "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "type": "string", "required": false }, "include": { "description": "Ensure result set includes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude": { "description": "Ensure result set excludes specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "count_total": { "description": "Show total count or not.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "title": { "description": "New Album Title.", "type": "string", "required": true }, "privacy": { "description": "A unique numeric ID for the Media Album.", "type": "string", "default": "public", "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "user_id": { "description": "The ID for the author of the Album.", "type": "integer", "required": false }, "upload_ids": { "description": "Media specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/media\/albums" } ] } }, "\/buddyboss\/v1\/media\/albums\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the album.", "type": "integer", "required": true }, "media_page": { "description": "Current page of Album Medias.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "media_per_page": { "description": "Maximum number of medias to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the album.", "type": "integer", "required": true }, "title": { "description": "New Album Title.", "type": "string", "required": false }, "privacy": { "description": "A unique numeric ID for the Media Album.", "type": "string", "default": "public", "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the album.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/media\/details": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/media\/details" } ] } }, "\/buddyboss\/v1\/media\/move": { "namespace": "buddyboss\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "media_ids": { "description": "Media specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": true }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "album_id": { "description": "A unique numeric ID for the Media Album.", "type": "integer", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/media\/move" } ] } }, "\/buddyboss\/v1\/document\/upload": { "namespace": "buddyboss\/v1", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/document\/upload" } ] } }, "\/buddyboss\/v1\/document": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "asc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Order documents by which attribute.", "default": "title", "type": "string", "enum": [ "title", "date_created", "date_modified", "group_id", "privacy", "id", "include" ], "required": false }, "max": { "description": "Maximum number of results to return", "type": "integer", "required": false }, "scope": { "description": "Scope of the Document.", "type": "array", "items": { "enum": [ "public", "friends", "groups", "personal" ], "type": "string" }, "required": false }, "user_id": { "description": "Limit results to a specific user.", "default": 0, "type": "integer", "required": false }, "folder_id": { "description": "A unique numeric ID for the Folder.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "activity_id": { "description": "A unique numeric ID for the Document's Activity.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the Document.", "type": "array", "items": { "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "type": "string" }, "required": false }, "include": { "description": "Ensure result set includes specific document IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude": { "description": "Ensure result set excludes specific document IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "count_total": { "description": "Show total count or not.", "default": true, "type": "boolean", "required": false }, "type": { "description": "Type of document.", "default": "both", "type": "string", "enum": [ "both", "document", "folder" ], "required": false } } }, { "methods": [ "POST" ], "args": { "document_ids": { "description": "Document specific IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": true }, "activity_id": { "description": "A unique numeric ID for the activity.", "type": "integer", "required": false }, "content": { "description": "Document Content.", "type": "string", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "folder_id": { "description": "A unique numeric ID for the Document Folder.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the document.", "type": "string", "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "default": "public", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/document" } ] } }, "\/buddyboss\/v1\/document\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the document.", "type": "integer", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the document.", "type": "integer", "required": true }, "content": { "description": "Document Content.", "type": "string", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "folder_id": { "description": "A unique numeric ID for the Document Folder.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the document.", "type": "string", "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the document.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/document\/folder": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "required": false }, "page": { "description": "Current page of the collection.", "type": "integer", "default": 1, "minimum": 1, "required": false }, "per_page": { "description": "Maximum number of items to be returned in result set.", "type": "integer", "default": 10, "minimum": 1, "maximum": 100, "required": false }, "search": { "description": "Limit results to those matching a string.", "type": "string", "required": false }, "order": { "description": "Order sort attribute ascending or descending.", "default": "desc", "type": "string", "enum": [ "asc", "desc" ], "required": false }, "orderby": { "description": "Order folders by which attribute.", "default": "date_created", "type": "string", "enum": [ "id", "title", "date_created", "user_id", "group_id", "privacy" ], "required": false }, "max": { "description": "Maximum number of results to return", "type": "integer", "required": false }, "user_id": { "description": "Limit results to a specific user.", "default": 0, "type": "integer", "required": false }, "parent": { "description": "A unique numeric ID for the parent Folder.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the folder.", "type": "array", "items": { "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "type": "string" }, "required": false }, "include": { "description": "Ensure result set includes specific folder IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "exclude": { "description": "Ensure result set excludes specific folder IDs.", "default": [], "type": "array", "items": { "type": "integer" }, "required": false }, "count_total": { "description": "Show total count or not.", "default": true, "type": "boolean", "required": false } } }, { "methods": [ "POST" ], "args": { "title": { "description": "Folder Title.", "type": "string", "required": true }, "parent": { "description": "A unique numeric ID for the parent folder.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the folder.", "type": "string", "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "default": "public", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/document\/folder" } ] } }, "\/buddyboss\/v1\/document\/folder\/(?P[\\d]+)": { "namespace": "buddyboss\/v1", "methods": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "endpoints": [ { "methods": [ "GET" ], "args": { "id": { "description": "A unique numeric ID for the folder.", "type": "integer", "required": true } } }, { "methods": [ "POST", "PUT", "PATCH" ], "args": { "id": { "description": "A unique numeric ID for the folder", "type": "integer", "required": true }, "title": { "description": "Folder Title.", "type": "string", "required": false }, "parent": { "description": "A unique numeric ID for the parent folder.", "type": "integer", "required": false }, "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "privacy": { "description": "Privacy of the folder.", "type": "string", "enum": [ "public", "loggedin", "friends", "onlyme", "grouponly" ], "required": false } } }, { "methods": [ "DELETE" ], "args": { "id": { "description": "A unique numeric ID for the folder.", "type": "integer", "required": true } } } ] }, "\/buddyboss\/v1\/document\/folder\/tree": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "group_id": { "description": "A unique numeric ID for the Group.", "type": "integer", "required": false }, "hierarchical": { "description": "Whether to retrieve as a hierarchical or not.", "type": "boolean", "default": true, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/document\/folder\/tree" } ] } }, "\/buddyboss\/v1\/document\/details": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/document\/details" } ] } }, "\/buddyboss\/v1\/account-settings": { "namespace": "buddyboss\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/medsocialinnovationlab.org\/en_gb\/wp-json\/buddyboss\/v1\/account-settings" } ] } }, "\/buddyboss\/v1\/account-settings\/(?P