POST api/v2/memberApplication/{applicationID}/dependents/{dependentID}

Request Information

URI Parameters

Name	Description	Type	Additional information
applicationID		string	Required
dependentID		string	Required

Body Parameters

EFormDependent

Name	Type	Additional information
MemberID	string	None.
DependentOrderNumber	integer	None.
Title	string	None.
TitleId	string	None.
HasSameNominatedProvider	string	None.
HasSameNominatedProviderBoolean	boolean	None.
DependentID	string	None.
FirstName	string	None.
LastName	string	None.
Gender	EFormGender	None.
Nationality	Nationality	None.
IdentityNumber	string	None.
PassportNumber	string	None.
AnnualIncome	decimal number	None.
CellphoneNumber	string	None.
Ethnicity	string	None.
EthnicityId	string	None.
EmailAddress	string	None.
IsFactualDependant	boolean	None.
IsStudent	boolean	None.
IsHandicapped	boolean	None.
DateOfBirth	date	None.
IsResidentialAddressSameAsMainMemberPostal	boolean	None.
ResidentialAddress	EFormAddress	None.
IsPostalSameAsMainMemberPostal	boolean	None.
IsPostalSameAsResidential	boolean	None.
PostalAddress	EFormAddress	None.
Relationship	EFormDependentRelationship	None.
RelationshipValue	string	None.
Practitioner	Doctor	None.
DependantDocument	EFormDependantDocuments	None.
VisaNumber	string	None.
CountryOfOrigin	Nationality	None.

Request Formats

application/json, text/json

Sample:

