Skip to content

Latest commit

 

History

History
464 lines (419 loc) · 12.7 KB

restful_api.md

File metadata and controls

464 lines (419 loc) · 12.7 KB

ABSOLVENTA RESTful API

Please note that the RESTful API is deprecated. We advise customers to use our Pull API.

Data formats

Our RESTful API accepts two different XML based data formats to manage your job offers headlessly: Absolventa XML and HR-XML, which nowadays is sometimes called HR Open Standards.

Authentication

Our RESTful API uses HTTP Basic Authentication. Your account manager will hand out you an API key. Please provide it as username for HTTP Basic Authentication. Leave the password blank or fill it with a fallback letter like "X".

Endpoints

List published job offers

List all job offers that are available in our public search interface.

   
Endpoint HTTP method Response Format
/api/r/job_offers.xml GET Absolventa XML
   
Parameter Example URL Default value Minimum Maximum
page /api/r/job_offers.xml?page=10 1 1 No artificial limit
per_page /api/r/job_offers.xml?per_page=50 25 1 500

Example

curl -i -H 'Accept: application/xml' -u 28a622e8ea6665433729932112d1d9cc:X https://www.absolventa.de/api/r/job_offers.xml

List draft job offers

List all job offers that are drafts (⇔ unpublished) and therefore haven't been available to be listed in our publich search interface yet.

   
Endpoint HTTP method Response Format
/api/r/job_offers/drafts.xml GET Absolventa XML
   
Parameter Example URL Default value Minimum Maximum
page /api/r/job_offers/drafts.xml?page=10 1 1 No artificial limit
per_page /api/r/job_offers/drafts.xml?per_page=50 25 1 500

Example

curl -i -H 'Accept: application/xml' -u 28a622e8ea6665433729932112d1d9cc:X https://www.absolventa.de/api/r/job_offers/drafts.xml

List expired job offers

List all job offers that are not available to be listed in our public search interface any longer because their ended_at value refers to a date in the past.

   
Endpoint HTTP method Response Format
/api/r/job_offers/expired.xml GET Absolventa XML
   
Parameter Example URL Default value Minimum Maximum
page /api/r/job_offers/expired.xml?page=10 1 1 No artificial limit
per_page /api/r/job_offers/expired.xml?per_page=50 25 1 500

Example

curl -i -H 'Accept: application/xml' -u 28a622e8ea6665433729932112d1d9cc:X https://www.absolventa.de/api/r/job_offers/expired.xml

Create a job offer using Absolventa XML

   
Endpoint HTTP method Data Format
/api/r/job_offers.xml POST Absolventa XML

Example

curl -i -X POST https://www.absolventa.de/api/r/job_offers.xml \
     -H 'Accept: application/xml' \
     -H 'Content-Type: application/xml' \
     -u 123:X \
     -d @- << EOF
           <job_offer>
             <title>Trainee Web Development (m/w/d)</title>
             <description>
               <![CDATA[Lorem Ipsum]]>
             </description>
             <application_url>https://www.example.com/jobs/123/apply</application_url>
             <job_offer_locations type='array'>
               <job_offer_location>
                 <street>Friedrichstrasse 67</street>
                 <zip>10117</zip>
                 <city>Berlin</city>
                 <country>Deutschland</country>
               </job_offer_location>
            </job_offer_locations>
           </job_offer>
           EOF

Update a job offer using Absolventa XML

   
Endpoint HTTP method Data Format
/api/r/job_offers/{id}.xml PUT Absolventa XML

Example

curl -i -X PUT https://www.absolventa.de/api/r/job_offers/12345.xml \
     -H 'Accept: application/xml' \
     -H 'Content-Type: application/xml' \
     -u 123:X \
     -d @- << EOF
           <job_offer>
             <title>Trainee Web Development (m/w/d)</title>
             <description>
               <![CDATA[Lorem Ipsum]]>
             </description>
             <application_url>https://www.example.com/jobs/123/apply</application_url>
             <job_offer_locations type='array'>
               <job_offer_location>
                 <street>Friedrichstrasse 67</street>
                 <zip>10117</zip>
                 <city>Berlin</city>
                 <country>Deutschland</country>
               </job_offer_location>
            </job_offer_locations>
           </job_offer>
           EOF

Create a job offer using HR-XML

   
Endpoint HTTP method Data Format
/api/r/hrxml/job_offers.xml POST HR-XML

Example

