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": "b24cdd04-2fe4-4acf-95d6-6bb823be54c3",
  "name": "sample string 2",
  "pc_id": "976150d3-c09c-4747-8578-8dd9f6c28d11",
  "com_port": 1,
  "baudrate": 1,
  "direction": "sample string 3",
  "has_correspondence": true,
  "active": true,
  "badge_reader_type_id": "cea4fe52-bed1-4f5b-aa0b-da97504ca1df",
  "site_id": "5f2ff1b4-f457-42b8-9477-1483c29d0d61",
  "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>cea4fe52-bed1-4f5b-aa0b-da97504ca1df</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>b24cdd04-2fe4-4acf-95d6-6bb823be54c3</id>
  <name>sample string 2</name>
  <parity>6</parity>
  <pc_id>976150d3-c09c-4747-8578-8dd9f6c28d11</pc_id>
  <site_id>5f2ff1b4-f457-42b8-9477-1483c29d0d61</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:
"740f4206-bac6-42f7-81d4-d61ec21b87e7"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">740f4206-bac6-42f7-81d4-d61ec21b87e7</guid>