POST api/Financial

Request Information

URI Parameters

None.

Body Parameters

RequestCardInfo
NameDescriptionTypeAdditional information
patientID

integer

None.

DBName

string

None.

DecryptionKey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "patientID": 1,
  "DBName": "sample string 2",
  "DecryptionKey": "sample string 3"
}

application/xml, text/xml

Sample:
<RequestCardInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <DBName>sample string 2</DBName>
  <DecryptionKey>sample string 3</DecryptionKey>
  <patientID>1</patientID>
</RequestCardInfo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestCardInfo'.

Response Information

Resource Description

Collection of RequestBillingIHealthCardInfo
NameDescriptionTypeAdditional information
CardType

integer

None.

CardName

string

None.

HealthCardID

integer

None.

CardNbr

string

None.

ExpiryDate

string

None.

IsActive

boolean

None.

AreaTreated

string

None.

InsuranceOrgName

string

None.

InsuranceExpireDate

string

None.

InsuranceExpired

boolean

None.

DVACardType

string

None.

HasEPC

boolean

None.

EPCReferralDate

string

None.

EPCExpiryDate

string

None.

EPCIsExpired

boolean

None.

CombinedEPCRemaining

integer

None.

CombinedEPCRemainingThisYear

integer

None.

MaxClaimableThisYear

integer

None.

CombinedEPCUsedThisYear

integer

None.

CombinedEPCRemainingNextYear

integer

None.

EpcRemaining

Collection of RequestReferralRemaining

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CardType": 1,
    "CardName": "sample string 2",
    "HealthCardID": 3,
    "CardNbr": "sample string 4",
    "ExpiryDate": "sample string 5",
    "IsActive": true,
    "AreaTreated": "sample string 7",
    "InsuranceOrgName": "sample string 8",
    "InsuranceExpireDate": "sample string 9",
    "InsuranceExpired": true,
    "DVACardType": "sample string 11",
    "HasEPC": true,
    "EPCReferralDate": "sample string 13",
    "EPCExpiryDate": "sample string 14",
    "EPCIsExpired": true,
    "CombinedEPCRemaining": 16,
    "CombinedEPCRemainingThisYear": 17,
    "MaxClaimableThisYear": 18,
    "CombinedEPCUsedThisYear": 19,
    "CombinedEPCRemainingNextYear": 20,
    "EpcRemaining": null
  },
  {
    "CardType": 1,
    "CardName": "sample string 2",
    "HealthCardID": 3,
    "CardNbr": "sample string 4",
    "ExpiryDate": "sample string 5",
    "IsActive": true,
    "AreaTreated": "sample string 7",
    "InsuranceOrgName": "sample string 8",
    "InsuranceExpireDate": "sample string 9",
    "InsuranceExpired": true,
    "DVACardType": "sample string 11",
    "HasEPC": true,
    "EPCReferralDate": "sample string 13",
    "EPCExpiryDate": "sample string 14",
    "EPCIsExpired": true,
    "CombinedEPCRemaining": 16,
    "CombinedEPCRemainingThisYear": 17,
    "MaxClaimableThisYear": 18,
    "CombinedEPCUsedThisYear": 19,
    "CombinedEPCRemainingNextYear": 20,
    "EpcRemaining": null
  }
]

application/xml, text/xml

Sample:
<ArrayOfRequestBillingIHealthCardInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MediClinicAPI.BLL">
  <RequestBillingIHealthCardInfo>
    <AreaTreated>sample string 7</AreaTreated>
    <CardName>sample string 2</CardName>
    <CardNbr>sample string 4</CardNbr>
    <CardType>1</CardType>
    <CombinedEPCRemaining>16</CombinedEPCRemaining>
    <CombinedEPCRemainingNextYear>20</CombinedEPCRemainingNextYear>
    <CombinedEPCRemainingThisYear>17</CombinedEPCRemainingThisYear>
    <CombinedEPCUsedThisYear>19</CombinedEPCUsedThisYear>
    <DVACardType>sample string 11</DVACardType>
    <EPCExpiryDate>sample string 14</EPCExpiryDate>
    <EPCIsExpired>true</EPCIsExpired>
    <EPCReferralDate>sample string 13</EPCReferralDate>
    <EpcRemaining i:nil="true" />
    <ExpiryDate>sample string 5</ExpiryDate>
    <HasEPC>true</HasEPC>
    <HealthCardID>3</HealthCardID>
    <InsuranceExpireDate>sample string 9</InsuranceExpireDate>
    <InsuranceExpired>true</InsuranceExpired>
    <InsuranceOrgName>sample string 8</InsuranceOrgName>
    <IsActive>true</IsActive>
    <MaxClaimableThisYear>18</MaxClaimableThisYear>
  </RequestBillingIHealthCardInfo>
  <RequestBillingIHealthCardInfo>
    <AreaTreated>sample string 7</AreaTreated>
    <CardName>sample string 2</CardName>
    <CardNbr>sample string 4</CardNbr>
    <CardType>1</CardType>
    <CombinedEPCRemaining>16</CombinedEPCRemaining>
    <CombinedEPCRemainingNextYear>20</CombinedEPCRemainingNextYear>
    <CombinedEPCRemainingThisYear>17</CombinedEPCRemainingThisYear>
    <CombinedEPCUsedThisYear>19</CombinedEPCUsedThisYear>
    <DVACardType>sample string 11</DVACardType>
    <EPCExpiryDate>sample string 14</EPCExpiryDate>
    <EPCIsExpired>true</EPCIsExpired>
    <EPCReferralDate>sample string 13</EPCReferralDate>
    <EpcRemaining i:nil="true" />
    <ExpiryDate>sample string 5</ExpiryDate>
    <HasEPC>true</HasEPC>
    <HealthCardID>3</HealthCardID>
    <InsuranceExpireDate>sample string 9</InsuranceExpireDate>
    <InsuranceExpired>true</InsuranceExpired>
    <InsuranceOrgName>sample string 8</InsuranceOrgName>
    <IsActive>true</IsActive>
    <MaxClaimableThisYear>18</MaxClaimableThisYear>
  </RequestBillingIHealthCardInfo>
</ArrayOfRequestBillingIHealthCardInfo>