PUT api/v1/{tenantid}/cardprocessing/cardreaders/{cardReaderId}

Updates the details for an existing Card Reader

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantid

Tenant id

 globally unique identifier

Required
cardReaderId

Card Reader id

 globally unique identifier

Required

Body Parameters

Details of the Card Reader to be updated.

Com.Healthbridge.Hhas.CardProcessing.Interface.ValueObjects.CardReaderVo
NameDescriptionTypeAdditional 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": "d7abbf76-2c8c-4db5-b65c-f35922d9de56",
  "TenantId": "584b6baa-4bc6-4bda-8db6-bd4e9a01becd",
  "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>d7abbf76-2c8c-4db5-b65c-f35922d9de56</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>584b6baa-4bc6-4bda-8db6-bd4e9a01becd</TenantId>
</CardReader>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CardReaderVo'.

Response Information

Resource Description

NodeId of the Card Reader updated.

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional 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": "9183ba09-04bd-4442-8b77-1b190a5be14f",
  "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>9183ba09-04bd-4442-8b77-1b190a5be14f</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>