GCXONEDocumentatie

Event

Op deze pagina
  1. POST /event
  2. Verzoekbody
  3. Responsen
  4. POST /event/eventIngest
  5. Verzoekbody
  6. Responsen
  7. GET /event/{id}/streamingEndpoints
  8. Parameters
  9. Responsen
  10. GET /event/{id}/true
  11. Parameters
  12. Responsen

Operaties op event‑resources. 4 eindpunten, elk relatief ten opzichte van https://api.nxgen.cloud/api/v1 en geauthenticeerd zoals beschreven onder Authenticatie.

POST /event

Streaming‑eindpunten ophalen

Verzoekbody

Event Push

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

Responsen

Status

Beschrijving

Inhoud

200

Succes

204

Geen inhoud

401

Niet toegestaan

403

Verboden

404

Niet gevonden

POST /event/eventIngest

Streaming‑eindpunten ophalen

Verzoekbody

Event Push

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

Responsen

Status

Beschrijving

Inhoud

200

Succes

204

Geen inhoud

401

Niet toegestaan

403

Verboden

404

Niet gevonden

GET /event/{id}/streamingEndpoints

Streaming‑eindpunten ophalen

Parameters

Naam

In

Type

Verplicht

Beschrijving

id

pad

tekenreeks

ja

Event‑id

preStart

query

nummer

nee

In milliseconden

postEnd

query

nummer

nee

In milliseconden

vervaldatum

query

nummer

nee

In seconden

Responsen

Status

Beschrijving

Body

200

Succes

204

Geen inhoud

401

Niet toegestaan

403

Verboden

404

Niet gevonden

GET /event/{id}/true

haal gebeurtenis op

Parameters

Naam

In

Type

Verplicht

Beschrijving

id

path

string

ja

Responsen

Status

Beschrijving

Body

200

Succes

204

Geen inhoud

401

Niet geautoriseerd

403

Verboden

404

Niet gevonden

Was deze pagina nuttig?

Bedankt — uw feedback gaat naar het team dat deze pagina beheert.