HR Software User Defined Fields API Support

User Defined Fields
Home > Resources > User Defined Fields

This API retrieves user defined fields for specified employees.

Resource URL

https://serverurl/path/v1.1/employee/[employeeuid]/custom/[fieldid]

[employeeuid] is the unique employee identifier.
[field id] is the custom field id returend in the Fields API.

Example Request
GET	https://serverurl/api/v1.1/employee/26/custom/54

Return Value

Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned.

XML

<userfields>
  <userfield id="30" name="field">
    <subfield position="42" name="subfield">value</subfield>
  </userfield>
</userfields>

JSON

{ "userfields":
    [{
      "id":30,
      "name":"field",
      "subfields":
      [{
        "position":42,
        "name":"subfield",
        "value":"value"
      }]},
      { ... },
      { ... },
    ]
}

Resource Information
Requires Authentication?	Yes
Response Formats	json xml
HTTP Methods	GET
Request Content	N/A
Return Code	200: Response Completed 403: Incorrect Authorization 400: Bad Data 404: Employee does not exist

Ascentis offers a comprehensive suite of on-demand HRIS/HRMS HR software, employee self-service, online payroll, applicant tracking system, and time and attendance software solutions. Our HRIS software/ HR management software, online payroll services, recruiting software, and online timesheet products are easy to set up, use, and are fully backed by friendly customer support professionals. Ascentis has been an innovative leader in human resource software since 1980.