Skip to content

Developers

How can we help you?

← Go back

Outlet

Note: This resource links can be expanded using the expand option.

An outlet represents the means by which BeBanjo talks to a particular real platform.

In BeBanjo land, an outlet looks like this:

<?xml version='1.0' encoding='utf-8' ?>
<outlet>
  <id type="integer">1</id>
  <name>BeBanjo Movies</name>
  <link rel="self" href="https://movida.bebanjo.net/api/outlets/1"/>
  <link rel="platforms" href="https://movida.bebanjo.net/api/outlets/1/platforms"/>
</outlet>

{
  "resource_type": "outlet",
  "id": 1,
  "name": "BeBanjo Movies",
  "self_link": "https://movida.bebanjo.net/api/outlets/1",
  "platforms_link": "https://movida.bebanjo.net/api/outlets/1/platforms"
}

Get a list of all outlets

As you would expect, just do a GET /api/outlets:

$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/outlets

$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api/outlets

And:

<?xml version='1.0' encoding='utf-8' ?>
<outlets type='array'>
  <outlet>
    <id type="integer">1</id>
    <name>BeBanjo Movies</name>
    <link rel="self" href="https://movida.bebanjo.net/api/outlets/1"/>
    <link rel="platforms" href="https://movida.bebanjo.net/api/outlets/1/platforms"/>
  </outlet>
  <outlet>
    <id type="integer">2</id>
    <name>YouTube</name>
    <link rel="self" href="https://movida.bebanjo.net/api/outlets/2"/>
    <link rel="platforms" href="https://movida.bebanjo.net/api/outlets/2/platforms"/>
  </outlet>
</outlets>

{
  "entries": [
    {
      "resource_type": "outlet",
      "id": 1,
      "name": "BeBanjo Movies",
      "self_link": "https://movida.bebanjo.net/api/outlets/1",
      "platforms_link": "https://movida.bebanjo.net/api/outlets/1/platforms"
    },
    {
      "resource_type": "outlet",
      "id": 2,
      "name": "YouTube",
      "self_link": "https://movida.bebanjo.net/api/outlets/2",
      "platforms_link": "https://movida.bebanjo.net/api/outlets/2/platforms"
    }
  ]
}

Then follow the links to access their platforms.

Get a single outlet

Just do a GET to the URL of the outlet:

$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/outlets/1

$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api/outlets/1

And:

<?xml version='1.0' encoding='utf-8' ?>
<outlet>
  <id type="integer">1</id>
  <name>BeBanjo Movies</name>
  <link rel="self" href="https://movida.bebanjo.net/api/outlets/1"/>
  <link rel="platforms" href="https://movida.bebanjo.net/api/outlets/1/platforms"/>
</outlet>

{
  "resource_type": "outlet",
  "id": 1,
  "name": "BeBanjo Movies",
  "self_link": "https://movida.bebanjo.net/api/outlets/1",
  "platforms_link": "https://movida.bebanjo.net/api/outlets/1/platforms"
}