Status des AV-Vertrags eines Kunden mit mittwald

GET /v1/customers/{customerNumber}/dsgvocontractstatus/

API version

v1

Request method

GET

Operation ID

getAvContractStatus

---

Liefert den Status des AV-Vertrages eines Kunden mit mittwald, falls kein Vertrag unterschrieben ist wird zusätzlich eine iFrameUrl zum Ausfüllen zurückgegeben

Request

• customerNumberinteger

  required

  Die Kundennummer

Responses

Format

application/json

Description

Der Status des AV-Vertrages ggf. mit iFrameUrl zum Ausfüllen

Schema documentation

• signedboolean

  required
• iframeUrlstring

Example

{
  "signed": true,
  "iframeUrl": "string"
}

JSON Schema

{
  "type": "object",
  "required": [
    "signed"
  ],
  "properties": {
    "signed": {
      "type": "boolean"
    },
    "iframeUrl": {
      "type": "string"
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/customers/123/dsgvocontractstatus