Job Management

Listing Jobs
Job's detailed view
Obtaining Extra Field values

This webservice allows to obtain data relating to Job objects of a given account. It can be used to list jobs similar to Ad Manager in idibu.

A single Job object can consist of multiple Posts, where each Post indicates any single interaction between idibu and a Portal (job board, website, social media, or any other advert destination).

Creating Jobs and sending them out as Posts is handled through the Posting API or Universal Posting Pages.

Listing Jobs

This method allows to list appropriately filtered and ordered Jobs for a given account.

Endpoint

`https://ws.idibu.com/ws/rest/v1/jobs`

Available methods

`GET /all`

Returns all Jobs.

`GET /live`

Returns all currently live Jobs, with Posts still present on their respective posting destinations.

`GET /archived`

Returns Jobs that are not live anymore, with Posts either automatically expired or manually deleted from their respective posting destinations.

`GET /[n]/days-expiring`

Returns Jobs that will expire in [n] days or sooner ([n] can be negative for Jobs that have already expired up to [n] days ago).

Query parameters

Parameter Name	Type restrictions	Required?	Notes
`hash`	String	Yes	Hash of the idibu account to which the request pertains.
`count`	Integer Min: 1 Max: 100 Default: 10	No	Number of Jobs to return.
`offset`	Integer Min: 0 Default: 0	No	Numeric offset from where to start fetching Jobs (pagination).
`order`	String (enum) Default: `update-desc` Accepted values: `update-desc` - Last Posted `update-asc` - First Posted `date-desc` - Date Added (desc) `date-asc` - Date Added (asc) `title-asc` - By Title (asc) `title-desc` - By Title (desc)	No	How the Jobs should be ordered in the response. Consult this article for more info.
`job-id`	Integer Multiple allowed, comma-separated	No	Returns only Job(s) with the provided ID(s). You can also get more details using a single Job ID.
`reference`	String	No	Returns only Jobs with Reference containing the provided string.
`sender`	Integer Multiple allowed, comma-separated	No	Returns only Jobs belonging to User(s) with the provided ID(s). Refer to the User Management Webservice.
`title`	String	No	Returns only Jobs with Title containing the provided string.
`title-or-reference`	String	No	Returns only Jobs with Reference or Title containing the provided string.

Response format

<idibu generator="idibu" version="1.0">
  <response>
    <jobs>
      <job>
        <id>[integer]</id> <!-- job id -->
        <reference>[string]</reference> <!-- job reference -->
        <title>[string]</title> <!-- job title -->
        <sender> <!-- user that posted the job; refer to https://docs.idibu.com/docs/v2/webservices/user-management -->
          <id>[integer]</id> <!-- sender's profile id -->
          <firstname>[string]</firstname> <!-- sender's first name -->
          <lastname>[string]</lastname> <!-- sender's last name -->
          <email>[string:email]</email> <!-- sender's email -->
        </sender>
        <sector id="[integer]">[string]</sector> <!-- sector id and name -->
        <location id="[integer]" code="[string]">[string]</location> <!-- country id, code and name -->
        <sub_location id="[integer]">[string]</sub_location> <!-- location id and place_name -->
        <!-- For the three above, refer to https://docs.idibu.com/docs/v2/posting-api/Sector-and-locations.md -->
        <type id="[1|2|4]">[Contract|Permanent|Temporary]</type> <!-- job type -->
        <working_hours>[Full Time|Part Time]</working_hours> <!-- working hours -->
        <duration>[string]</duration> <!-- duration of the job (how long the candidate would work) -->
        <salary> <!-- salary info -->
          <minimum>[string]</minimum> <!-- minimum salary, can contain decimal points -->
          <maximum>[string]</maximum> <!-- maximum salary, can contain decimal points -->
          <currency>[string]</currency> <!-- three-letter ISO code -->
          <per>["annum"|"month"|"week"|"day"|"hour"]</per> <!-- salary period -->
          <extras>[string]</extras> <!-- additional benefits -->
          <override>[string]</override> <!-- if present, usually replaces all other salary information -->
        </salary>
        <application_url>[string:url]</application_url> <!-- external application url -->
        <creation_date>[string:date]</creation_date> <!-- job's creation date; YYYY-MM-DD HH:mm:ss -->
        <update_date>[string:date]</update_date> <!-- last posting date; YYYY-MM-DD HH:mm:ss -->
        <start_date>[string:date]</start_date> <!-- when the candidate would start working; YYYY-MM-DD HH:mm:ss -->
        <expiry_date>[string:date]</expiry_date> <!-- date the job expires or was deleted; YYYY-MM-DD HH:mm:ss -->
        <aptrack> <!-- refer to https://docs.idibu.com/docs/v2/webservices/applicant-management.md -->
          <total>[integer]</total> <!-- total applications for the job -->
          <unread>[integer]</unread> <!-- total unread applications for the job -->
        </aptrack>
        <latest_advert> <!-- data on the last advert object; refer to https://docs.idibu.com/docs/v2/webservices/advert-management.md -->
          <id>[integer]</id> <!-- advert id -->
          <creation_date>[string:date]</creation_date> <!-- advert's creation date; YYYY-MM-DD HH:mm:ss -->
        </latest_advert>
        <portals> <!-- portals to which the job was posted; refer to https://docs.idibu.com/docs/v2/webservices/portal-management -->
          <!-- job status on each portal -->
          <portal> <!-- the posting destination -->
            <id>[integer]</id> <!-- portal id -->
            <name>[string]</name> <!-- portal name -->
            <status>["live"|"expired"|"failed"|"deleted"|"pending"]</status> <!-- status on the portal -->
            <deletable>["true"|"false"]</deletable> <!-- whether the post can be deleted -->
            <pending>["true"|"false"]</pending> <!-- whether there are pending posts on the portal -->
            <error>["true"|"false"]</error> <!-- whether the last posting attempt resulted in error -->
            <warning>["true"|"false"]</warning> <!-- whether the last posting attempt had warnings -->
            <expiry>[string:date]</expiry> <!-- current expiry or deletion date on the portal; YYYY-MM-DD HH:mm:ss -->
            <last_update>[string:date]</last_update> <!-- date of last posting on the portal; YYYY-MM-DD HH:mm:ss -->
            <last_posting_id>[integer]</last_posting_id> <!-- last posting (PostLog) id -->
            <applicants>[integer]</applicants> <!-- applicant count on the portal -->
          </portal>
        </portals>
      </job>
    </jobs>
    <total>[integer]</total> <!-- total number of jobs matching the current criteria (excluding count and offset) -->
  </response>
  <status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>

