Field

Retrieves the collection of Field resources.

Retrieves the collection of Field resources.

get/fields

Request

  • Base URL: https://api.spash.com
  • URL: https://api.spash.com/fields
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

paginationboolean

Enable or disable pagination

namestring
statusstring
status[]string[]
idinteger
id[]integer[]
referenceinteger
reference[]integer[]
sport.idinteger
sport.id[]integer[]
sportCenter.idinteger
sportCenter.id[]integer[]
createdAt[before]string
createdAt[strictly_before]string
createdAt[after]string
createdAt[strictly_after]string
updatedAt[before]string
updatedAt[strictly_before]string
updatedAt[after]string
updatedAt[strictly_after]string
order[createdAt]'asc' | 'desc'
order[updatedAt]'asc' | 'desc'

Response

Field collection

idinteger
namestring
status'active' | 'inactive'
ngtvOffer'none' | 'ec1' | 'hi5' | 'five' | 'padel-stats' | 'community' nullable
bookingProviderIdinteger nullable
competitionAvailableboolean
scoreCounterAvailableboolean
customerAvailableboolean
planningAvailableboolean
autoRecordingEnableboolean
videosAnglesToExportstring[]

Detail of which videos angles we want to export for example [0, 1] means we export video0 and video1.

scaleExportToSDboolean
videoAdvertMessagestring nullable
logoPositionConfigurationstring[] nullable
easyConnectAvailableboolean
processEventsEnabledboolean
matchSheetboolean
eventDurationinteger
postmatchSponsorURLstring nullable
eventTypesExcludedstring[] nullable
videoResolutionsstring[]
videoOverlayEnabledboolean
videoScoreBarboolean
videoEventBarboolean
sportsCoConfigurationstring[] nullable
subscribedOptionsstring[] nullable
advertHmiScreenSaverVideoUrlstring nullable

Url of the advert HMI screen saver video. To remove, set it to null.

advertHmiScreenSaverImageUrlstring nullable

Url of the advert HMI screen saver image. To remove, set it to null.

advertHmiLoadingImageUrlstring nullable

Url of the advert HMI loader image. To remove, set it to null.

advertHmiSessionImageUrlstring nullable

Url of the advert HMI session image. To remove, set it to null.

advertHmiOrderImageUrlstring nullable

Url of the advert HMI order image. To remove, set it to null.

advertHmiPostMatchImageUrlstring nullable

Url of the advert HMI postmatch image. To remove, set it to null.

theme'default' | 'le_five' | '4_padel' | 'powerleague'

Theme of the Pedro's interfaces.

exportOverlayVideoEnabledboolean
aiConfigCamerasPositionstring[] nullable

Defines how the cameras are disposed on the field

recordingMaxWaitingDelayinteger

Defines the maximum time Pedro waits to get the video stream. After this duration the camera is considered unreachable.

scanToLaunchRequiredboolean
extraVideoRecordingDurationinteger

Defines the extra duration that we add to the video recording duration.

createdAtstring date-time
updatedAtstring date-time
referenceinteger
overlaysstring[]
videoScoreSidestring
fiveIdinteger nullable

Example response

[
  {
    "status": "active",
    "scoreCounterAvailable": true,
    "videosAnglesToExport": [
      0
    ],
    "scaleExportToSD": true,
    "easyConnectAvailable": true,
    "processEventsEnabled": true,
    "eventDuration": 30,
    "eventTypesExcluded": [
      "game",
      "new_set"
    ],
    "videoResolutions": [
      720
    ],
    "videoOverlayEnabled": true,
    "subscribedOptions": [
      "live",
      "live_premium",
      "social_panel",
      "instant_replay",
      "competition",
      "sponsor",
      "snack_order"
    ],
    "theme": "default",
    "sportCenter": {
      "coordinates": [
        0,
        0
      ],
      "visible": true,
      "timeZone": "Europe/Paris",
      "durationChoices": [
        3600,
        5400,
        7200
      ],
      "language": "en",
      "distanceUnite": "km",
      "country": {
        "currency": "EUR"
      },
      "tags": [
        {
          "createdAt": "CURRENT_TIMESTAMP",
          "updatedAt": "CURRENT_TIMESTAMP"
        }
      ],
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "buzzers": [
      {
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      }
    ],
    "cameras": [
      {
        "firstLogoPosition": "top_left",
        "secondLogoPosition": "bottom_right",
        "scorePosition": "top_right",
        "videoCameraOverlayPosition": "bottom_left",
        "type": "regular",
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": "CURRENT_TIMESTAMP"
      }
    ],
    "firstLogo": {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "secondLogo": {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "videoCameraOverlay": {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "videoCameraOverlayLogoTop": {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "videoCameraOverlayLogoSide": {
      "createdAt": "CURRENT_TIMESTAMP",
      "updatedAt": "CURRENT_TIMESTAMP"
    },
    "aiConfigCamerasPosition": [
      "0",
      "2"
    ],
    "recordingMaxWaitingDelay": 15,
    "extraVideoRecordingDuration": 1800,
    "createdAt": "CURRENT_TIMESTAMP",
    "updatedAt": "CURRENT_TIMESTAMP"
  }
]

Changes

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