POST api/badgereaderapi/add?siteId={siteId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

globally unique identifier

None.

Body Parameters

BadgeReaderViewModel
NameDescriptionTypeAdditional information
id

globally unique identifier

None.

name

string

String length: inclusive between 0 and 100

pc_id

globally unique identifier

None.

com_port

integer

None.

baudrate

integer

None.

direction

string

Required

String length: inclusive between 0 and 3

has_correspondence

boolean

Required

active

boolean

Required

badge_reader_type_id

globally unique identifier

None.

site_id

globally unique identifier

None.

parity

integer

Required

data_bits

integer

Required

stop_bits

integer

Required

handshake

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "3a40f725-2d8e-4a2d-be00-17b26b82268f",
  "name": "sample string 2",
  "pc_id": "abc171b5-fa98-4232-9f3e-333a5837645d",
  "com_port": 1,
  "baudrate": 1,
  "direction": "sample string 3",
  "has_correspondence": true,
  "active": true,
  "badge_reader_type_id": "94ed91e1-3720-42b7-a128-55a133ae8e66",
  "site_id": "943364fe-0eb1-4904-9970-e346d1a6298b",
  "parity": 6,
  "data_bits": 7,
  "stop_bits": 8,
  "handshake": 9
}

application/xml, text/xml

Sample:
<badgereader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <badge_reader_type_id>94ed91e1-3720-42b7-a128-55a133ae8e66</badge_reader_type_id>
  <baudrate>1</baudrate>
  <com_port>1</com_port>
  <data_bits>7</data_bits>
  <direction>sample string 3</direction>
  <handshake>9</handshake>
  <has_correspondence>true</has_correspondence>
  <id>3a40f725-2d8e-4a2d-be00-17b26b82268f</id>
  <name>sample string 2</name>
  <parity>6</parity>
  <pc_id>abc171b5-fa98-4232-9f3e-333a5837645d</pc_id>
  <site_id>943364fe-0eb1-4904-9970-e346d1a6298b</site_id>
  <stop_bits>8</stop_bits>
</badgereader>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"8ff1d329-fe8b-429b-bdf3-d6fa3cef51ab"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8ff1d329-fe8b-429b-bdf3-d6fa3cef51ab</guid>