Browse internal API documentation version v1

http://{slave}

Lookup in Zookeeper with service name "nibble-internal"

  • slave: required(string)

/category

get post

get
post

Will autogenerate id if not supplied in request, or create with specified id if supplied

Will autogenerate id if not supplied in request, or create with specified id if supplied

Headers

  • Magine-PartnerId: required(string)

    Example:

    testing

Body

Media type: application/json

Type: object

Properties
  • type: required(string)
  • id: (string)
  • kind: required(string)
  • title: required(object)
    • /^.+$/: required(string)
  • sorting: (string)
  • theme: (string)
  • images: (object)
    • /^.+$/: required(string)
  • description: (string)
  • visibility: required(string)
  • kindFilter: (string)
  • languageFilter: (string)
  • playableKindFilter: (string)
  • filteredByUserContent: required(boolean)

Example:

{
   "type" : "MyList",
   "kind" : "category-favourite-channels",
   "title" : {
      "en" : "My Favourite Channels"
   },
   "sorting" : "Newest",
   "images" : {
      "default" : "https://images.tvoli.com/nibble/ic_newrelease.png"
   },
   "visibility" : "AuthorizedOnly",
   "kindFilter" : "channel",
   "languageFilter" : "*",
   "playableKindFilter" : "*",
   "filteredByUserContent" : false
}

HTTP status code 201

Success

Headers

  • location: required(string)

    Example:

    /category/df8939c4-5254-4439-a0e9-c535c007d396

Body

Media type: application/json

Type: object

Properties
  • type: required(string)
  • id: (string)
  • kind: required(string)
  • title: required(object)
    • /^.+$/: required(string)
  • sorting: (string)
  • theme: (string)
  • images: (object)
    • /^.+$/: required(string)
  • description: (string)
  • visibility: required(string)
  • kindFilter: (string)
  • languageFilter: (string)
  • playableKindFilter: (string)
  • filteredByUserContent: required(boolean)

Example:

{
  "type": "MyList",
  "id": "df8939c4-5254-4439-a0e9-c535c007d396",
  "kind": "category-favourite-channels",
  "title": {
    "en": "My Favourite Channels"
  },
  "sorting": "Newest",
  "images": {
    "default": "https://images.tvoli.com/nibble/ic_newrelease.png"
  },
  "visibility": "AuthorizedOnly",
  "kindFilter": "channel",
  "languageFilter": "*",
  "playableKindFilter": "*",
  "filteredByUserContent": false
}

HTTP status code 400

PartnerId header is missing, or partner not found, or category data is invalid

HTTP status code 409

The given category id did already exist

Access Category by ID

get put delete

get
put
delete

URI Parameters

  • categoryId: required(string)

    Example:

    6b9d09d5-981c-4973-8f2b-b9878f587198

Headers

  • Magine-PartnerId: required(string)

    Example:

    testing

HTTP status code 200

Success

Body

Media type: application/json

Type: object

Properties
  • type: required(string)
  • id: (string)
  • kind: required(string)
  • title: required(object)
    • /^.+$/: required(string)
  • sorting: (string)
  • theme: (string)
  • images: (object)
    • /^.+$/: required(string)
  • description: (string)
  • visibility: required(string)
  • kindFilter: (string)
  • languageFilter: (string)
  • playableKindFilter: (string)
  • filteredByUserContent: required(boolean)

Examples:

root:

{
   "type" : "CategoryCollection",
   "id" : "root",
   "kind" : "category-0",
   "title" : {},
   "sorting" : "Popularity",
   "visibility" : "Always",
   "kindFilter" : "show,movie,program",
   "languageFilter" : "*",
   "playableKindFilter" : "*",
   "filteredByUserContent" : false,
   "kategoryIds" : [
      "b099e9af-2dae-436f-85b9-8606c31ee2d5",
      "ac3335f3-68d0-4f3e-b811-e1da3e1c86b5"
   ]
}

other:

{
   "type" : "MyList",
   "id" : "b099e9af-2dae-436f-85b9-8606c31ee2d5",
   "kind" : "category-favourite-channels",
   "title" : {
      "en" : "Favourite Channels"
   },
   "sorting" : "Newest",
   "images" : {
      "default" : "https://images.tvoli.com/nibble/ic_newrelease.png"
   },
   "visibility" : "AuthorizedOnly",
   "kindFilter" : "channel",
   "languageFilter" : "*",
   "playableKindFilter" : "*",
   "filteredByUserContent" : false
}

HTTP status code 400

PartnerId header is missing, or partner not found

HTTP status code 404

The category id could not be found

URI Parameters

  • categoryId: required(string)

    Example:

    6b9d09d5-981c-4973-8f2b-b9878f587198

Headers

  • Magine-PartnerId: required(string)

    Example:

    testing

Body

Media type: application/json

Type: object

Properties
  • type: required(string)
  • id: (string)
  • kind: required(string)
  • title: required(object)
    • /^.+$/: required(string)
  • sorting: (string)
  • theme: (string)
  • images: (object)
    • /^.+$/: required(string)
  • description: (string)
  • visibility: required(string)
  • kindFilter: (string)
  • languageFilter: (string)
  • playableKindFilter: (string)
  • filteredByUserContent: required(boolean)

HTTP status code 200

Success

Body

Media type: application/json

Type: object

Properties
  • type: required(string)
  • id: (string)
  • kind: required(string)
  • title: required(object)
    • /^.+$/: required(string)
  • sorting: (string)
  • theme: (string)
  • images: (object)
    • /^.+$/: required(string)
  • description: (string)
  • visibility: required(string)
  • kindFilter: (string)
  • languageFilter: (string)
  • playableKindFilter: (string)
  • filteredByUserContent: required(boolean)

HTTP status code 400

PartnerId header is missing, or partner not found, or category data is invalid

HTTP status code 404

The category id could not be found

URI Parameters

  • categoryId: required(string)

    Example:

    6b9d09d5-981c-4973-8f2b-b9878f587198

Headers

  • Magine-PartnerId: required(string)

    Example:

    testing

HTTP status code 204

Success

HTTP status code 400

PartnerId header is missing, or partner not found

HTTP status code 404

The category id could not be found