{
  "MemberID": "sample string 1",
  "DependentOrderNumber": 1,
  "Title": "sample string 2",
  "TitleId": "sample string 3",
  "HasSameNominatedProvider": "sample string 4",
  "HasSameNominatedProviderBoolean": true,
  "DependentID": "sample string 6",
  "FirstName": "sample string 7",
  "LastName": "sample string 8",
  "Gender": {
    "Description": "sample string 1",
    "ID": "sample string 2"
  },
  "Nationality": {
    "ID": "sample string 1",
    "Description": "sample string 2"
  },
  "IdentityNumber": "sample string 9",
  "PassportNumber": "sample string 10",
  "AnnualIncome": 1.0,
  "CellphoneNumber": "sample string 11",
  "Ethnicity": "sample string 12",
  "EthnicityId": "sample string 13",
  "EmailAddress": "sample string 14",
  "IsFactualDependant": true,
  "IsStudent": true,
  "IsHandicapped": true,
  "DateOfBirth": "2025-06-14T17:22:03.0344532+02:00",
  "IsResidentialAddressSameAsMainMemberPostal": true,
  "ResidentialAddress": {
    "AddressID": 1,
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "Province": {
      "ID": "sample string 1",
      "Description": "sample string 2"
    },
    "PostalCode": "sample string 5"
  },
  "IsPostalSameAsMainMemberPostal": true,
  "IsPostalSameAsResidential": true,
  "PostalAddress": {
    "AddressID": 1,
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "Province": {
      "ID": "sample string 1",
      "Description": "sample string 2"
    },
    "PostalCode": "sample string 5"
  },
  "Relationship": {
    "Description": "sample string 1",
    "ID": "sample string 2"
  },
  "RelationshipValue": "sample string 15",
  "Practitioner": {
    "Name": "sample string 1",
    "Surname": "sample string 2",
    "PracticeNumber": "sample string 3",
    "IsHealthPractitioner": true,
    "ContactNumber": "sample string 4",
    "Address": {
      "AddressID": 1,
      "AddressLine1": "sample string 2",
      "AddressLine2": "sample string 3",
      "AddressLine3": "sample string 4",
      "Province": {
        "ID": "sample string 1",
        "Description": "sample string 2"
      },
      "PostalCode": "sample string 5"
    }
  },
  "DependantDocument": {
    "urlIdentityNumber": "sample string 1",
    "urlAffidavit": "sample string 2",
    "urlMarriageCertificate": "sample string 3",
    "urlProofOfSupportGrant": "sample string 4",
    "urlAdoptoinLetter": "sample string 5",
    "urlProofOfStudentRegistration": "sample string 6",
    "urlProofOfDisability": "sample string 7",
    "urlEvidenceDivorceOrder": "sample string 8"
  },
  "VisaNumber": "sample string 16",
  "CountryOfOrigin": {
    "ID": "sample string 1",
    "Description": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<EFormDependent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models">
  <AnnualIncome xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">1</AnnualIncome>
  <CellphoneNumber xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 11</CellphoneNumber>
  <CountryOfOrigin xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:Description>sample string 2</d2p1:Description>
    <d2p1:ID>sample string 1</d2p1:ID>
  </CountryOfOrigin>
  <DateOfBirth xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">2025-06-14T17:22:03.0344532+02:00</DateOfBirth>
  <DependantDocument xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:urlAdoptoinLetter>sample string 5</d2p1:urlAdoptoinLetter>
    <d2p1:urlAffidavit>sample string 2</d2p1:urlAffidavit>
    <d2p1:urlEvidenceDivorceOrder>sample string 8</d2p1:urlEvidenceDivorceOrder>
    <d2p1:urlIdentityNumber>sample string 1</d2p1:urlIdentityNumber>
    <d2p1:urlMarriageCertificate>sample string 3</d2p1:urlMarriageCertificate>
    <d2p1:urlProofOfDisability>sample string 7</d2p1:urlProofOfDisability>
    <d2p1:urlProofOfStudentRegistration>sample string 6</d2p1:urlProofOfStudentRegistration>
    <d2p1:urlProofOfSupportGrant>sample string 4</d2p1:urlProofOfSupportGrant>
  </DependantDocument>
  <DependentID xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 6</DependentID>
  <EmailAddress xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 14</EmailAddress>
  <Ethnicity xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 12</Ethnicity>
  <EthnicityId xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 13</EthnicityId>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 7</FirstName>
  <Gender xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:Description>sample string 1</d2p1:Description>
    <d2p1:ID>sample string 2</d2p1:ID>
  </Gender>
  <HasSameNominatedProvider xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 4</HasSameNominatedProvider>
  <HasSameNominatedProviderBoolean xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">true</HasSameNominatedProviderBoolean>
  <IdentityNumber xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 9</IdentityNumber>
  <IsFactualDependant xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">true</IsFactualDependant>
  <IsHandicapped xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">true</IsHandicapped>
  <IsPostalSameAsMainMemberPostal xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">true</IsPostalSameAsMainMemberPostal>
  <IsPostalSameAsResidential xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">true</IsPostalSameAsResidential>
  <IsResidentialAddressSameAsMainMemberPostal xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">true</IsResidentialAddressSameAsMainMemberPostal>
  <IsStudent xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">true</IsStudent>
  <LastName xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 8</LastName>
  <Nationality xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:Description>sample string 2</d2p1:Description>
    <d2p1:ID>sample string 1</d2p1:ID>
  </Nationality>
  <PassportNumber xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 10</PassportNumber>
  <PostalAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:AddressID>1</d2p1:AddressID>
    <d2p1:AddressLine1>sample string 2</d2p1:AddressLine1>
    <d2p1:AddressLine2>sample string 3</d2p1:AddressLine2>
    <d2p1:AddressLine3>sample string 4</d2p1:AddressLine3>
    <d2p1:PostalCode>sample string 5</d2p1:PostalCode>
    <d2p1:Province>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:ID>sample string 1</d2p1:ID>
    </d2p1:Province>
  </PostalAddress>
  <Practitioner xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:Address>
      <d2p1:AddressID>1</d2p1:AddressID>
      <d2p1:AddressLine1>sample string 2</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 3</d2p1:AddressLine2>
      <d2p1:AddressLine3>sample string 4</d2p1:AddressLine3>
      <d2p1:PostalCode>sample string 5</d2p1:PostalCode>
      <d2p1:Province>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:ID>sample string 1</d2p1:ID>
      </d2p1:Province>
    </d2p1:Address>
    <d2p1:ContactNumber>sample string 4</d2p1:ContactNumber>
    <d2p1:IsHealthPractitioner>true</d2p1:IsHealthPractitioner>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:PracticeNumber>sample string 3</d2p1:PracticeNumber>
    <d2p1:Surname>sample string 2</d2p1:Surname>
  </Practitioner>
  <Relationship xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:Description>sample string 1</d2p1:Description>
    <d2p1:ID>sample string 2</d2p1:ID>
  </Relationship>
  <RelationshipValue xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 15</RelationshipValue>
  <ResidentialAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models" xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">
    <d2p1:AddressID>1</d2p1:AddressID>
    <d2p1:AddressLine1>sample string 2</d2p1:AddressLine1>
    <d2p1:AddressLine2>sample string 3</d2p1:AddressLine2>
    <d2p1:AddressLine3>sample string 4</d2p1:AddressLine3>
    <d2p1:PostalCode>sample string 5</d2p1:PostalCode>
    <d2p1:Province>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:ID>sample string 1</d2p1:ID>
    </d2p1:Province>
  </ResidentialAddress>
  <Title xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 2</Title>
  <TitleId xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 3</TitleId>
  <VisaNumber xmlns="http://schemas.datacontract.org/2004/07/GEMS.Eforms.Models.Abstract">sample string 16</VisaNumber>
  <DependentOrderNumber>1</DependentOrderNumber>
  <MemberID>sample string 1</MemberID>
</EFormDependent>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.