GetPDF
Request a PDF download of New Hire report to be made available through Webhooks
GET NewHireReport/GetPDF
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | List of record Ids to be downloaded. |
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code. |
StatusMessage | string | Detailed status message. |
SubmissionId | Guid | Unique identifier of a submission. |
NHReportPdf | byte[] | Byte array of New Hire report pdf |
Errors | object[] | Shows detailed error information. |
Code | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Type | string | Type of validation error. |
Request JSON
{
"SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",
"RecordIds": [
"2ffde35c-c885-45c6-ab48-424a89c838ed"
]
}
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",
"NHReportPdf": "QEA=",
"Errors": null
}