Get package

GET

/wp-json/wp2lms-pro/embed-packages/v1/packages/{id}

const url = 'https://example.com/wp-json/wp2lms-pro/embed-packages/v1/packages/42?blog_id=1';
const options = {method: 'GET', headers: {'X-WP-Nonce': '<X-WP-Nonce>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/wp-json/wp2lms-pro/embed-packages/v1/packages/42?blog_id=1' \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

One package by CPT wp2lms_embed_pkg post ID. Body is package_payload. This is not the WordPress page binding (see GET …/pages/{page_id}/package) and the ZIP bytes are not in the response: metadata and launch URL only. Unknown id or post_type ≠ wp2lms_embed_pkg is 404 embed_packages_not_found. Requires manage_network (multisite) or edit_pages. Cookie + X-WP-Nonce or Application Password.

Authorizations

cookie
applicationPassword

Parameters

Path Parameters

required

integer

>= 1

CPT wp2lms_embed_pkg post ID (the id field in the payload). Not blog_id and not page_id. Unknown id or another post_type — 404 embed_packages_not_found.

Example

Query Parameters

blog_id

integer

>= 1

Network site ID (switch_to_blog). Optional: defaults to the request current blog. Not a package id and not page_id. Minimum 1; on a single site it must match the current site — otherwise 400 embed_packages_invalid_blog. In a network an unknown site or a site from another network is 404 embed_packages_unknown_blog.

Example

Responses

200

Package found. Body is package_payload.

application/json

package_payload response — CPT post plus flattened meta fields and the full meta object.

object

CPT wp2lms_embed_pkg post ID. Same number as {id} in GET/PATCH/DELETE/content/materialize-pages paths.

integer

title

Package post_title. After ingest PHP may replace it with the launch file <title>.

string

status

Package post_status. REST accepts publish/draft/private; the response is whatever is stored.

string

content_type

Copy of meta.content_type (web / scorm1.2 / scorm2004 / xapi or empty).

string

content_tool

Copy of meta.content_tool (authoring-tool detector or empty string).

string

launch_path

Copy of meta.launch_path — relative launch HTML, not a URL.

string

launch_url

Absolute launch URL (uploads baseurl + storage_rel + launch_path). Empty when there is no content.

string format: uri

activity_id

Copy of meta.activity_id.

string

storage_rel

Copy of meta.storage_rel under uploads.

string

is_multipage

Copy of meta.is_multipage.

boolean

pages

Array<object>

object

path

Relative HTML path inside the package directory (posix, no leading /). From PackagePagesIndex::scan.

string

title

Title from the file <title> tag, or the basename if the tag is missing.

string

meta

One of:

object
array

Full post meta array _wp2lms_embed_package (PackageMeta::get). Empty object when the package has not been ingested.

object

content_type

Type after ManifestPipeline — web, scorm1.2, scorm2004, or xapi. Empty until content is uploaded.

string

version

Version from the manifest (for SCORM often the same as content_type). Empty string for typical web packages.

string

activity_id

XAPI activity id. If the parser omitted it — {home}wp2lms-embed-package/{id}.

string

launch_path

Relative launch HTML inside storage (from the manifest or fallback index.html).

string

title

Title from launch HTML / manifest; PHP may overwrite the package post_title with this value.

string

mastery_score

Mastery score from imsmanifest (SCORM), otherwise null.

number

nullable

content_tool

Authoring-tool detector: ispring, articulate_rise, articulate_storyline, articulate_presenter, captivate, elucidat, or an empty string.

string

storage_rel

Path from uploads basedir, wp2lms-embed-packages/{id}/.

string

uploaded_at

Unix time of the last successful content write (time() in finalize).

integer

is_multipage

True only for content_type=web with no content_tool and ≥2 HTML files in the index.

boolean

pages

HTML index (path+title) when the package is multipage; otherwise [].

Array<object>

object

path

Relative HTML path inside the package directory (posix, no leading /). From PackagePagesIndex::scan.

string

title

Title from the file <title> tag, or the basename if the tag is missing.

string

Example

{
  "id": 42,
  "title": "Interactive lesson",
  "status": "publish",
  "content_type": "web",
  "content_tool": "",
  "launch_path": "index.html",
  "launch_url": "https://lms.example.com/wp-content/uploads/wp2lms-embed-packages/42/index.html",
  "activity_id": "https://lms.example.com/wp2lms-embed-package/42",
  "storage_rel": "wp2lms-embed-packages/42/",
  "is_multipage": false,
  "pages": [],
  "meta": {
    "content_type": "web",
    "version": "",
    "activity_id": "https://lms.example.com/wp2lms-embed-package/42",
    "launch_path": "index.html",
    "title": "Interactive lesson",
    "mastery_score": null,
    "content_tool": "",
    "storage_rel": "wp2lms-embed-packages/42/",
    "uploaded_at": 1726252800,
    "pages": [],
    "is_multipage": false
  }
}

400

Embed_packages_invalid_blog — blog_id < 1, or on a single site it does not match the current site.

application/json

object

code

WP_Error code (get_error_code()), e.g. embed_packages_not_found.

string

message

WP_Error text (get_error_message()).

string

data

WP_Error data. Usually { "status": 404 }. Ingest/materialize errors without status are returned by WordPress REST as 500.

object

Example

{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}

401

Not authenticated. WordPress REST: rest_forbidden (status 401) when there is no cookie session. Cookie + X-WP-Nonce or Application Password.

application/json

object

code

WP_Error code (get_error_code()), e.g. embed_packages_not_found.

string

message

WP_Error text (get_error_message()).

string

data

WP_Error data. Usually { "status": 404 }. Ingest/materialize errors without status are returned by WordPress REST as 500.

object

Example

{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}

403

Missing manage_network (multisite) or edit_pages (single site), or invalid REST nonce (rest_cookie_invalid_nonce).

application/json

object

code

WP_Error code (get_error_code()), e.g. embed_packages_not_found.

string

message

WP_Error text (get_error_message()).

string

data

WP_Error data. Usually { "status": 404 }. Ingest/materialize errors without status are returned by WordPress REST as 500.

object

Example

{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}

404

Embed_packages_not_found — no package with this id; embed_packages_unknown_blog — unknown blog_id in the network.

application/json

object

code

WP_Error code (get_error_code()), e.g. embed_packages_not_found.

string

message

WP_Error text (get_error_message()).

string

data

WP_Error data. Usually { "status": 404 }. Ingest/materialize errors without status are returned by WordPress REST as 500.

object

Example

{
  "code": "embed_packages_not_found",
  "message": "Package not found.",
  "data": {
    "status": 404
  }
}