POST api/v1/Demographics/{token}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| token | string |
Required |
Body Parameters
DemographicAPI| Name | Description | Type | Additional information |
|---|---|---|---|
| EEID | string |
Required String length: inclusive between 0 and 20 |
|
| SSN | string |
Required String length: inclusive between 9 and 11 |
|
| FirstName | string |
Required String length: inclusive between 0 and 50 |
|
| MiddleName | string |
String length: inclusive between 0 and 50 |
|
| LastName | string |
Required String length: inclusive between 0 and 50 |
|
| DOB | string |
Required String length: inclusive between 0 and 50 |
|
| Gender | string |
Required String length: inclusive between 0 and 6 |
|
| Address1 | string |
Required String length: inclusive between 0 and 50 |
|
| Address2 | string |
String length: inclusive between 0 and 50 |
|
| City | string |
Required String length: inclusive between 0 and 50 |
|
| State | string |
Required String length: inclusive between 0 and 2 |
|
| Zip | string |
Required String length: inclusive between 0 and 10 |
|
| EmailAddress | string |
String length: inclusive between 0 and 128 |
|
| HomePhone | string |
String length: inclusive between 0 and 15 |
|
| GroupCode | string |
String length: inclusive between 0 and 20 |
|
| DepartmentCode | string |
String length: inclusive between 0 and 20 |
|
| DepartmentDesc | string |
String length: inclusive between 0 and 50 |
|
| LocationCode | string |
String length: inclusive between 0 and 20 |
|
| LocationDesc | string |
String length: inclusive between 0 and 50 |
|
| JobCode | string |
String length: inclusive between 0 and 20 |
|
| JobDesc | string |
String length: inclusive between 0 and 50 |
|
| FTPT | string |
Required String length: inclusive between 0 and 10 |
|
| PayFreq | string |
Required String length: inclusive between 0 and 10 |
|
| SalaryClass | string |
Required String length: inclusive between 0 and 10 |
|
| Exempt | string |
Required String length: inclusive between 0 and 10 |
|
| DOH | string |
Required String length: inclusive between 0 and 50 |
|
| AnnualSal | string |
Required String length: inclusive between 0 and 15 |
|
| MaritalStatus | string |
String length: inclusive between 0 and 5 |
|
| SmokerStatus | string |
String length: inclusive between 0 and 5 |
|
| dependents | Collection of DependentAPI |
None. |
Request Formats
application/json, text/json
{
"eeid": "sample string 1",
"ssn": "sample string 2",
"firstName": "sample string 3",
"middleName": "sample string 4",
"lastName": "sample string 5",
"dob": "sample string 6",
"gender": "sample string 7",
"address1": "sample string 8",
"address2": "sample string 9",
"city": "sample string 10",
"state": "sample string 11",
"zip": "sample string 12",
"emailAddress": "sample string 13",
"homePhone": "sample string 14",
"groupCode": "sample string 15",
"departmentCode": "sample string 16",
"departmentDesc": "sample string 17",
"locationCode": "sample string 18",
"locationDesc": "sample string 19",
"jobCode": "sample string 20",
"jobDesc": "sample string 21",
"ftpt": "sample string 22",
"payFreq": "sample string 23",
"salaryClass": "sample string 24",
"exempt": "sample string 25",
"doh": "sample string 26",
"annualSal": "sample string 27",
"maritalStatus": "sample string 28",
"smokerStatus": "sample string 29",
"dependents": [
{
"ssn": "sample string 1",
"depID": "sample string 2",
"fName": "sample string 3",
"mName": "sample string 4",
"lName": "sample string 5",
"dob": "sample string 6",
"dpSSN": "sample string 7",
"relationship": "sample string 8",
"gender": "sample string 9",
"student": "sample string 10",
"disabled": "sample string 11",
"dpSmoker": "sample string 12"
},
{
"ssn": "sample string 1",
"depID": "sample string 2",
"fName": "sample string 3",
"mName": "sample string 4",
"lName": "sample string 5",
"dob": "sample string 6",
"dpSSN": "sample string 7",
"relationship": "sample string 8",
"gender": "sample string 9",
"student": "sample string 10",
"disabled": "sample string 11",
"dpSmoker": "sample string 12"
}
]
}
Response Information
Resource Description
DemographicAPI| Name | Description | Type | Additional information |
|---|---|---|---|
| EEID | string |
Required String length: inclusive between 0 and 20 |
|
| SSN | string |
Required String length: inclusive between 9 and 11 |
|
| FirstName | string |
Required String length: inclusive between 0 and 50 |
|
| MiddleName | string |
String length: inclusive between 0 and 50 |
|
| LastName | string |
Required String length: inclusive between 0 and 50 |
|
| DOB | string |
Required String length: inclusive between 0 and 50 |
|
| Gender | string |
Required String length: inclusive between 0 and 6 |
|
| Address1 | string |
Required String length: inclusive between 0 and 50 |
|
| Address2 | string |
String length: inclusive between 0 and 50 |
|
| City | string |
Required String length: inclusive between 0 and 50 |
|
| State | string |
Required String length: inclusive between 0 and 2 |
|
| Zip | string |
Required String length: inclusive between 0 and 10 |
|
| EmailAddress | string |
String length: inclusive between 0 and 128 |
|
| HomePhone | string |
String length: inclusive between 0 and 15 |
|
| GroupCode | string |
String length: inclusive between 0 and 20 |
|
| DepartmentCode | string |
String length: inclusive between 0 and 20 |
|
| DepartmentDesc | string |
String length: inclusive between 0 and 50 |
|
| LocationCode | string |
String length: inclusive between 0 and 20 |
|
| LocationDesc | string |
String length: inclusive between 0 and 50 |
|
| JobCode | string |
String length: inclusive between 0 and 20 |
|
| JobDesc | string |
String length: inclusive between 0 and 50 |
|
| FTPT | string |
Required String length: inclusive between 0 and 10 |
|
| PayFreq | string |
Required String length: inclusive between 0 and 10 |
|
| SalaryClass | string |
Required String length: inclusive between 0 and 10 |
|
| Exempt | string |
Required String length: inclusive between 0 and 10 |
|
| DOH | string |
Required String length: inclusive between 0 and 50 |
|
| AnnualSal | string |
Required String length: inclusive between 0 and 15 |
|
| MaritalStatus | string |
String length: inclusive between 0 and 5 |
|
| SmokerStatus | string |
String length: inclusive between 0 and 5 |
|
| dependents | Collection of DependentAPI |
None. |
Response Formats
application/json, text/json
{
"eeid": "sample string 1",
"ssn": "sample string 2",
"firstName": "sample string 3",
"middleName": "sample string 4",
"lastName": "sample string 5",
"dob": "sample string 6",
"gender": "sample string 7",
"address1": "sample string 8",
"address2": "sample string 9",
"city": "sample string 10",
"state": "sample string 11",
"zip": "sample string 12",
"emailAddress": "sample string 13",
"homePhone": "sample string 14",
"groupCode": "sample string 15",
"departmentCode": "sample string 16",
"departmentDesc": "sample string 17",
"locationCode": "sample string 18",
"locationDesc": "sample string 19",
"jobCode": "sample string 20",
"jobDesc": "sample string 21",
"ftpt": "sample string 22",
"payFreq": "sample string 23",
"salaryClass": "sample string 24",
"exempt": "sample string 25",
"doh": "sample string 26",
"annualSal": "sample string 27",
"maritalStatus": "sample string 28",
"smokerStatus": "sample string 29",
"dependents": [
{
"ssn": "sample string 1",
"depID": "sample string 2",
"fName": "sample string 3",
"mName": "sample string 4",
"lName": "sample string 5",
"dob": "sample string 6",
"dpSSN": "sample string 7",
"relationship": "sample string 8",
"gender": "sample string 9",
"student": "sample string 10",
"disabled": "sample string 11",
"dpSmoker": "sample string 12"
},
{
"ssn": "sample string 1",
"depID": "sample string 2",
"fName": "sample string 3",
"mName": "sample string 4",
"lName": "sample string 5",
"dob": "sample string 6",
"dpSSN": "sample string 7",
"relationship": "sample string 8",
"gender": "sample string 9",
"student": "sample string 10",
"disabled": "sample string 11",
"dpSmoker": "sample string 12"
}
]
}