Ronda senior X - User Manual> Integrations> Integrations with other systems> Integrate events

Events integration using the API

Documentation on how to integrate events using the Ronda senior X API.

General prerequisites

Be authenticated in Ronda senior X;
Pass the token in the Header.

Consult discarded events

Call the serviceGET /rejectedEvent/pagedsearch/all to consult events by period;
In the postman, the following items must be passed in the URL (query) as parameters: order (1 = ascending, 0 = descending), type (0 = access, 1= alarm, 2= notification), dataInicio (start date), dataFim (end date), pagina (page), totalPaginas (total number of pages): https://sam-api.senior.com.br/api/v1/rejectedEvent/pagedsearch/all?order=0&type=0&startDate=2017-03-27T00:00:00-03:00&endDate=2017-03-27T21:55:00-03:00&page=1&pageSize=10

Consult access events and alarm events

Call the servicePOST /monitoring/access/pagesearch/all to consult access events;
Filters can be performed by start and end date, type of access, physical location, devices, groups, people and roles, according to the types below:

Service information

GET /rejectedEvent/pagedsearch/all

Implementation Notes

Returns all rejected events

Response Class (Status 200)

Return a rejected event

{
"datetime": "string",
"eventType": 0,
"rejectReason": "string",
"device":
{
"id": 0,
"name": "string",
"deviceType": 0
},
"credential": 0,
"cardNumber": 0,
"personId": 0,
"biometricManufacturer": 0,
"credentialFormat": "CARD"
}

Parameters

Parameter	Description	Parameter Type	Data Type
X-JWT-Assertion	WSO2 JWT token	header	string
X-Authenticated-Userid	The logged-in user ID	header	string
order	Order filter (1 for ascending order, 0 for descending order)	query	integer
type	Rejected event type filter (0 = ACCESS, 1 = ALARM , 2 = NOTIFICATION)	query	string
startDate	Start date	query	string
endDate	End date	query	string
page	Page number	query	integer
pageSize	Size of the page	query	integer

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
500	Server error	{ "id": "string", "code": 0, "message": "string" }

POST /monitoring/access/pagesearch/all

Implementation Notes

Return an array of all monitored access filtered

Response Class (Status 200)

Return a list of all monitored access

{
"date": "string",
"credential": 0,
"person": {
"id": 0,
"name": "string",
"mandatoryDocuments": [
{
"id": 0,
"documentType": {
"id": 0,
"name": "string",
"label": "string",
"mask": "string",
"required": true,
"documentToREP": true
},
"document": "string"
}
],
"preferentialEmail": {
"id": 0,
"preferential": true,
"emailAddress": "string"
},
"preferentialPhone": {
"id": 0,
"preferential": true,
"ddi": 0,
"phoneNumber": "string",
"extensionLine": "string",
"type": "UNDEFINED"
},
"lastFeedbackPollDate": "string",
"useSelfServiceTerminal": true
},
"accessType": "string",
"physicalLocationDestiny": {
"id": 0,
"name": "string"
},
"device": {
"id": 0,
"name": "string",
"deviceType": 0,
"readerTechnology": 0
},
"devicePhysicalLocation": {
"id": 0,
"name": "string"
},
"biometricManufacturer": 0,
"credentialFormat": "CARD",
"status": "OFFLINE",
"accessDirection": "ENTRANCE"
}

Parameters

Parameter	Description	Parameter Type	Data Type
X-JWT-Assertion	WSO2 JWT token	header	string
X-Authenticated-Userid	The logged-in user ID	header	string
MonitoringSearch	MonitoringSearch	body	MonitoringSearch { "startDate": "string", "endDate": "string", "typeAccess": 0, "order": 0, "page": 0, "pageSize": 0, "physicalLocation": [ 0 ], "devices": [ 0 ], "groups": [ 0 ], "persons": [ 0 ], "roles": [ 0 ] }

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
500	Server error	{ "id": "string", "code": 0, "message": "string" }