PUT 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"
}
]
}