POST api/v2/{practiceId}/billing/providers/preferences

Update only one specific billing provider option

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Billing.Interface.Commands.ChangeProviderConfigurationOptions
NameDescriptionTypeAdditional information
ProviderId

globally unique identifier

None.
Options

Dictionary of string [key] and string [value]

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProviderId": "ee29efd6-3533-40f1-8358-5ec3f8bc63e0",
  "Options": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 2"
}

application/xml, text/xml

Sample: 
<ChangeProviderConfigurationOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 2</OriginatedSystem>
  <Options xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Options>
  <ProviderId>ee29efd6-3533-40f1-8358-5ec3f8bc63e0</ProviderId>
</ChangeProviderConfigurationOptions>

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 'ChangeProviderConfigurationOptions'.

Response Information

Resource Description

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": "a228a69a-4386-4d50-872b-627e183edd4f",
  "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>a228a69a-4386-4d50-872b-627e183edd4f</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>