version 8.3.8

Back | 

Oembed

Implements the oembed response specification found at http://oembed.com/. Takes in a mediasuite player URL, and returns that URL wrapped in an iframe to be embedded in any site that accepts the Oembed specs. URLs must conform to the .ORIGIN.com/ format. Accepts player.php URLs with p/{project_uuid}, v/{program_uuid}, e/{live_event_uuid}, or s/{live_series_uuid} params.

URL Format

/ws/oembed/apiv/4.0?url={url}

Parameters

Name Req Type Description
url string The urlencoded permalink for a project/program
apiv string The service version
mode string Specifies response mode. Can be {'xml','json'}.

Request Headers

Name

Possible Responses

  • xxx {oembed object response}
  • 338 Invalid Project UUID
  • 305 Invalid Program UUID
  • 312 Invalid Live Event UUID
  • 313 Invalid Live Series UUID

Example Response

<?xml version="1.0" encoding="utf-8"?>
<response>
    <failure>
        <code>2</code>
        <reason>No Service Calls</reason>
        <details/>
        <severity>Error</severity>
        <dtstamp>2024-11-21 20:25:22</dtstamp>
    </failure>
</response>