GCXONEDocumentation

Événement

Sur cette page
  1. POST /event
  2. Corps de la requête
  3. Réponses
  4. POST /event/eventIngest
  5. Corps de la requête
  6. Réponses
  7. GET /event/{id}/streamingEndpoints
  8. Paramètres
  9. Réponses
  10. GET /event/{id}/true
  11. Paramètres
  12. Réponses

Opérations sur les ressources d'événement. 4 points de terminaison, chacun relatif à https://api.nxgen.cloud/api/v1 et authentifié comme décrit sous Authentification.

POST /event

Obtenir les points de terminaison de diffusion

Corps de la requête

Push d'événement

json
[
  {
    "cameraNumber": "number (required)",
    "dateTime": "string",
    "serverTimeStamp": "string",
    "sourceDeviceUniqueIdentifier": "string (required)",
    "eventCode": "string (required)",
    "alarmState": "boolean",
    "mediaContents": {
      "imageDetails": [
        {
          "imageBuffer": ""
        }
      ]
    }
  }
]

Réponses

Statut

Description

Corps

200

Succès

204

Pas de contenu

401

Non autorisé

403

Interdit

404

Pas trouvé

POST /event/eventIngest

Obtenir les points de terminaison de diffusion

Corps de la requête

Push d'événement

json
[
  {
    "cameraNumber": "number (required)",
    "dateTime": "string",
    "serverTimeStamp": "string",
    "sourceDeviceUniqueIdentifier": "string (required)",
    "eventCode": "string (required)",
    "alarmState": "boolean",
    "mediaContents": {
      "imageDetails": [
        {
          "imageBuffer": ""
        }
      ]
    }
  }
]

Réponses

Statut

Description

Corps

200

Succès

204

Pas de contenu

401

Non autorisé

403

Interdit

404

Non trouvé

GET /event/{id}/streamingEndpoints

Obtenir les points de diffusion

Paramètres

Nom

Dans

Type

Obligatoire

Description

id

chemin

chaîne

oui

Identifiant d'événement

preStart

requête

nombre

non

En millisecondes

postEnd

requête

nombre

non

En millisecondes

Expiration

Requête

Nombre

Non

En secondes

Réponses

Statut

Description

Corps

200

Succès

204

Pas de contenu

401

Non autorisé

403

Interdit

404

Pas trouvé

GET /event/{id}/true

obtenir l'événement

Paramètres

Nom

Dans

Type

Obligatoire

Description

id

chemin

chaîne

oui

Réponses

Statut

Description

Corps

200

Succès

204

Pas de contenu

401

Non autorisé

403

Interdit

404

Non trouvé

Cette page vous a-t-elle été utile ?

Merci — votre retour est transmis à l’équipe responsable de cette page.