Adways APIs documentation

PlayerClass

A "PlayerClass" entity is an Adways Studio supported video player. It maintains the association between the players and the mime types files those players work with.

Fields

Field	Description	Required
tooltip	A quick Player Class's description. Generally displayed on "mouse over".	YES
kiwi_plugin_url	The Player Class's content URL.	YES
refresh_delay	The minimum delay in millisecond between 2 requests to the Player Class's content (iframe) URL.	YES
mimes	Array of mimes types the Player Class can read. Mimes can be custom.	YES
js_constant		YES
priority		NO
delegate_url		NO
delegate_classname		NO
delegate_builder_url		NO
delegate_builder_classname		NO
player_builder_url		NO
player_builder_classname		NO

GET /player-class

Loads a collection of available entities. The loaded collection is paginated. An optional "search" parameter is available to filter the result on the entities' name and id (ex.: "//player-class?search=SearchValue").

Request

EndPoint

https://services.adways.com/player-class

Headers

Header	Value
Accept	application/vnd.player-class.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.player-class.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "_links": {
        "self": {
            "href": "/player-class"
        },
        "first": {
            "href": "/player-class?page={page}"
        },
        "prev": {
            "href": "/player-class?page={page}"
        },
        "next": {
            "href": "/player-class?page={page}"
        },
        "last": {
            "href": "/player-class?page={page}"
        }
    },
    "_embedded": {
        "collection": [
            {
                "id": "",
                "created": "",
                "author": "",
                "updated": "",
                "updator": "",
                "level": "",
                "state": "",
                "tooltip": "A quick Player Class's description. Generally displayed on "mouse over".",
                "kiwi_plugin_url": "The Player Class's content URL.",
                "refresh_delay": "The minimum delay in millisecond between 2 requests to the Player Class's content (iframe) URL.",
                "mimes": "Array of mimes types the Player Class can read. Mimes can be custom.",
                "js_constant": "",
                "priority": "",
                "delegate_url": "",
                "delegate_classname": "",
                "delegate_builder_url": "",
                "delegate_builder_classname": "",
                "player_builder_url": "",
                "player_builder_classname": "",
                "_links": {
                    "self": {
                        "href": "/player-class[/:player_class_id]"
                    }
                }
            }
        ]
    }
}

POST /player-class

Creates an entity in PlayerClass. Required fields are in the API fields description above. Note that on success, the returned http status is "201, Created".

Request

EndPoint

https://services.adways.com/player-class

Headers

Header	Value
Accept	application/vnd.player-class.v1+json application/hal+json application/json
Content-Type	application/vnd.player-class.v1+json application/json

Body

{
   "tooltip": "Description of your Player Class on mouse over.",
   "url": "URL of Javascript file to use as a Player Class.",
   "refresh_delay": "Update interval which will be sent to the Player Class. This is a time in milliseconds.",
   "mimes": "Array of mimes types the Player Class can read. Mimes can be custom."
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.player-class.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "tooltip": "A quick Player Class's description. Generally displayed on "mouse over".",
    "kiwi_plugin_url": "The Player Class's content URL.",
    "refresh_delay": "The minimum delay in millisecond between 2 requests to the Player Class's content (iframe) URL.",
    "mimes": "Array of mimes types the Player Class can read. Mimes can be custom.",
    "js_constant": "",
    "priority": "",
    "delegate_url": "",
    "delegate_classname": "",
    "delegate_builder_url": "",
    "delegate_builder_classname": "",
    "player_builder_url": "",
    "player_builder_classname": "",
    "_links": {
        "self": {
            "href": "/player-class[/:player_class_id]"
        }
    }
}

GET /player-class[/:player_class_id]

Loads the entity with the given id.

Request

EndPoint

https://services.adways.com/player-class[/:player_class_id]

Headers

Header	Value
Accept	application/vnd.player-class.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.player-class.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "tooltip": "A quick Player Class's description. Generally displayed on "mouse over".",
    "kiwi_plugin_url": "The Player Class's content URL.",
    "refresh_delay": "The minimum delay in millisecond between 2 requests to the Player Class's content (iframe) URL.",
    "mimes": "Array of mimes types the Player Class can read. Mimes can be custom.",
    "js_constant": "",
    "priority": "",
    "delegate_url": "",
    "delegate_classname": "",
    "delegate_builder_url": "",
    "delegate_builder_classname": "",
    "player_builder_url": "",
    "player_builder_classname": "",
    "_links": {
        "self": {
            "href": "/player-class[/:player_class_id]"
        }
    }
}

