Channel

A Channel is the name of a multicast group that a user or a group of users can be subscribed in order to get specific notifications of that group.

Routes

• /channel
• /channel/:id
• /channels
• /channel_name

/channel

📘

Creates a new channel or retrives the channel if it was created before.

Params	Type	Required?	Description
name	string	true	Name of the channel.

Response

JSON

{
    "result": {
        "name": "new_releases",
        "id": 1
    }
}

Back to Index

/channel/:id

📘

Gets the given channel information.

No params expected.

Response

JSON

{
    "result": {
        "id": 1,
        "name": "new_releases"
    }
}

Back to Index

/channel/:id

📘

Updates the channel :id information with the given one.

Params	Type	Required?	Description
name	string	true	Name of the channel.

Response

👍

Updating name from new_releases to releases

JSON

{
    "result": {
        "id": 1,
        "name": "releases"
    }
}

Back to Index

/channel/:id

📘

Deletes the given channel

Response

JSON

{
    "result": true
}

Back to Index

/channels

📘

Retrives all the channels registered.

No params expected.

Response

JSON

{
    "result": [
        {
            "id": 1,
            "name": "new_releases"
        },
        {
            "id": 2,
            "name": "system_updates"
        }
    ]
}

Back to Index

/channel_name

📘

Gets the given channel information by name.

Params	Type	Required?	Description
name	string	true	Name of the channel.

Response

JSON

{
    "result": {
        "id": 1,
        "name": "new_releases"
    }
}

Back to Index