flow-docs

VDP-ExAmino API

Introduction

This is the documentation of the VDP-ExAmino API endpoints (GET, PUT, DELETE) for a RESTful web service built using AWS Lambda. These endpoints allow to interact with the service to create, read, and delete.

API Base URL: https://api.statsperform.video/optavoice/vdp/event

Endpoints

1. PUT

https://api.statsperform.video/optavoice/vdp/event/{id}

Description:
Creates or updates an item in the DB with the specified id.

Path Parameters:

• {id}: Number, required
  • The unique identifier

Example Request Body:

{
	"id": 2046240,
	"start_datetime": `2023-04-24T08:00:00.000Z`,
	"end_datetime": `2023-04-24T09:30:00.000Z`,
	"description": "TEST: Examino friday 2",
	"primary_source_specifier": "srt://test_primary_source_ip",
	"secondary_source_specifier": "srt://test_primary_source_ip",
	"publications": [
		{
			"__union_type": "hls_publication",
			"video_selectors": [
				{
					"bitrate_identifier": 5001
				}
			],
			"audio_selectors": [
				{
					"__union_type": "standard_audio_selector",
					"bitrate_identifier": 5001,
					"pid": 258
				}
			],
			"hls_provider_details": {
				"__union_type": "akamai_hls",
				"primary_base_url": "http://primary_base_url_1/",
				"backup_base_url": "http://backup_base_url_1/"
			},
			"master_playlist_url": "https://akamai_endpoint_url_1.m3u8"
		},
		{
			"__union_type": "hls_publication",
			"video_selectors": [
				{
					"bitrate_identifier": 5001
				}
			],
			"audio_selectors": [
				{
					"__union_type": "standard_audio_selector",
					"bitrate_identifier": 5001,
					"pid": 259
				}
			],
			"hls_provider_details": {
				"__union_type": "akamai_hls",
				"primary_base_url": "http://primary_base_url_2/",
				"backup_base_url": "http://primary_base_url_2/"
			},
			"master_playlist_url": "https://akamai_endpoint_url_2.m3u8"
		}
	]
}

Response:

• statusCode : 201

Error responses:

• request with NaN in the pathParams
• statusCode : 400

{ "error": "Invalid id provided" }

• request without start_datetime
• statusCode : 400

{ "error": "start_datetime was not provided" }

• request without end_datetime
• statusCode : 400

{ "error": "end_datetime was not provided" }

• request without description
• statusCode : 400

{ "error": "description was not provided" }

• request without id
• statusCode : 400

{ "error": "id was not provided" }

• request with different id in the pathParams and in the body
• statusCode : 400

{ "error": "path param id and body id is not equal" }

• request without primary_source_specifier
• statusCode : 400

{ "error": "primary_source_specifier was not provided" }

• request without secondary_source_specifier)
• statusCode : 400

{ "error": "secondary_source_specifier) was not provided" }

• request without publications
• statusCode : 400

{ "error": "publications was not provided" }

• request with audio_selectors which is not an array
• statusCode : 400

{ "error": "audio_selectors is not an array" }

• request without pid in the audio_selectors
• statusCode : 400

{ "error": "audio_selectors pid missing" }

• request with pid which is not a number
• statusCode : 400

{ "error": "audio_selectors pid is not a number" }

• request without hls_provider_details
• statusCode : 400

{ "error": "hls_provider_details missing" }

• request without primary_base_url
• statusCode : 400

{ "error": "hls_provider_details.primary_base_url missing" }

• request without backup_base_url
• statusCode : 400

{ "error": "hls_provider_details.backup_base_url missing" }

• request without master_playlist_url
• statusCode : 400

{ "error": "master_playlist_url missing" }

• request with good data but fails to saving into db
• statusCode: 400

  {"error": "error occured when saving data to db"}
  

2. GET

By id

https://api.statsperform.video/optavoice/vdp/event/{id}

Description:
Fetches a specific item by its unique identifier (id) from the DB.

Path Parameters:

• id: Number, required
  • The unique identifier

Response:

• Item with the specified valid id.
• statusCode : 200

{
	"stop": 1682328600000,
	"audiomap": "{\"258\":\"https://akamai_endpoint_url_2.m3u8\",\"259\":\"https://akamai_endpoint_url_1.m3u8\"}",
	"input": "srt://test_primary_source_ip",
	"provider": "ov",
	"sport": "",
	"channel": "ov-2046240",
	"start": 1682323200000,
	"title": "TEST: Examino friday 2"
}

• Item with the specified invalid id.
• statusCode:404

{}

• Resource with id which is not a number
• statusCode: 400

{ "error": "Invalid id provided" }

Simple get

https://api.statsperform.video/optavoice/vdp/event

Description:
Fetches all OptaVoice items from the DynamoDB table.

Response:

[
	{
		"stop": 1682328600000,
		"audiomap": "{\"258\":\"https://akamai_endpoint_url_2.m3u8\",\"259\":\"https://akamai_endpoint_url_1.m3u8\"}",
		"input": "srt://test_primary_source_ip",
		"provider": "ov",
		"sport": "",
		"channel": "ov-2046240",
		"start": 1682323200000,
		"title": "TEST: Examino friday 2"
	}
]

3. DELETE

https://api.statsperform.video/optavoice/vdp/event/{id}

Description:
Deletes a specific item by its unique identifier (id) from the DB.

Path Parameters:

• resourceId: Number, required
  • The unique identifier

Response:

• Resource with the specified valid id.

• statusCode : 204

• Resource with id which is not a number
• statusCode: 400

{ "error": "Invalid id provided" }

• Resource with the specified invalid id.
• statusCode : 404

{ "message": "Item not found or already deleted" }