PATCH /player-class[/:player_class_id]

Updates a subset of the entity with the given id (only the modified fields are required).

Request

EndPoint

https://services.adways.com/player-class[/:player_class_id]

Headers

Header	Value
Accept	application/vnd.player-class.v1+json application/hal+json application/json
Content-Type	application/vnd.player-class.v1+json application/json

Body

{
   "tooltip": "Description of your Player Class on mouse over.",
   "url": "URL of Javascript file to use as a Player Class.",
   "refresh_delay": "Update interval which will be sent to the Player Class. This is a time in milliseconds.",
   "mimes": "Array of mimes types the Player Class can read. Mimes can be custom."
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.player-class.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "tooltip": "A quick Player Class's description. Generally displayed on "mouse over".",
    "kiwi_plugin_url": "The Player Class's content URL.",
    "refresh_delay": "The minimum delay in millisecond between 2 requests to the Player Class's content (iframe) URL.",
    "mimes": "Array of mimes types the Player Class can read. Mimes can be custom.",
    "js_constant": "",
    "priority": "",
    "delegate_url": "",
    "delegate_classname": "",
    "delegate_builder_url": "",
    "delegate_builder_classname": "",
    "player_builder_url": "",
    "player_builder_classname": "",
    "_links": {
        "self": {
            "href": "/player-class[/:player_class_id]"
        }
    }
}

PUT /player-class[/:player_class_id]

Updates the entire entity with the given id (all the fields are required).

Request

EndPoint

https://services.adways.com/player-class[/:player_class_id]

Headers

Header	Value
Accept	application/vnd.player-class.v1+json application/hal+json application/json
Content-Type	application/vnd.player-class.v1+json application/json

Body

{
   "tooltip": "Description of your Player Class on mouse over.",
   "url": "URL of Javascript file to use as a Player Class.",
   "refresh_delay": "Update interval which will be sent to the Player Class. This is a time in milliseconds.",
   "mimes": "Array of mimes types the Player Class can read. Mimes can be custom."
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.player-class.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": "",
    "created": "",
    "author": "",
    "updated": "",
    "updator": "",
    "level": "",
    "state": "",
    "tooltip": "A quick Player Class's description. Generally displayed on "mouse over".",
    "kiwi_plugin_url": "The Player Class's content URL.",
    "refresh_delay": "The minimum delay in millisecond between 2 requests to the Player Class's content (iframe) URL.",
    "mimes": "Array of mimes types the Player Class can read. Mimes can be custom.",
    "js_constant": "",
    "priority": "",
    "delegate_url": "",
    "delegate_classname": "",
    "delegate_builder_url": "",
    "delegate_builder_classname": "",
    "player_builder_url": "",
    "player_builder_classname": "",
    "_links": {
        "self": {
            "href": "/player-class[/:player_class_id]"
        }
    }
}

DELETE /player-class[/:player_class_id]

Deletes the entity with the given id. Note that on success, the returned http status is "204, Entity has been deleted".

Request

EndPoint

https://services.adways.com/player-class[/:player_class_id]

Headers

Header	Value
Accept	application/vnd.player-class.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.player-class.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Home / Documentation

PlayerClass (v1)

PlayerClass

Fields

GET /player-class

Request

EndPoint

Headers

Response

Status Codes

Headers

Body

POST /player-class

Request

EndPoint

Headers

Body

Response

Status Codes

Headers

Body

GET /player-class[/:player_class_id]

Request

EndPoint

Headers

Response

Status Codes

Headers

Body

PATCH /player-class[/:player_class_id]

Request

EndPoint

Headers

Body

Response

Status Codes

Headers

Body

PUT /player-class[/:player_class_id]

Request

EndPoint

Headers

Body

Response

Status Codes

Headers

Body

DELETE /player-class[/:player_class_id]

Request

EndPoint

Headers

Response

Status Codes

Headers