canTariffChange

Beschreibung

Durch diese Schnittstelle kann ermittelt werden, ob ein Vertrag eine Tarifwechsel-Option nach Tarifwechselmatrix hat.

Dazu wird die aktuelle Tarifzuweisung (TariffApplication) ermittelt und als Parameter zur Suche in der Tarifwechselmatrix genutzt. Gibt es wenigstens einen Eintrag für den aktuellen Tarif des Vertrags zu einem Zieltarif, wird ein positives Ergebnis zurückgegeben.

URL

/portal/tariff/canTariffChange

Input

POST

Singulärer Parameter (String, Vertragsnummer in MBS)

Output

// Beispiel positives Ergebnis

{
    "canChangeTariff": true,
    "earliestChangeDate": 1727733600000,
    "maxBoundaryDate": 1748728800000,
    "boundaryInMonths": 9,
    "validationResult": []
}
// Beispiel negatives Ergebnis

{
    "canChangeTariff": false,
    "earliestChangeDate": null,
    "maxBoundaryDate": null,
    "boundaryInMonths": null,
    "validationResult": []
}
// Beispiel negatives Ergebnis (Validierung fehlgeschlagen)

{
  "canChangeTariff": false,
  "earliestChangeDate": null,
  "maxBoundaryDate": null,
  "boundaryInMonths": null,
  "validationResult": [
    {
      "key": "error.canTariffChange",
      "errorMessage": "invalid parameter 'contractNumber' unknown: 4711",
      "errorLevel": "Error"
    }
  ]
}

Validierungen

Parameter Validierung Schüssel
contractNumber Parameter darf nicht leer sein error.canTariffChange.contractNumber.invalid
contractNumber Vertragsnummer muss in MBS bekannt sein error.canTariffChange.contractNumber.unknown
contractNumber Vertrag erfordert eine aktive Tarifzuweisung (TariffApplication) error.canTariffChange.contractNumber.tariffapplication.inactive
contractNumber Tarif an der Tarifzuweisung (TariffApplication) muss gesetzt sein error.canTariffChange.tariff.invalid

Hinweise

Feld ‘canChangeTariff’

Ist ein Tarifwechsel möglich, gibt die API in diesem Feld den Wert “true” zurück. “False” wird unter zwei Bedingungen zurückgegeben:

1) Der aktive Tarif des Vertrags ist nicht als Ausgangstarif in der Tarifwechselmatrix gepflegt. 2) Alle Optionen der Tarifwechselmatrix zu dem relevanten Ausgangstarif liegen nicht innerhalb der Fristen für den Tarifwechsel.

Fristen

Für jedes Paar von Tarif in der Tarifwechselmatrix sind Fristen für einen möglichen Tarifwechsel hinterlegt. Diese werden je nach Konfiguration aus dem Minimum der folgenden Daten ermittelt:

  • Anfang des nächsten Tages nach dem nächstmöglichen Kündigungsdatum
  • Anfang des nächsten Tages nach dem Sonderkündigungsdatum (wenn vorhanden und nicht in der Vergangenheit)
  • Erster Tag des nächsten Monats
  • Erster Tag des übernächsten Monats

Feld ‘earliestChangeDate’

Dieses Feld gibt das Minimum aller möglichen Wechseldaten zurück. Ein Tarifwechsel vor diesem Datum ist nicht möglich. Eventuell besitzen einige Tarifwechseloptionen ein frühestmögliches Wechseldatum, dass von diesem Minimum abweicht, d.h. später liegt.

Felder ‘maxBoundaryDate’ und ‘boundaryInMonths’

Zusätzlich zu dem frühestmöglichen Wechseldatum wird durch die Grundeinstellung TARIFF_CHANGE_MAX_MONTHS_IN_FUTURE ein maximales Datum berechnet. Alle Optionen, deren frühestes Wechseldatum nach diesem Datum liegt, werden nicht berücksichtigt.

Verfügbarkeit

MBS 145.0