PORTAL und PPS Knowledge Base

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

NICHT BEARBEITET

Zusammenfassung

Webservice

REST

Objekt

JSON

Trigger

GET, POST, PUT und DELETE

Anbieter

PEIQ

Syntax

Stellenmarkt API

Die Stellenmarkt API dient zum Auslesen, zur Erstellung und zum Updaten/Löschen von Stellenanzeigen.

Produkt (Label)

portal

Übergeordnetes Modul (Label)

api, stellenanzeigen

Inhaltsverzeichnis

 Inhaltsverzeichnis anzeigen

Interne Beschreibung

Basis URL

https://yourdomain.com/api/v2/jobad/adverts

Das Portal unterscheidet bei Stellenanzeigen grundsätzlich zwischen:

  • Text Job Ad - Einer rein textbasierten Stellenanzeige

  • Link Job Ad - Einer Stellenanzeige mit einem weiterführenden Link auf externe Angebote

  • Advanced Job Ads - Einer Gestalteten Formatanzeige inkl. Überschrift und Bildern

Die static_tags “special” und “featured” sind Merkmale mit denen die Reihenfolge der Anzeigen auf einer Anzeigenübersichtsseite gesteuert werden können. Je nach Kundeneinstellung erscheint mit diesen Tags auch eine entsprechende Markierung an den Anzeigenteasern (z.B. Anbieter der Region).

Verfügbare Endpunkte für Job Ads

GET

  • Get All Job Ads by Filters

    • date_filter_type (Available values : created, updated)

    • date_start

    • date_end

    • status (Available values : notstarted, available, expired)

    • static_tags (Available Values: 'special', 'featured')

    • type (Available values : text, link, advanced)

    • location_ids

    • user_id

    • category_id

  • Get Job Ad by advert_id

    • advert_id

Response

[
  {
    "id": 1,
    "title": "Job Advert 1",
    "type": "text",
    "url": "https://www.example.com/jobs/hannover/c-handwerk/link-advert4-lorem-ipsum-dolor-sit-amet-consetetur_j75",
    "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
    "contact": {
      "phone": "+49 821 13751",
      "email": "mustermann@example.com",
      "website": "https://google.com"
    },
    "starts": "2019-03-07T00:00:00+00:00",
    "ends": "2019-03-07T00:00:00+00:00",
    "created": "2019-03-07T00:00:00+00:00",
    "updated": "2019-03-09T02:00:00+00:00",
    "static_tags": [
      "special",
      "featured"
    ],
    "category_id": 8,
    "user_id": 1,
    "default_location_id": 1,
    "location_ids": [
      1,
      2,
      3,
      4,
      5
    ],
    "thumbnail": {
      "url": "https://www.example.com/resources/mediadb/jobad/2019/03/04/1/1_XL.jpg",
      "id": "12"
    }
  }
]

POST

  • Create Advanced Job Ad

  • Create Link Job Ad

  • Create Text Job Ad

PUT

  • Update Advanced Job Ad

    • advert_id

  • Update Link Job Ad

    • advert_id

  • Update Text Job Ad

    • advert_id

DELETE

  • Delete Job Ad by advert_id

    • advert_id

Request Body

  • For Advanced Job Ad

{
  "title": "Job Advert 3",
  "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
  "contact": {
    "phone": "+49 821 13751",
    "email": "mustermann@example.com",
    "website": "https://google.com"
  },
  "created": "2019-02-01T00:00:00+00:00",
  "starts": "2019-03-01T00:00:00+00:00",
  "ends": "2019-03-07T00:00:00+00:00",
  "static_tags": [
    "special",
    "featured"
  ],
  "category_id": 1,
  "user_id": 1,
  "default_location_id": 1,
  "location_ids": [
    1,
    2
  ]
}

  • For Link Job Ad

{
  "title": "Job Advert 2",
  "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
  "url": "https://www.example.com/jobs/hannover/c-handwerk/link-advert4-lorem-ipsum-dolor-sit-amet-consetetur_j75",
  "created": "2019-02-01T00:00:00+00:00",
  "starts": "2019-03-01T00:00:00+00:00",
  "ends": "2019-03-07T00:00:00+00:00",
  "static_tags": [
    "special",
    "featured"
  ],
  "category_id": 1,
  "user_id": 1,
  "default_location_id": 1,
  "location_ids": [
    1,
    2
  ]
}

  • For Text Job Ad

{
  "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
  "created": "2019-02-01T00:00:00+00:00",
  "starts": "2019-03-01T00:00:00+00:00",
  "ends": "2019-03-07T00:00:00+00:00",
  "static_tags": [
    "special",
    "featured"
  ],
  "category_id": 1,
  "user_id": 1,
  "default_location_id": 1,
  "location_ids": [
    1,
    2
  ]
}

HTTP Status Codes

200 - Success             Alles hat wie erwartet funktioniert
201 - Job Ad Successfully created / deleted
204 - Job Ad Successfully updated
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Job Ad Not Found    Die Anzeige mit der angegebenen ID scheint nicht zu existieren

Verfügbare Endpunkte für Job Ad Categories

Kategorien werden von PEIQ während dem Setup Prozess oder während der Laufzeit eingepflegt. Sie können über diesen Endpunkt einfach ausgelesen und verwendet werden.

GET

  • Get All Job Ad Categories

  • Get Job Ad Category by category_id

    • category_id

Response

