POST api/EmployeeDependents

No documentation available.

Request Information

Parameters

Name	Description	Additional information
dependentRequestDetails	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "City": "sample string 4",
  "State": "sample string 5",
  "StreetAddress1": "sample string 6",
  "StreetAddress2": "sample string 7",
  "ZipCode": "sample string 8",
  "Ssn": "sample string 9",
  "DateOfBirth": "sample string 10",
  "Gender": "sample string 11",
  "RelationType": "sample string 12",
  "EmployeeId": 13,
  "ExternalDependentId": 14,
  "AreaCode": "sample string 15",
  "PhoneNumber": "sample string 16",
  "IsSmoker": "sample string 17",
  "IsDisabled": "sample string 18",
  "IsAdopted": "sample string 19",
  "AdoptionDate": "sample string 20",
  "MarriageDate": "sample string 21",
  "IsVerified": "sample string 22",
  "IsStepChild": "sample string 23",
  "IsUnderLegalGuardianship": "sample string 24",
  "IsFullTimeStudent": "sample string 25",
  "IsTobaccoCessationEnrolled": "sample string 26",
  "BenefitStartDate": "sample string 27",
  "IndividualType": 1,
  "IsChildAgeOverride": "sample string 28",
  "MarriageOrEligibilityDate": "sample string 29",
  "LegalGuardianshipDate": "sample string 30"
}

application/xml, text/xml

Sample:

<EmployeeDependentApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.Internal.Core.Models.Benefits.Dependent">
  <AdoptionDate>sample string 20</AdoptionDate>
  <AreaCode>sample string 15</AreaCode>
  <BenefitStartDate>sample string 27</BenefitStartDate>
  <City>sample string 4</City>
  <DateOfBirth>sample string 10</DateOfBirth>
  <EmployeeId>13</EmployeeId>
  <ExternalDependentId>14</ExternalDependentId>
  <FirstName>sample string 1</FirstName>
  <Gender>sample string 11</Gender>
  <IndividualType>Dependent</IndividualType>
  <IsAdopted>sample string 19</IsAdopted>
  <IsChildAgeOverride>sample string 28</IsChildAgeOverride>
  <IsDisabled>sample string 18</IsDisabled>
  <IsFullTimeStudent>sample string 25</IsFullTimeStudent>
  <IsSmoker>sample string 17</IsSmoker>
  <IsStepChild>sample string 23</IsStepChild>
  <IsTobaccoCessationEnrolled>sample string 26</IsTobaccoCessationEnrolled>
  <IsUnderLegalGuardianship>sample string 24</IsUnderLegalGuardianship>
  <IsVerified>sample string 22</IsVerified>
  <LastName>sample string 3</LastName>
  <LegalGuardianshipDate>sample string 30</LegalGuardianshipDate>
  <MarriageDate>sample string 21</MarriageDate>
  <MarriageOrEligibilityDate>sample string 29</MarriageOrEligibilityDate>
  <MiddleName>sample string 2</MiddleName>
  <PhoneNumber>sample string 16</PhoneNumber>
  <RelationType>sample string 12</RelationType>
  <Ssn>sample string 9</Ssn>
  <State>sample string 5</State>
  <StreetAddress1>sample string 6</StreetAddress1>
  <StreetAddress2>sample string 7</StreetAddress2>
  <ZipCode>sample string 8</ZipCode>
</EmployeeDependentApiRequest>

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "Code": 100,
  "Success": true,
  "Messages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ]
}

application/xml, text/xml

Sample:

<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.Internal.Core.Models.External">
  <Code>Continue</Code>
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </Messages>
  <Success>true</Success>
</ApiResponse>