Job's detailed view

This method allows to obtain more detailed information about a particular Job. The response format is the same as for Listing Jobs, but description and a list of postings are added.

Endpoint

`https://ws.idibu.com/ws/rest/v1/jobs`

Available methods

`GET /[id]`

Returns the detailed view of the Job with the provided [id].

Query parameters

Parameter Name	Type restrictions	Required?	Notes
`hash`	String	Yes	Hash of the idibu account to which the request pertains.

Response format

<idibu generator="idibu" version="1.0">
  <response>
    <job>
      <id>[integer]</id> <!-- job id -->
      <reference>[string]</reference> <!-- job reference -->
      <title>[string]</title> <!-- job title -->
      <description>[string]</description><!-- job description -->
      <sender> <!-- user that posted the job; refer to https://docs.idibu.com/docs/v2/webservices/user-management -->
        <id>[integer]</id> <!-- sender's profile id -->
        <firstname>[string]</firstname> <!-- sender's first name -->
        <lastname>[string]</lastname> <!-- sender's last name -->
        <email>[string:email]</email> <!-- sender's email -->
      </sender>
      <sector id="[integer]">[string]</sector> <!-- sector id and name -->
      <location id="[integer]" code="[string]">[string]</location> <!-- country id, code and name -->
      <sub_location id="[integer]">[string]</sub_location> <!-- location id and place_name -->
      <!-- for the three above, refer to https://docs.idibu.com/docs/v2/posting-api/Sector-and-locations.md -->
      <type id="[1|2|4]">[Contract|Permanent|Temporary]</type> <!-- job type -->
      <working_hours>[Full Time|Part Time]</working_hours> <!-- working hours -->
      <duration>[string]</duration> <!-- duration of the job (how long the candidate would work) -->
      <salary> <!-- salary info -->
        <minimum>[string]</minimum> <!-- minimum salary, can contain decimal points -->
        <maximum>[string]</maximum> <!-- maximum salary, can contain decimal points -->
        <currency>[string]</currency> <!-- three-letter ISO code -->
        <per>["annum"|"month"|"week"|"day"|"hour"]</per> <!-- salary period -->
        <extras>[string]</extras> <!-- additional benefits -->
        <override>[string]</override> <!-- if present, usually replaces all other salary information -->
      </salary>
      <application_url>[string:url]</application_url> <!-- external application url -->
      <creation_date>[string:date]</creation_date> <!-- job's creation date; YYYY-MM-DD HH:mm:ss -->
      <update_date>[string:date]</update_date> <!-- last posting date; YYYY-MM-DD HH:mm:ss -->
      <start_date>[string:date]</start_date> <!-- when the candidate would start working; YYYY-MM-DD HH:mm:ss -->
      <expiry_date>[string:date]</expiry_date> <!-- date the job expires or was deleted; YYYY-MM-DD HH:mm:ss -->
      <aptrack> <!-- refer to https://docs.idibu.com/docs/v2/webservices/applicant-management.md -->
        <total>[integer]</total> <!-- total applications for the job -->
        <unread>[integer]</unread> <!-- total unread applications for the job -->
      </aptrack>
       <latest_advert> <!-- data on the last advert object; refer to https://docs.idibu.com/docs/v2/webservices/advert-management.md -->
          <id>[integer]</id> <!-- advert id -->
          <creation_date>[string:date]</creation_date> <!-- advert's creation date; YYYY-MM-DD HH:mm:ss -->
        </latest_advert>
      <portals> <!-- portals to which the job was posted; refer to https://docs.idibu.com/docs/v2/webservices/portal-management -->
        <!-- job status on each portal -->
        <portal> <!-- the posting destination -->
          <id>[integer]</id> <!-- portal id -->
          <name>[string]</name> <!-- portal name -->
          <status>["live"|"expired"|"failed"|"deleted"|"pending"]</status> <!-- status on the portal -->
          <deletable>["true"|"false"]</deletable> <!-- whether the post can be deleted -->
          <pending>["true"|"false"]</pending> <!-- whether there are pending posts on the portal -->
          <error>["true"|"false"]</error> <!-- whether the last posting attempt resulted in error -->
          <warning>["true"|"false"]</warning> <!-- whether the last posting attempt had warnings -->
          <expiry>[string:date]</expiry> <!-- current expiry or deletion date on the portal; YYYY-MM-DD HH:mm:ss -->
          <last_update>[string:date]</last_update> <!-- date of last posting on the portal; YYYY-MM-DD HH:mm:ss -->
          <last_posting_id>[integer]</last_posting_id> <!-- last posting (PostLog) id -->
          <applicants>[integer]</applicants> <!-- applicant count on the portal -->
        </portal>
      </portals>
      <postings>
        <!-- detailed list of postings (PostLogs) -->
        <posting>
          <id>[integer]</id> <!-- PostLog id -->
          <portal>[integer]</portal> <!-- portal id -->
          <start_post>[string:date]</start_post> <!-- posting date; YYYY-MM-DD HH:mm:ss -->
          <stop_post>[string:date]</stop_post> <!-- intended expiry date; YYYY-MM-DD HH:mm:ss -->
          <status>["posted"|"updated"|"deleted"|"failed"]</status> <!-- posting status -->
          <link>[string:url]</link> <!-- URL of the posting on the portal (if supported by the portal) -->
        </posting>
      </postings>
    </job>
  </response>
  <status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>

