DELETE api/Dependants/delete?mobileregistrationdependantsid={mobileregistrationdependantsid}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
mobileregistrationdependantsid

integer

Required

Body Parameters

None.

Response Information

Resource Description

DependantsResponse
NameDescriptionTypeAdditional information
bhf

string

None.

idnumber

string

None.

dependents

Collection of Dependent

None.

dependants

Collection of Dependants

None.

resultcode

integer

None.

resulttext

string

None.

Response Formats

application/json, text/json

Sample:
{
  "bhf": "sample string 1",
  "idnumber": "sample string 2",
  "dependents": [
    {
      "firstname": "sample string 1",
      "lastname": "sample string 2",
      "dependentcode": "sample string 3",
      "idnumber": "sample string 4",
      "title": "sample string 5",
      "gender": "sample string 6",
      "allergies": "sample string 7",
      "dob": "sample string 8"
    },
    {
      "firstname": "sample string 1",
      "lastname": "sample string 2",
      "dependentcode": "sample string 3",
      "idnumber": "sample string 4",
      "title": "sample string 5",
      "gender": "sample string 6",
      "allergies": "sample string 7",
      "dob": "sample string 8"
    }
  ],
  "dependants": [
    {
      "uniquekey": "sample string 1",
      "mobileregistrationdependantsid": 2,
      "mobileregistrationid": 3,
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "dependentcode": "sample string 6",
      "idnumber": "sample string 7",
      "title": "sample string 8",
      "gender": "sample string 9",
      "allergies": "sample string 10",
      "dob": "sample string 11",
      "rxintegrationenabled": true,
      "bhf": "sample string 13",
      "mainidnumber": "sample string 14"
    },
    {
      "uniquekey": "sample string 1",
      "mobileregistrationdependantsid": 2,
      "mobileregistrationid": 3,
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "dependentcode": "sample string 6",
      "idnumber": "sample string 7",
      "title": "sample string 8",
      "gender": "sample string 9",
      "allergies": "sample string 10",
      "dob": "sample string 11",
      "rxintegrationenabled": true,
      "bhf": "sample string 13",
      "mainidnumber": "sample string 14"
    }
  ],
  "resultcode": 3,
  "resulttext": "sample string 4"
}

application/xml, text/xml

Sample:
<DependantsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Computassist.MobileRestAPI.Models">
  <bhf>sample string 1</bhf>
  <dependants>
    <Dependants>
      <allergies>sample string 10</allergies>
      <bhf>sample string 13</bhf>
      <dependentcode>sample string 6</dependentcode>
      <dob>sample string 11</dob>
      <firstname>sample string 4</firstname>
      <gender>sample string 9</gender>
      <idnumber>sample string 7</idnumber>
      <lastname>sample string 5</lastname>
      <mainidnumber>sample string 14</mainidnumber>
      <mobileregistrationdependantsid>2</mobileregistrationdependantsid>
      <mobileregistrationid>3</mobileregistrationid>
      <rxintegrationenabled>true</rxintegrationenabled>
      <title>sample string 8</title>
      <uniquekey>sample string 1</uniquekey>
    </Dependants>
    <Dependants>
      <allergies>sample string 10</allergies>
      <bhf>sample string 13</bhf>
      <dependentcode>sample string 6</dependentcode>
      <dob>sample string 11</dob>
      <firstname>sample string 4</firstname>
      <gender>sample string 9</gender>
      <idnumber>sample string 7</idnumber>
      <lastname>sample string 5</lastname>
      <mainidnumber>sample string 14</mainidnumber>
      <mobileregistrationdependantsid>2</mobileregistrationdependantsid>
      <mobileregistrationid>3</mobileregistrationid>
      <rxintegrationenabled>true</rxintegrationenabled>
      <title>sample string 8</title>
      <uniquekey>sample string 1</uniquekey>
    </Dependants>
  </dependants>
  <dependents>
    <Dependent>
      <allergies>sample string 7</allergies>
      <dependentcode>sample string 3</dependentcode>
      <dob>sample string 8</dob>
      <firstname>sample string 1</firstname>
      <gender>sample string 6</gender>
      <idnumber>sample string 4</idnumber>
      <lastname>sample string 2</lastname>
      <title>sample string 5</title>
    </Dependent>
    <Dependent>
      <allergies>sample string 7</allergies>
      <dependentcode>sample string 3</dependentcode>
      <dob>sample string 8</dob>
      <firstname>sample string 1</firstname>
      <gender>sample string 6</gender>
      <idnumber>sample string 4</idnumber>
      <lastname>sample string 2</lastname>
      <title>sample string 5</title>
    </Dependent>
  </dependents>
  <idnumber>sample string 2</idnumber>
  <resultcode>3</resultcode>
  <resulttext>sample string 4</resulttext>
</DependantsResponse>