Skip to content

Counters

Counters are visitor counting devices.

Operations

Upload list of counters

Request

POST https://api.zoined.com/counters?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
counter_idstringrequired

Counter ID

Example:"5"
counter_namestringrequired

Counter name

Example:"Front door 1"
folder_id: front_door_1string

Name of identification folder

serialstring

Camera serial number

Example:"ABCDE12345"
registration_codestring

Camera registration code

Example:"A1B2C3D4E5"
disabledbooleanrequired

True if the counter is disabled (i.e. is set to not send data)

Example:false
is_queueboolean

True if the counter is a queue counter

Example:false
on_store_perimeterboolean

True, if this a store perimeter camera

Example:true
organisation_id: my_organisation_idstring

Id of the store/organisation where the camera is located

department_id: my_department_idstring

Id of the department where the camera is located

department_reversed_idstring

Secondary department id where in and out counts are reversed.

Example:"reverse_id"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/counters?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "counter_id": "5",
    "counter_name": "Front door 1",
    "folder_id: front_door_1": "string",
    "serial": "ABCDE12345",
    "registration_code": "A1B2C3D4E5",
    "disabled": false,
    "is_queue": false,
    "on_store_perimeter": true,
    "organisation_id: my_organisation_id": "string",
    "department_id: my_department_id": "string",
    "department_reversed_id": "reverse_id",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}