This API is used by access devices to notify to mygate the access status of the entity
Endpoint
Method: GET
Sample Request & Response Body
Request
curl --location --request POST 'https://gateway.mgthunderbolt.xyz/access/v1/notify' \
--header 'mg-xs-api-key: xxxx' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"device_id": "String",
"access_uuid_type": "Enum",
"access_entity_type": "Enum",
"access_ref_id": "String",
"access_uuid_captured": "String",
"direction": "Enum",
"status": "Enum",
"timestamp": "String"
}'
| Name | Value | Notes |
|---|
| mg-xs-api-key | VEHICLE | Access Entity Type Enum |
| Accept | application/json | |
| Content-Type | application/json | |
Request Attributes
| Name | Type | Notes |
|---|
| device_id | String | Identifier for the device placed at an access point |
| timestamp | String | Timestamp defines the records to be returned which have been added/deleted after a particular value |
| access_entity_type | Enum | VEHICLE (Refer enum table) |
| access_uuid_type | Enum | LPN,TAG etc (Refer enum table) |
| access_uuid_captured | String | Captured and matched identifier of the entity seeking access |
| access_ref_id | String | Original opaque reference id. |
| additonal_kvs | Object | Key value pairs to be used for passing additional contextual information. Optiona |
| status | Enum | IN, OUT (Refer enum table) |
| direction | Enum | ALLOW, DISALLOW (Refer enum table) |
Response
{
"es" : "String",
"message" : "String"
}
Response Attributes
| Name | Type | Notes |
|---|
| es | String | Error Status, 0 if success else failure |
| message | String | Message : Success if success else the failure reason |