POST api/DeviceCommunication/SayHello
Request Information
URI Parameters
None.
Body Parameters
DeviceSayHelloRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DeviceUniqueId | string |
None. |
|
| Mac | string |
None. |
|
| AppVersion | string |
None. |
|
| UserCount | integer |
None. |
|
| TransactionCount | integer |
None. |
|
| DeviceTime | date |
None. |
|
| CommandCode | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"deviceUniqueId": "sample string 1",
"mac": "sample string 2",
"appVersion": "sample string 3",
"userCount": 4,
"transactionCount": 5,
"deviceTime": "2026-03-10T01:44:04.9896079+05:30",
"commandCode": 1
}
application/xml, text/xml
Sample:
<DeviceSayHelloRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BalDal.Request"> <AppVersion>sample string 3</AppVersion> <CommandCode>1</CommandCode> <DeviceTime>2026-03-10T01:44:04.9896079+05:30</DeviceTime> <DeviceUniqueId>sample string 1</DeviceUniqueId> <Mac>sample string 2</Mac> <TransactionCount>5</TransactionCount> <UserCount>4</UserCount> </DeviceSayHelloRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DeviceSayHelloResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode | string |
None. |
|
| ErrorDescription | string |
None. |
|
| DeviceUniqueId | string |
None. |
|
| DeviceMode | string |
None. |
|
| LocationCode | string |
None. |
|
| LocationId | string |
None. |
|
| LocationName | string |
None. |
|
| Command | integer |
None. |
|
| CommandCode | integer |
None. |
|
| AppVersion | string |
None. |
|
| Delay | string |
None. |
|
| SayHelloDelay | string |
None. |
|
| SerDateTime | date |
None. |
|
| IsActive | string |
None. |
|
| IsLivenessRequired | boolean |
None. |
|
| IsTemperatureMandatory | boolean |
None. |
|
| IsAllowHighTemperature | boolean |
None. |
|
| MinimumFaceSize | integer |
None. |
|
| IsRelayRequired | boolean |
None. |
|
| RelayTime | integer |
None. |
|
| IsFlashLightOn | boolean |
None. |
|
| Brightness | integer |
None. |
|
| TransactionGap | integer |
None. |
|
| IsThermalImageRequired | boolean |
None. |
|
| IsIrImageRequired | boolean |
None. |
|
| isPunchPhotoCapture | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"errorCode": "sample string 1",
"errorDescription": "sample string 2",
"deviceUniqueId": "sample string 3",
"deviceMode": "sample string 4",
"locationCode": "sample string 5",
"locationId": "sample string 6",
"locationName": "sample string 7",
"command": 8,
"commandCode": 9,
"appVersion": "sample string 10",
"delay": "sample string 11",
"sayHelloDelay": "sample string 12",
"serDateTime": "2026-03-10T01:44:04.9896079+05:30",
"isActive": "sample string 14",
"isLivenessRequired": true,
"isTemperatureMandatory": true,
"isAllowHighTemperature": true,
"minimumFaceSize": 18,
"isRelayRequired": true,
"relayTime": 20,
"isFlashLightOn": true,
"brightness": 22,
"transactionGap": 23,
"isThermalImageRequired": true,
"isIrImageRequired": true,
"isPunchPhotoCapture": "sample string 26"
}
application/xml, text/xml
Sample:
<DeviceSayHelloResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BalDal.Response"> <AppVersion>sample string 10</AppVersion> <Brightness>22</Brightness> <Command>8</Command> <CommandCode>9</CommandCode> <Delay>sample string 11</Delay> <DeviceMode>sample string 4</DeviceMode> <DeviceUniqueId>sample string 3</DeviceUniqueId> <ErrorCode>sample string 1</ErrorCode> <ErrorDescription>sample string 2</ErrorDescription> <IsActive>sample string 14</IsActive> <IsAllowHighTemperature>true</IsAllowHighTemperature> <IsFlashLightOn>true</IsFlashLightOn> <IsIrImageRequired>true</IsIrImageRequired> <IsLivenessRequired>true</IsLivenessRequired> <IsRelayRequired>true</IsRelayRequired> <IsTemperatureMandatory>true</IsTemperatureMandatory> <IsThermalImageRequired>true</IsThermalImageRequired> <LocationCode>sample string 5</LocationCode> <LocationId>sample string 6</LocationId> <LocationName>sample string 7</LocationName> <MinimumFaceSize>18</MinimumFaceSize> <RelayTime>20</RelayTime> <SayHelloDelay>sample string 12</SayHelloDelay> <SerDateTime>2026-03-10T01:44:04.9896079+05:30</SerDateTime> <TransactionGap>23</TransactionGap> <isPunchPhotoCapture>sample string 26</isPunchPhotoCapture> </DeviceSayHelloResponse>