New Hire
Home > Resources > New Hire
The purpose of this API is to send a new hire to Ascentis and possibly complete information on the new hire. This API can also be used to send updates for existing employees.
See Update for details on using this API to update employees.
XML or JSON containing the new hire data. The list of available fields is available at /fields/. Validation is performed and the create employee UID is returned. This UID is used in most other employee related APIs. If there are no user fields or standard fields, leave out that section.
https://serverurl/path/v1.1/newhire
[employeeuid] is the unique employee identifier.
| Example Request | |
| POST | https://serverurl/api/v1.1/newhire |
| Request Content |
| XML |
|
| JSON |
|
| FieldName: Name of the field. Available field names can be found via /fields. |
| FieldValue: Value of the field. Dates and numerics should be XML encoded. |
| userfields: custom fields
id: Custom field ID listid: For list type custom fields, the row id to be updated. If not specified, a new row is added. name: Name of the field, not required for updates subfields position: Position id of the field. name: Name of the field, not required for updates value: Value of the field. Dates and numerics should be XML encoded. |
| Return Value |
| <employee id=""/> |
| |
| Resource Information | |
| Requires Authentication? | Yes |
| Response Formats | json xml |
| HTTP Methods | POST |
| Request Content | N/A |
| Return Code | 200: Response Completed 403: Incorrect Authorization 400: Bad Data |
