NgtvSession

Stop a playing Ngtv session.

Send a message to Pedro to stop a playing session.

post/ngtv_sessions/{id}/stop

Request

  • Base URL: https://api.spash.com
  • URL: https://api.spash.com/ngtv_sessions/{id}/stop
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

idstring required

NgtvSession identifier

Request body

namestring nullable
plannedStartedAtstring date-time nullable
plannedEndedAtstring date-time nullable
actualStartedAtstring date-time nullable
actualEndedAtstring date-time nullable
videoSourcesstring[] nullable

Before remove, check: [x] all Pedro's has stopped using export through FTP [ ] all client are consuming the new field (when spash app will be released).

hasVideoVisibleboolean
competitionStagestring nullable
competitionRoundIdinteger nullable
competitionPositionIdinteger nullable
eventsstring[]
competitionBreakDurationinteger nullable
zonesActivityPercentagesstring[] nullable
status'not_played' | 'playing' | 'played' | 'deleted' | 'deleting_error' | 'processing' | 'processing_error' | 'processed' | 'exporting' | 'exporting_error' | 'exported' | 'exported_deleted' | 'error' | 'fake' | 'fake_deleted' | 'not_analyzed_deleted' | 'manually_deleted'
iaStatusstring nullable

Used by IA, status of the session in their workflow.

calculationServerReferencestring nullable

Used by IA, local name of calculation server.

videoRecordedWithOverlaysboolean
createdLocallyboolean

Does the ngtvSession was created on local Pedro?

calculationDatestring date-time nullable

Used by IA, dateTime of the last calculation.

withStatsboolean
scope'public' | 'private_team'
liveStreamKeysIndexesstring[] nullable

Allow to stream a single session to multiple streaming channel

liveStreamingboolean
liveCameraIndexinteger

Choose the camera angle to use for the live.

remotelyRefereedboolean
bookingProvider'le_five_4padel' | 'powerleague' | 'null' nullable

Booking provider used to register this ngtvSession.

bookingProviderIdinteger nullable

Id used by the booking provider to identify the ngtvSession.

bookingProviderDatastring[]

Data used by booking provider to identify the session, or for saving extra information.

processingStartedAtstring date-time nullable
processingEndedAtstring date-time nullable
exportingStartedAtstring date-time nullable
exportingEndedAtstring date-time nullable
videoDeletedboolean
videoDurationsobject
spashStickerScannedboolean

Has the session been launched via Spash sticker scanning?

fieldstring iri-reference nullable required
ngtvSessionTypestring iri-reference nullable required
competitionstring iri-reference nullable

Example request

{
  "status": "not_played",
  "createdLocally": true,
  "scope": "public",
  "liveStreamKeysIndexes": [
    0
  ],
  "videoDurations": {
    "video_0_406": 1234,
    "video_1_406": 1234
  },
  "field": "/fields/1",
  "ngtvSessionType": "/ngtv_session_types/1",
  "competition": "https://example.com/"
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.