POST api/v1/{tenantid}/cardprocessing/cardreaders
Adds a new Card Reader
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
tenantid |
Tenant id |
globally unique identifier |
Required |
Body Parameters
Details of the Card Reader to be added.
Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.CardReaderVoName | Description | Type | Additional information |
---|---|---|---|
CardReaderId | globally unique identifier |
None. |
|
TenantId | globally unique identifier |
None. |
|
NodeId | unsigned integer |
None. |
|
Identifier | string |
None. |
|
SerialNumber | string |
None. |
|
Address | string |
None. |
|
Port | string |
None. |
|
ConnectionMethod | Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.ConnectionMethod |
None. |
|
SharedSecret | string |
None. |
|
NodeVersion | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "CardReaderId": "83f21b62-a640-4e5b-8cd7-b90275013fbd", "TenantId": "001f065f-757f-46d3-ba9f-52941e76066b", "NodeId": 3, "Identifier": "sample string 4", "SerialNumber": "sample string 5", "Address": "sample string 6", "Port": "sample string 7", "ConnectionMethod": 1, "SharedSecret": "sample string 8", "NodeVersion": "sample string 9" }
application/xml, text/xml
Sample:
<CardReader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/rcm/cardprocessing/v1/cardpayment/"> <Address>sample string 6</Address> <CardReaderId>83f21b62-a640-4e5b-8cd7-b90275013fbd</CardReaderId> <ConnectionMethod>Bluetooth</ConnectionMethod> <Identifier>sample string 4</Identifier> <NodeId>3</NodeId> <NodeVersion>sample string 9</NodeVersion> <Port>sample string 7</Port> <SerialNumber>sample string 5</SerialNumber> <SharedSecret>sample string 8</SharedSecret> <TenantId>001f065f-757f-46d3-ba9f-52941e76066b</TenantId> </CardReader>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
NodeId of the Card Reader added.
Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.GuidName | Description | Type | Additional information |
---|---|---|---|
Sucess | boolean |
None. |
|
ResponseCode | integer |
None. |
|
ResponseMessage | string |
None. |
|
Data | globally unique identifier |
None. |
|
Links | Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink |
None. |
Response Formats
application/json, text/json
Sample:
{ "Sucess": true, "ResponseCode": 2, "ResponseMessage": "sample string 3", "Data": "1f588e6d-3421-435b-a9d8-81b0f98820f5", "Links": [ { "Rel": "sample string 1", "HRef": "sample string 2" }, { "Rel": "sample string 1", "HRef": "sample string 2" } ] }
application/xml, text/xml
Sample:
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects"> <Data>1f588e6d-3421-435b-a9d8-81b0f98820f5</Data> <Links> <RestApiLink> <HRef>sample string 2</HRef> <Rel>sample string 1</Rel> </RestApiLink> <RestApiLink> <HRef>sample string 2</HRef> <Rel>sample string 1</Rel> </RestApiLink> </Links> <ResponseCode>2</ResponseCode> <ResponseMessage>sample string 3</ResponseMessage> <Sucess>true</Sucess> </RestApiResultOfguid>