In this reference we will go over the attributes of the job object and some of the possibilities that you have using the hokify ATS-API.
(For complete documentation, please refer to the Swagger Definition that is auto-generated and up-to-date!)
The "job" object (ICreateOrUpdateJobDTO)
All job data are written via the "job" object (mainly using "params") through the ATS-API.
The lifespan of a job revolves around the central element: its ID. (hokify-internally known as "sourceId" as it comes from you, or something in your possession: the source of each job.)
We need a unique ID so that we and you in the system can find the jobs again.
(Similar to creating any data in any software, these IDs must not be re-used for different jobs at later time!)
All job data are passed as "params" of type IJobAtsEditFields.
For any individual request, no param is strictly required (as createOrUpdateJob may also be used to simply update a single value).
For a job in general, the minimum details required for a job are the following params (besides its sourceId):
Additional information that is advisable:
description / descriptionHTML
The actual description of the job-ad can be submitted either in HTML format (using param descriptionHTML) or plain text (using param description) and will be transformed into the hokify layout. Possible formatting is headings, paragraphs, lists.
All headings (h1, h2, h3, h4, h5, h6) are transformed to one level.
Lists (ul, ol) are displayed as unordered list and flattened to one level only. (Paragraphs starting with "- " (dash followed by space) are treated as lists as well!)
Paragraphs (p) are kept and displayed with margin in between.
Newlines (br) are kept and displayed as line-breaks, but with no margin.
Everything else is removed from the HTML before transforming (especially styling-tags, attributes, links, images, scripts).
Lines starting with multiple CAPITAL letters are transformed to headings. (Capitalized text in the middle of a line is kept but not highlighted.)
Lines starting with dash followed by space ("- ") are treated as lists.
Line breaks must be line-feed (\n). However, Windows-style (carriage-return line-feed \r\n) works as well since it contains the line-feed anyways.
Singe line-breaks are just line-breaks (like HTML br) while multiple line-breaks denote paragraphs (like HTML p) with margin in between.
Other formattings (e.g. Markdown, TeX) are currently not supported.
Custom CSS is not supported.
Links (e.g. to another job-page / your homepage) are not allowed. (Linking to your homepage is possible on the company-detail page).
The example below shows two different inputs that will result in the same job description in the frontend:
Submit a job image for each job using the separate "jobPic" when creating or updating a job with createOrUpdateJob.
Encode the image as base64 string to pass it to the endpoint. The image is uploaded to our storage servers and scaled to needed dimensions automatically.
resolution: 2000x1300px (orientation: landscape, aspect ratio: 1 / 0.65)
file size: maximum 10 MB
file formats: jpeg, jpg, png