POST api/groups/{groupid}/members/{memberid}/dependents
Adds a new dependent for the specified group and member.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| groupid |
The ID of the group to which the member belongs. |
integer |
Required |
| memberid |
The ID of the member to whom the dependent will be added. |
integer |
Required |
Body Parameters
The model containing the dependent's details.
DependentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MemberNo | integer |
None. |
|
| ID |
The ID of the dependent. This is the value that should be used to reference the dependent elsewhere in the system, such as on the member other status endpoint. |
integer |
None. |
| DependentCode |
A three digit code indicating the relationship of the dependent to the patient. |
string |
None. |
| SecondaryCoverageOnly |
Gets or sets a value indicating whether the dependent has secondary coverage only. |
boolean |
None. |
| COBRA |
Gets or sets a value indicating whether the dependent is covered under COBRA. |
boolean |
None. |
| ClientID |
Gets or sets the client ID associated with the dependent. |
string |
None. |
| ExternalID |
Gets or sets the ExternalID associated with the dependent |
string |
None. |
| FirstName |
Gets or sets the first name for this person. |
string |
None. |
| MiddleName |
Gets or sets the middle name for this person. |
string |
None. |
| LastName |
Gets or sets the last name for this person. |
string |
None. |
| EmailAddress |
Gets or sets the email address for this person. |
string |
None. |
| Gender |
Gets or sets the gender for this person. |
string |
None. |
| SSN |
Gets or sets the social security number for this person. |
string |
None. |
| AlternateID |
Gets or sets the alternate ID for this person. |
string |
None. |
| DateOfBirth |
Gets or sets the date of birth for this person. |
date |
None. |
| MaritalStatus | MaritalStatusCode |
None. |
|
| BirthPlace |
Gets or sets the Birthplace for this person. |
string |
None. |
| Occupation |
Gets or sets the occupation for this person. |
string |
None. |
| USCitizen |
Gets or sets a value indicating if this person is a US Citizen |
boolean |
None. |
| Military |
Gets or sets a value indicating if this person is in the Military |
boolean |
None. |
| Active |
Gets or sets the active status for this person. |
integer |
None. |
| MemberComment |
Gets or sets the member comment for this person. |
string |
None. |
| HasMedicare |
Gets or sets the flag to indicate this person has medicare. |
boolean |
None. |
| MedicareID |
Gets or sets the Medicare ID for this person. |
string |
None. |
| MedicarePlan |
Gets or sets the Medicare plan for this person. |
string |
None. |
| MedicareEffectiveDate |
Gets or sets the Medicare effective date for this person. |
date |
None. |
| Relationship | RelationshipCode |
None. |
|
| PersonCode |
Gets or sets the person code value for this dependent. This value is likely obsolete and should not be used. Use the DependentCode property to set a value for the dependent's person code. |
string |
None. |
| HomeAddress | PersonAddressModel |
None. |
|
| MailingAddress | PersonAddressModel |
None. |
|
| HomePhone | PersonPhoneModel |
None. |
|
| BusinessPhone | PersonPhoneModel |
None. |
|
| MobilePhone | PersonPhoneModel |
None. |
|
| FaxPhone | PersonPhoneModel |
None. |
|
| WirelessCarrier | MobileServiceProvider |
None. |
|
| Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
Request Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 26",
"id": 4,
"memberNo": 2,
"dependentCode": "sample string 5",
"secondaryCoverageOnly": true,
"cobra": true,
"clientID": "sample string 7",
"externalID": "sample string 8",
"firstName": "sample string 9",
"middleName": "sample string 10",
"lastName": "sample string 11",
"emailAddress": "sample string 12",
"gender": "sample string 13",
"ssn": "sample string 14",
"alternateID": "sample string 15",
"dateOfBirth": "2025-12-09T20:14:47.4068974-06:00",
"maritalStatus": 0,
"birthPlace": "sample string 17",
"occupation": "sample string 18",
"usCitizen": true,
"military": true,
"active": 19,
"memberComment": "sample string 20",
"hasMedicare": true,
"medicareID": "sample string 22",
"medicarePlan": "sample string 23",
"medicareEffectiveDate": "2025-12-09T20:14:47.4068974-06:00",
"relationship": "NotSpecified",
"personCode": "sample string 25",
"homeAddress": {
"addressType": "Business",
"address": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6"
},
"mailingAddress": {
"addressType": "Business",
"address": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6"
},
"homePhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"businessPhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"mobilePhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"faxPhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"wirelessCarrier": "Alltel"
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
An indicating the result of the operation. If successful, returns the added dependent's model. Otherwise, returns an appropriate error response.
DependentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MemberNo | integer |
None. |
|
| ID |
The ID of the dependent. This is the value that should be used to reference the dependent elsewhere in the system, such as on the member other status endpoint. |
integer |
None. |
| DependentCode |
A three digit code indicating the relationship of the dependent to the patient. |
string |
None. |
| SecondaryCoverageOnly |
Gets or sets a value indicating whether the dependent has secondary coverage only. |
boolean |
None. |
| COBRA |
Gets or sets a value indicating whether the dependent is covered under COBRA. |
boolean |
None. |
| ClientID |
Gets or sets the client ID associated with the dependent. |
string |
None. |
| ExternalID |
Gets or sets the ExternalID associated with the dependent |
string |
None. |
| FirstName |
Gets or sets the first name for this person. |
string |
None. |
| MiddleName |
Gets or sets the middle name for this person. |
string |
None. |
| LastName |
Gets or sets the last name for this person. |
string |
None. |
| EmailAddress |
Gets or sets the email address for this person. |
string |
None. |
| Gender |
Gets or sets the gender for this person. |
string |
None. |
| SSN |
Gets or sets the social security number for this person. |
string |
None. |
| AlternateID |
Gets or sets the alternate ID for this person. |
string |
None. |
| DateOfBirth |
Gets or sets the date of birth for this person. |
date |
None. |
| MaritalStatus | MaritalStatusCode |
None. |
|
| BirthPlace |
Gets or sets the Birthplace for this person. |
string |
None. |
| Occupation |
Gets or sets the occupation for this person. |
string |
None. |
| USCitizen |
Gets or sets a value indicating if this person is a US Citizen |
boolean |
None. |
| Military |
Gets or sets a value indicating if this person is in the Military |
boolean |
None. |
| Active |
Gets or sets the active status for this person. |
integer |
None. |
| MemberComment |
Gets or sets the member comment for this person. |
string |
None. |
| HasMedicare |
Gets or sets the flag to indicate this person has medicare. |
boolean |
None. |
| MedicareID |
Gets or sets the Medicare ID for this person. |
string |
None. |
| MedicarePlan |
Gets or sets the Medicare plan for this person. |
string |
None. |
| MedicareEffectiveDate |
Gets or sets the Medicare effective date for this person. |
date |
None. |
| Relationship | RelationshipCode |
None. |
|
| PersonCode |
Gets or sets the person code value for this dependent. This value is likely obsolete and should not be used. Use the DependentCode property to set a value for the dependent's person code. |
string |
None. |
| HomeAddress | PersonAddressModel |
None. |
|
| MailingAddress | PersonAddressModel |
None. |
|
| HomePhone | PersonPhoneModel |
None. |
|
| BusinessPhone | PersonPhoneModel |
None. |
|
| MobilePhone | PersonPhoneModel |
None. |
|
| FaxPhone | PersonPhoneModel |
None. |
|
| WirelessCarrier | MobileServiceProvider |
None. |
|
| Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 26",
"id": 4,
"memberNo": 2,
"dependentCode": "sample string 5",
"secondaryCoverageOnly": true,
"cobra": true,
"clientID": "sample string 7",
"externalID": "sample string 8",
"firstName": "sample string 9",
"middleName": "sample string 10",
"lastName": "sample string 11",
"emailAddress": "sample string 12",
"gender": "sample string 13",
"ssn": "sample string 14",
"alternateID": "sample string 15",
"dateOfBirth": "2025-12-09T20:14:47.407898-06:00",
"maritalStatus": 0,
"birthPlace": "sample string 17",
"occupation": "sample string 18",
"usCitizen": true,
"military": true,
"active": 19,
"memberComment": "sample string 20",
"hasMedicare": true,
"medicareID": "sample string 22",
"medicarePlan": "sample string 23",
"medicareEffectiveDate": "2025-12-09T20:14:47.407898-06:00",
"relationship": "NotSpecified",
"personCode": "sample string 25",
"homeAddress": {
"addressType": "Business",
"address": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6"
},
"mailingAddress": {
"addressType": "Business",
"address": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6"
},
"homePhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"businessPhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"mobilePhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"faxPhone": {
"phoneType": "Home",
"phone": "sample string 2",
"ext": "sample string 3"
},
"wirelessCarrier": "Alltel"
}