POST Policy/GetCards

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedRequest
NameDescriptionTypeAdditional information
SecurityKey

string

None.

PolicyId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SecurityKey": "sample string 1",
  "PolicyId": 2
}

application/xml, text/xml

Sample:
<SecurityTokenVerifiedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>2</PolicyId>
  <SecurityKey>sample string 1</SecurityKey>
</SecurityTokenVerifiedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfListOfCard
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

Collection of Card

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": [
    {
      "CardId": 1,
      "CardNumber": "sample string 2",
      "MemberAccountId": 3,
      "Name": "sample string 4",
      "TrackingNumber": "sample string 5",
      "TotalBalance": 6.0,
      "IsActive": true,
      "ExpiryDate": "2025-05-13T23:26:28.7605807+02:00"
    },
    {
      "CardId": 1,
      "CardNumber": "sample string 2",
      "MemberAccountId": 3,
      "Name": "sample string 4",
      "TrackingNumber": "sample string 5",
      "TotalBalance": 6.0,
      "IsActive": true,
      "ExpiryDate": "2025-05-13T23:26:28.7605807+02:00"
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfCardlP_S41WJs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
    <d2p1:Card>
      <d2p1:CardId>1</d2p1:CardId>
      <d2p1:CardNumber>sample string 2</d2p1:CardNumber>
      <d2p1:ExpiryDate>2025-05-13T23:26:28.7605807+02:00</d2p1:ExpiryDate>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:MemberAccountId>3</d2p1:MemberAccountId>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:TotalBalance>6</d2p1:TotalBalance>
      <d2p1:TrackingNumber>sample string 5</d2p1:TrackingNumber>
    </d2p1:Card>
    <d2p1:Card>
      <d2p1:CardId>1</d2p1:CardId>
      <d2p1:CardNumber>sample string 2</d2p1:CardNumber>
      <d2p1:ExpiryDate>2025-05-13T23:26:28.7605807+02:00</d2p1:ExpiryDate>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:MemberAccountId>3</d2p1:MemberAccountId>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:TotalBalance>6</d2p1:TotalBalance>
      <d2p1:TrackingNumber>sample string 5</d2p1:TrackingNumber>
    </d2p1:Card>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfArrayOfCardlP_S41WJs>