GET v1/GetEmployeeDocument
Documentation/Notes
Only one document for one employee can be retrieved in a single call.
Request Information
Authorization required.
Need to send an authorized BDtoken under the Authorization header along with the call.
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userName |
Username of the employee whose document is being requested. |
string |
Required |
documentType |
COMPLETE, CUSTOMFIELDS, CUSTOMFORM, I9, INTEGRATION, POLICY, DIRECTDEPOSIT, UPLOAD, VOLUNTARYSURVEY, W4FEDERAL, or W4STATE |
string |
Required |
documentSubType |
Optional field if requesting a documentType such as CUSTOMFORM (e.g. FormName) |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
ByteArrayContentName | Description | Type | Additional information |
---|---|---|---|
Headers | Collection of Object |
None. |
Response Formats
application/bytearraycontent
Sample:
System.Net.Http.ByteArrayContent
application/json, text/json
Sample:
Sample not available.