curl -i -X POST https://www.absolventa.de/api/r/hrxml/job_offers.xml \
     -H 'Accept: application/xml' \
     -H 'Content-Type: application/xml' \
     -u 123:X \
     -d @- << EOF
        <PositionOpening>
           <PositionRecordInfo>
             <Id idOwner="Threepwod Ventures">
               <IdValue>42</IdValue>
             </Id>
           </PositionRecordInfo>
           <PositionPostings>
             <PositionPosting>
               <Id validFrom="2014-01-12" validTo="2015-06-12">
                 <IdValue>42</IdValue>
               </Id>
               <Link><![CDATA[http://www.example.com/jobs/1]]></Link>
             </PositionPosting>
           </PositionPostings>
           <PositionProfile>
             <PositionDateInfo></PositionDateInfo>
             <PositionDetail>
               <Company>
                 <Name>Threepwood Ventures</Name>
               </Company>
               <PhysicalLocation>
                 <PostalAddress>
                   <CountryCode>DE</CountryCode>
                   <PostalCode>10405</PostalCode>
                   <Municipality>Berlin</Municipality>
                   <DeliveryAddress>
                     <StreetName>Melee-Island-Street</StreetName>
                     <BuildingNumber>42</BuildingNumber>
                   </DeliveryAddress>
                 </PostalAddress>
               </PhysicalLocation>
               <PositionTitle><![CDATA[Trainee Web Development (m/w)]]></PositionTitle>
             </PositionDetail>
             <FormattedPositionDescription>
               <Name>Mode</Name>
               <Value>standard</Value>
             </FormattedPositionDescription>
             <FormattedPositionDescription>
               <Name>CompanyDescription</Name>
               <Value>Company description goes here!</Value>
             </FormattedPositionDescription>
             <FormattedPositionDescription>
               <Name>JobOfferPositionIds</Name>
               <Value>1</Value>
             </FormattedPositionDescription>
              <Name>JobOfferDescription</Name>
               <Value>
                 <![CDATA[Here is a nice description]]>
               </Value>
             </FormattedPositionDescription>
             <HowToApply>
               <ApplicationMethod>
                 <InternetWebAddress><![CDATA[http://example.com/jobs/1/application]]></InternetWebAddress>
               </ApplicationMethod>
             </HowToApply>
            </PositionProfile>
          </PositionOpening>
          EOF

Update a job offer using HR-XML

   
Endpoint HTTP method Data Format
/api/r/hrxml/job_offers/{id}.xml PUT HR-XML

Example

curl -i -X PUT https://www.absolventa.de/api/r/hrxml/job_offers/12345.xml \
     -H 'Accept: application/xml' \
     -H 'Content-Type: application/xml' \
     -u 123:X \
     -d @- << EOF
         <PositionOpening>
           <PositionRecordInfo>
             <Id idOwner="Threepwod Ventures">
               <IdValue>42</IdValue>
             </Id>
           </PositionRecordInfo>
           <PositionPostings>
             <PositionPosting>
               <Id validFrom="2014-01-12" validTo="2015-06-12">
                 <IdValue>42</IdValue>
               </Id>
               <Link><![CDATA[http://www.example.com/jobs/1]]></Link>
             </PositionPosting>
           </PositionPostings>
           <PositionProfile>
             <PositionDateInfo></PositionDateInfo>
             <PositionDetail>
               <Company>
                 <Name>Threepwood Ventures</Name>
               </Company>
               <PhysicalLocation>
                 <PostalAddress>
                   <CountryCode>DE</CountryCode>
                   <PostalCode>10405</PostalCode>
                   <Municipality>Berlin</Municipality>
                   <DeliveryAddress>
                     <StreetName>Melee-Island-Street</StreetName>
                     <BuildingNumber>42</BuildingNumber>
                   </DeliveryAddress>
                 </PostalAddress>
               </PhysicalLocation>
               <PositionTitle><![CDATA[Trainee Web Development (m/w)]]></PositionTitle>
             </PositionDetail>
             <FormattedPositionDescription>
               <Name>Mode</Name>
               <Value>standard</Value>
             </FormattedPositionDescription>
             <FormattedPositionDescription>
               <Name>CompanyDescription</Name>
               <Value>Company description goes here!</Value>
             </FormattedPositionDescription>
             <FormattedPositionDescription>
               <Name>JobOfferPositionIds</Name>
               <Value>1</Value>
             </FormattedPositionDescription>
              <Name>JobOfferDescription</Name>
               <Value>
                 <![CDATA[Here is a nice description]]>
               </Value>
             </FormattedPositionDescription>
             <HowToApply>
               <ApplicationMethod>
                 <InternetWebAddress><![CDATA[http://example.com/jobs/1/application]]></InternetWebAddress>
               </ApplicationMethod>
             </HowToApply>
            </PositionProfile>
          </PositionOpening>
          EOF

End a job offer

If you want to unpublish a job offer before its natural end of runtime, you can perform a PUT request to the corresponding endpoint as shown below.

   
Endpoint HTTP method Data Format
/api/r/job_offers/{id}/quit.xml PUT Absolventa XML or HR-XML

Example

curl -X PUT -H 'Accept: application/xml' \
            -H 'Content-Type: application/xml'&#x000A; \
            -u 28a622e8ea6665433729932112d1d9cc:X \
            https://www.absolventa.de/api/r/job_offers/12345/quit.xml