Obtaining Extra Field values

This method allows to obain all previously-set Extra Field values for a given Job. The values can then be pre-populated, for example when reposting the Job in the external system.

Endpoint

`https://ws.idibu.com/ws/rest/v1/values`

Available methods

`GET /[job-id]`

Returns the most recent Extra Field values for the provided [job-id], for all the Portals to which the Job was posted.

Query parameters

Parameter Name	Type restrictions	Required?	Notes
`hash`	String	Yes	Hash of the idibu account to which the request pertains.

Response format

<idibu generator="idibu" version="1.0">
  <response>
    <portals> <!-- portals to which the job was posted; refer to https://docs.idibu.com/docs/v2/webservices/portal-management -->
      <portal id="[integer]"> <!-- portal id -->
        <values>
          <value name="[string]">[string]</value> <!-- the 'name' attribute indicates the name of the extra field; the content of the element indicates its latest value -->
        </values>
      </portal>
    </portals>
  </response>
  <status>["success"|"failed"]</status> <!-- whether the request succeeded or not -->
</idibu>

Listing Jobs​

Endpoint​

https://ws.idibu.com/ws/rest/v1/jobs​

Available methods​

GET /all​

GET /live​

GET /archived​

GET /[n]/days-expiring​

Query parameters​

Response format​

Job's detailed view​

Endpoint​

https://ws.idibu.com/ws/rest/v1/jobs​

Available methods​

GET /[id]​

Query parameters​

Response format​

Obtaining Extra Field values​

Endpoint​

https://ws.idibu.com/ws/rest/v1/values​

Available methods​

GET /[job-id]​

Query parameters​

Response format​

Listing Jobs

Endpoint

`https://ws.idibu.com/ws/rest/v1/jobs`

Available methods

`GET /all`

`GET /live`

`GET /archived`

`GET /[n]/days-expiring`

Query parameters

Response format

Job's detailed view

Endpoint

`https://ws.idibu.com/ws/rest/v1/jobs`

Available methods

`GET /[id]`

Query parameters

Response format

Obtaining Extra Field values

Endpoint

`https://ws.idibu.com/ws/rest/v1/values`

Available methods

`GET /[job-id]`

Query parameters

Response format