Versions Compared

Version Old Version 1 New Version Current
Changes made by

Ramya Raman (Unlicensed)

Ramya Raman (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET output_layouts/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns list of pre-defined layout types.

Resource URL

http://{host}/api/2.0/output_layouts/meta/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/output_layouts/meta/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "LayoutTextModes": {
        "1": "Scroll",
        "2": "Squeeze",
        "3": "Crop"
    }
}

 

 

GET output_layouts

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of layouts configuration.

Resource URL

http://{host}/api/2.0/output_layouts/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/output_layouts/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "Layout": {
            "id": 2,
            "title": "temp",
            "uuid": "611007D8-39CB-47EB-9400-4E0C33542C3D",
            "layout_type_id": 14,
            "layout_text_mode_id": 1,
            "background": null,
            "Encoders": [],
            "LayoutBoxes": [
                {
                    "id": 1,
                    "source_id": 57,
                    "content_type_id": 1,
                    "title": "Isr",
                    "primary_umd": null,
                    "secondary_umd": null,
                    "tally_settings": null,
                    "content": null,
                    "channel_activation_mode_id": 1
                }
            ],
            "modified": "1619937751320",
            "created": "1611142282208"
        }
    },
    {
        "Layout": {
            "id": 1,
            "title": "fs",
            "uuid": "7D799305-A173-4209-8FA2-947DEEC9F9A1",
            "layout_type_id": 12,
            "layout_text_mode_id": 1,
            "background": null,
            "Encoders": [],
            "LayoutBoxes": [],
            "modified": "1619937751314",
            "created": "1611142282208"
        }
    }
]

 

 

GET output_layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single layout configuration.

Resource URL

http://{host}/api/2.0/output_layouts/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Output Layout to be viewed.

Example Request

GET 

  1. http://192.168.0.203/api/2.0/output_layouts/1/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Layout": {
        "id": 5,
        "title": "temp",
        "uuid": "611007D8-39CB-47EB-9400-4E0C33542C3D",
        "layout_type_id": 14,
        "layout_text_mode_id": 1,
        "background": null,
        "Encoders": [],
        "LayoutBoxes": [
            {
                "id": 1,
                "source_id": 57,
                "content_type_id": 1,
                "title": "Isr",
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            },
            {
                "id": 1001,
                "source_id": 20,
                "content_type_id": 2,
                "title": "null",
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            }
        ],
        "modified": "1619937751320",
        "created": "1611142282208"
    }
}

 

 

POST output_layouts

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new blank layout.

Resource URL

http://{host}/api/2.0/output_layouts/.format

Example Request

POST 

  1. http://44.235.52.211/api/2.0/output_layouts/.json

Expand
title
Body
BODY
Code Block
languagejson
{
  "Layout": {
    "id": "",
    "layout_type_id": 5,
    "layout_text_mode_id": 2,
    "title": "NEW_Layout"
  }
}
Response
Expand
titleRESPONSE
Code Block
languagejson
{
    "Layout": {
        "id": 8,
        "title": "NEW_Layout",
        "uuid": "42CA6C3F-EAC3-4D0E-8E93-8080CD6077CA",
        "layout_type_id": 5,
        "layout_text_mode_id": 2,
        "background": null,
        "Encoders": [],
        "LayoutBoxes": [
            {
                "id": 1,
                "source_id": null,
                "content_type_id": 1,
                "title": null,
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            },
            {
                "id": 2,
                "source_id": null,
                "content_type_id": 1,
                "title": null,
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            },
            {
                "id": 3,
                "source_id": null,
                "content_type_id": 1,
                "title": null,
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            },
            {
                "id": 4,
                "source_id": null,
                "content_type_id": 1,
                "title": null,
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            }
        ],
        "modified": "1619942795799",
        "created": "1619942795797"
    }
}

 

 

PUT output_layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates a specific layout

Resource URL

http://{host}/api/2.0/output_layouts/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Output Layout to be updated.

Example Request

PUT 

  1. http://44.235.52.211/api/2.0/output_layouts/13/.json

Expand
title
Body
BODY
Code Block
languagejson
{
  "Layout": {
    "LayoutBoxes": [
      {
        "channel_source_id": 82,
        "id": 1
      },
      {
        "channel_source_id": "",
        "id": 8
      }
    ],
    "id": 5,
    "layout_type_id": 12,
    "title": "EDIT_Layout"
  }
}
Expand
title
Response
RESPONSE
Code Block
languagejson
{
    "Layout": {
        "id": 13,
        "title": "EDIT_Layout",
        "uuid": "613D0AE5-9A28-4E02-9EF6-EE63F4524B13",
        "layout_type_id": 12,
        "layout_text_mode_id": 2,
        "background": null,
        "Encoders": [],
        "LayoutBoxes": [
            {
                "id": 1,
                "source_id": null,
                "content_type_id": 1,
                "title": null,
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            }
        ],
        "modified": "1619943602030",
        "created": "1619943359799"
    }
}

 

 

POST output_layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Copies a specific layout data into a new layout.

Resource URL

http://{host}/api/2.0/output_layouts/{id}/.format

Parameters

Parameter

Data Type

Description

1
(required)

integer

The ID of the desired Output Layout to be copied.

Example Request

POST

  1. http://44.235.52.211/api/2.0/output_layouts/8/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Layout": {
        "id": 13,
        "title": "NEW_Layout_2",
        "uuid": "613D0AE5-9A28-4E02-9EF6-EE63F4524B13",
        "layout_type_id": 5,
        "layout_text_mode_id": 2,
        "background": null,
        "Encoders": [],
        "LayoutBoxes": [
            {
                "id": 1,
                "source_id": 59,
                "content_type_id": 1,
                "title": "new_GEvPd339fg",
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            },
            {
                "id": 2,
                "source_id": null,
                "content_type_id": 1,
                "title": null,
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            },
            {
                "id": 3,
                "source_id": 31,
                "content_type_id": 1,
                "title": "sample_channel",
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            },
            {
                "id": 4,
                "source_id": null,
                "content_type_id": 1,
                "title": null,
                "primary_umd": null,
                "secondary_umd": null,
                "tally_settings": null,
                "content": null,
                "channel_activation_mode_id": 1
            }
        ],
        "modified": "1619943359801",
        "created": "1619943359799"
    }
}

 

 

DELETE output_layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a specific layout.

Resource URL

http://{host}/api/2.0/output_layouts/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Output Layout to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/output_layouts/13/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "success": true
}