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": "555ffe13-aada-42e3-94c0-7da751351832",
  "name": "sample string 2",
  "pc_id": "2a2322fe-8433-4bd9-8ee8-70ad0bfd78ec",
  "com_port": 1,
  "baudrate": 1,
  "direction": "sample string 3",
  "has_correspondence": true,
  "active": true,
  "badge_reader_type_id": "31381daf-dd3b-4ea8-af4a-25788e33fbab",
  "site_id": "ea65bab8-0137-412e-9aeb-1ef3e8507e50",
  "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>31381daf-dd3b-4ea8-af4a-25788e33fbab</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>555ffe13-aada-42e3-94c0-7da751351832</id>
  <name>sample string 2</name>
  <parity>6</parity>
  <pc_id>2a2322fe-8433-4bd9-8ee8-70ad0bfd78ec</pc_id>
  <site_id>ea65bab8-0137-412e-9aeb-1ef3e8507e50</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:
"11cc38d4-1d9c-4a3e-b409-81e1316d1bf5"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">11cc38d4-1d9c-4a3e-b409-81e1316d1bf5</guid>