[
  {
    "id": "1",
    "name": "Dienstleistung",
    "name_norm": "dienstleistung"
  }
]

HTTP Status Codes

200 - Success             Alles hat wie erwartet funktioniert
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Job Ad Not Found    Die Anzeige mit der angegebenen ID scheint nicht zu existieren

Verfügbare Endpunkte für Job Ad Images

Dieser Endpunkt ermöglicht es Bilder an Anzeigen zu lesen oder auch hinzuzufügen (z.B. von einer externen Ressource oder aus einer Bildersammlung), zu updaten oder zu löschen. Mit dem Parameter caption kann eine Bildunterschrift vergeben werden. Der Parameter copyright befüllt die Information zum Urheber.

Former user (Deleted) gibt es was zum Bildfokus zu erklären?

GET

  • Get All Images of a specific Job Ad

    • advert_id

  • Get Job Ad Image by image_id

    • image_id

Response

[
  {
    "id": "1",
    "url_set": {
      "NATIVE": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_NATIVE.jpg",
      "T": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_T.jpg",
      "XS": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_XS.jpg",
      "S": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_S.jpg",
      "M": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_M.jpg",
      "L": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_L.jpg",
      "XL": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_XL.jpg",
      "XXL": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_XXL.jpg"
    },
    "user_id": 1,
    "created": "2019-03-07T00:00:00+00:00",
    "modified": "2019-03-07T00:00:00+00:00",
    "caption": "Test Image Caption",
    "copyright": "Test Image Copyright",
    "focus_x": "2",
    "focus_y": "3"
  }
]

POST

  • Upload Images for a specific Advanced Job Ad

    • advert_id

  • Upload Images for a specific Link Job Ad

    • advert_id

PUT

  • Update Job Ad Image Meta Data

    • image_id

DELETE

  • Delete Job Ad Image by image_id

    • image_id

Request Body

[
  {
    "url": "https://www.example.com/resources/mediadb/jobad/2019/03/04/1/1_XL.jpg",
    "user_id": 1,
    "creation_date": "2019-03-07T00:00:00+00:00",
    "caption": "Test Image Caption",
    "copyright": "Test Image Copyright",
    "focus_x": "2",
    "focus_y": "3"
  }

HTTP Status Codes

200 - Success             Alles hat wie erwartet funktioniert
201 - Job Ad Image Successfully created / deleted
204 - Job Ad Image Successfully updated
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Job Ad Image Not Found    Das Bild mit der angegebenen ID scheint nicht zu existieren

Setup & Konfiguration

Aktivierung Feature

Aufwand Technik

Als Change Request (Releaseunabhängig)

https://docs.google.com/document/d/1loSYAex--vFIdZ0OAAfcw8buiiCKFlZpdm3QpkvcIr0/edit?ts=5d9c7c36#heading=h.9blbyv4a4qgm

0,25PH

Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”

Der Zugang zur /wiki/spaces/CORE/pages/44400763 selbst ist jedoch pro Modul aktivierbar. Siehe hierfür die jeweiligen Angaben zum Setup.

 

Konfigurationsparameter

Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden.

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

Verwandte Themen

Verwandte Seiten

Filter by label

There are no items with the selected labels at this time.

Verwandte Labels

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten EXTERN

In diesem Teil werden über sogenannte Auszüge Snippets für die extern zugänglichen Dokumente und Seiten erstellt. Diese Auszüge werden vom Customer Success auf weitere Seiten kuratiert.

Neue Auszüge können über /auszug erstellt werden.

Änderungen an bereits bestehenden Auszügen dürfen nicht vorgenommen werden. Siehe hierzu die Anleitung /wiki/spaces/CORE/pages/44204087.

Allgemeine Beschreibung EXTERN

Beschreibt in wenigen Sätzen die Ziele bzw. Vorteile des Moduls / Features sowie als Stichwortliste dessen Leistungsumfang. Die Allgemeine Beschreibung ist als Einstieg für den Kunden zu verstehen und beantwortet folgende Fragen: Warum brauche ich das? Was kann das?

Details EXTERN

Externe Produktdokumentation für die Kunden (Customer Success): Inhalt der aktuell FAQ benannten Dokumente, aber nicht als Frage-Antwort, sondern einfach als Dokumentation für den (potenziellen) Kunden (ohne kritische interne Hinweise, ohne Aufwände, vor allem ohne Links auf die interne CORE-Umgebung).

Release-Notes EXTERN

Monat 202X - Zusammenfassung

Text

Monat 202X - Zusammenfassung

Text

Anleitung zum Setup EXTERN

Historie

Version Date Comment
Current Version (v. 1) 2020-09-27 08:35 Boris Braun
v. 13 2024-02-09 14:48 Kathrin Janka
v. 12 2024-02-08 14:36 Kathrin Janka
v. 11 2022-08-18 08:49 Former user
v. 10 2022-08-18 08:47 Former user
v. 9 2022-03-15 15:27 Former user
v. 8 2020-11-17 16:10 Franziska Franz
v. 7 2020-10-27 15:17 Former user
v. 6 2020-10-22 05:11 Franziska Franz
v. 5 2020-10-06 09:03 Boris Braun
v. 4 2020-10-06 09:03 Boris Braun
v. 3 2020-09-28 07:00 Boris Braun
v. 2 2020-09-28 06:52 Boris Braun
v. 1 2020-09-27 08:35 Boris Braun

  • No labels

Impressum