HTTP status code 200
Returned when this Sender supports Parameter Constraint URNs used and all of Parameter Constraint values in all of Constraint Sets.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"description": "Describes Constraints",
"title": "Constraints",
"type": "object",
"required": [
"constraint_sets"
],
"properties": {
"constraint_sets": {
"type": "array",
"items": {
"$ref": "constraint_set.json"
}
}
}
}
Example:
{
"constraint_sets": [
{
"urn:x-nmos:cap:meta:label": "1080i Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "interlaced_tff" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 25, "denominator": 1 },
{ "numerator": 30000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
},
{
"urn:x-nmos:cap:meta:label": "1080p Format Group as per VSF TR-05:2018",
"urn:x-nmos:cap:format:frame_width": {
"enum": [ 1920 ]
},
"urn:x-nmos:cap:format:frame_height": {
"enum": [ 1080 ]
},
"urn:x-nmos:cap:format:interlace_mode": {
"enum": [ "progressive" ]
},
"urn:x-nmos:cap:format:grain_rate": {
"enum": [
{ "numerator": 24000, "denominator": 1001 },
{ "numerator": 50, "denominator": 1 },
{ "numerator": 60000, "denominator": 1001 }
]
},
"urn:x-nmos:cap:format:color_sampling": {
"enum": [ "YCbCr-4:2:2" ]
},
"urn:x-nmos:cap:format:component_depth": {
"enum": [ 10 ]
},
"urn:x-nmos:cap:format:transfer_characteristic": {
"enum": [ "SDR" ]
},
"urn:x-nmos:cap:format:colorspace": {
"enum": [ "BT709" ]
}
}
]
}
HTTP status code 400
Returned when the Constraints are rejected due to schema validation failure or if the Sender doesn't support a Parameter Constraint URN used in any of the Constraint Sets.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Describes the standard error response which is returned with HTTP codes 400 and above",
"title": "Error response",
"required": [
"code",
"error",
"debug"
],
"properties": {
"code": {
"description": "HTTP error code",
"type": "integer",
"minimum": 400,
"maximum": 599
},
"error": {
"description": "Human readable message which is suitable for user interface display, and helpful to the user",
"type": "string"
},
"debug": {
"description": "Debug information which may assist a programmer working with the API",
"type": ["null", "string"]
}
}
}
HTTP status code 404
Returned when the requested Sender ID does not exist.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Describes the standard error response which is returned with HTTP codes 400 and above",
"title": "Error response",
"required": [
"code",
"error",
"debug"
],
"properties": {
"code": {
"description": "HTTP error code",
"type": "integer",
"minimum": 400,
"maximum": 599
},
"error": {
"description": "Human readable message which is suitable for user interface display, and helpful to the user",
"type": "string"
},
"debug": {
"description": "Debug information which may assist a programmer working with the API",
"type": ["null", "string"]
}
}
}
HTTP status code 422
Returned when the Sender isn't capable to adhere to the proposed Constraints although the request is valid and the Sender supports all the Parameter Constraint URNs used.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Describes the standard error response which is returned with HTTP codes 400 and above",
"title": "Error response",
"required": [
"code",
"error",
"debug"
],
"properties": {
"code": {
"description": "HTTP error code",
"type": "integer",
"minimum": 400,
"maximum": 599
},
"error": {
"description": "Human readable message which is suitable for user interface display, and helpful to the user",
"type": "string"
},
"debug": {
"description": "Debug information which may assist a programmer working with the API",
"type": ["null", "string"]
}
}
}
HTTP status code 423
Returned when the Constraints can't be applied temporarily due to Device restrictions (e.g. if the Sender is active).
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Describes the standard error response which is returned with HTTP codes 400 and above",
"title": "Error response",
"required": [
"code",
"error",
"debug"
],
"properties": {
"code": {
"description": "HTTP error code",
"type": "integer",
"minimum": 400,
"maximum": 599
},
"error": {
"description": "Human readable message which is suitable for user interface display, and helpful to the user",
"type": "string"
},
"debug": {
"description": "Debug information which may assist a programmer working with the API",
"type": ["null", "string"]
}
}
}
HTTP status code 500
Returned if the Constraints can't be applied due to a reason not listed above.
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"description": "Describes the standard error response which is returned with HTTP codes 400 and above",
"title": "Error response",
"required": [
"code",
"error",
"debug"
],
"properties": {
"code": {
"description": "HTTP error code",
"type": "integer",
"minimum": 400,
"maximum": 599
},
"error": {
"description": "Human readable message which is suitable for user interface display, and helpful to the user",
"type": "string"
},
"debug": {
"description": "Debug information which may assist a programmer working with the API",
"type": ["null", "string"]
}
}
}