Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Einstellung 3: Alle Sonderthemen, die zuordenbar sind, werden initial angezeigt. Es gibt dann in der Maske den Button “alle anzeigen“, mit dem alle Sonderthemen aufgelistet werden. Alle bedeutet, die Sonderthemen mit dem passenden Rechnungsmandant, dessen End-Datum noch nicht erreicht ist.

...

Beim Öffnen des Dialogs wird für jedes Thema geprüft, ob dieses für die aktuelle Anzeige gültig ist oder nicht. Gibt es gar kein gültiges Sonderthema oder nur zuordenbare für die Kombination aus Rechnungsmandant, Belegung und Erscheintag(en), werden alle Sonderthemen aufgelistet und der Button für “alle anzeigen“ verfällt.

...

Sonderthemen können über die AdAPI angelegt, geändert, abgerufen und gesucht sowie zugeordnet werden. Dafür gibt es die folgenden Endpunkte:

Art

Aufruf

Beschreibung

Status
colourGreen
titlePOST

/specialpublications

Create new special publication

Status
colourYellow
titlePUT

/specialpublications/{number}

Update special publication by unique (NGen) number

Status
colourBlue
titleGET

/specialpublications/{number}

Get special publication by unique (NGen) number

Status
colourBlue
titleGET

/specialpublications/search

Search for special publications with given search criteria

POST/PUT/specialpublications

Mögliche Fehlermeldungen, die beim Ändern/Erstellen von Sonderthemen erscheinen können:

Meldung

Ursache

"error": "Special publication field 'billig_client' must not be empty."

Rechnungsmandant fehlt

"error": "Special publication field 'name' must not be empty."

Name des Sonderthemas fehlt

"error": "Special publication field 'assignment' must not be empty."

Belegung fehlt

"error": "Special publication field 'date' must not be empty."

 

Struktur “issues” fehlt; Datum in der Struktur “issues” fehlt

"error": "System.Collections.Generic.KeyNotFoundException in 'Execute' - The given key was not present in the dictionary."

Struktur des Aufrufs ist falsch

GET/specialpublications/search

Folgende Parameter können bei der Suche übergeben werden:

Name

Beschreibung

Beispiel

billig_client

Rechnungsmandant

z. B. “MC” oder “PEIQ”

name

Name des Sonderthemas

 

assignment

Belegung des Sonderthemas

 

category

Kategorie des Sonderthemas

z. B. Sonderseiten, Sonderbeilage

start

Startdatum des Sonderthemas

im Format YYYY-MM-DD

end

Enddatum des Sonderthemas

im Format YYYY-MM-DD

offset

Offset for retrieval of special publications since last retrieval.

 If offset is not given, the ids of the first special publications are returned.

 Every call returns an offset that must be used for the input for the next call to page.

limit

Limit for the length of the result array used for paging, default is 1. Max limit is 100.

Übergabe eines Sonderthemas bei einer Anzeige

...