POST api/v1/billing/chargecodes/deactivate

Used to do deactivate of charge code

Request Information

URI Parameters

None.

Body Parameters

Com.Healthbridge.Hhas.Billing.Interface.Commands.DeactivateChargeCode
NameDescriptionTypeAdditional information
ChargeCodeVo

Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.ChargeCodeVo

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ChargeCodeVo": {
    "Id": "40a9c9f6-9e47-4d93-a169-0b1753594e5c",
    "ChargeCode": "sample string 2",
    "Description": "sample string 3",
    "SpecialityCode": "sample string 4",
    "Price": 1,
    "CodeType": "sample string 5",
    "MedicalAid": "sample string 6",
    "Speciality": "sample string 7",
    "PackSize": 1,
    "DrugSchedule": 1,
    "AllowedRecipients": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 1"
}

application/xml, text/xml

Sample: 
<DeactivateChargeCode 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 1</OriginatedSystem>
  <ChargeCodeVo xmlns:d2p1="http://mpsapi.healthbridge.com/rcm/billing/v1/invoice/">
    <d2p1:AllowedRecipients xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:AllowedRecipients>
    <d2p1:ChargeCode>sample string 2</d2p1:ChargeCode>
    <d2p1:CodeType>sample string 5</d2p1:CodeType>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DrugSchedule>1</d2p1:DrugSchedule>
    <d2p1:Id>40a9c9f6-9e47-4d93-a169-0b1753594e5c</d2p1:Id>
    <d2p1:MedicalAid>sample string 6</d2p1:MedicalAid>
    <d2p1:PackSize>1</d2p1:PackSize>
    <d2p1:Price>1</d2p1:Price>
    <d2p1:Speciality>sample string 7</d2p1:Speciality>
    <d2p1:SpecialityCode>sample string 4</d2p1:SpecialityCode>
  </ChargeCodeVo>
</DeactivateChargeCode>

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

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Boolean
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

boolean

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": true,
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>true</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>
</RestApiResultOfboolean>