verein360-enpoint.md

Verein360 Endpoint Documentation

Introduction

Verein360/BLSV should be able to send already approved entitlementcard application for their trainers. An api token that can be generated from the "Digitale Druckerei" account is required to access the endpoint. All details about the endpoint can be found in the API Documentation.

Usage

Endpoint

for testing use only the staging system: https://api.staging.entitlementcard.app for produciton use: https://api.entitlementcard.app

Authourization Header

Set the HTTP Authorization header to Bearer <api-token> to access the endpoint.

Call GraphQL Mutation to add an application

mutation addEakApplication($regionId: Int!, $application: ApplicationInput!, $project: String!) {
  result: addEakApplication(regionId: $regionId, application: $application, project: $project)
}

Sample Mutation Variables

  {
  "regionId": 2,                                      // Must be the correct region ID where the card owner lives
  "application": {
    "applicationDetails": {
      "applicationType": "FIRST_APPLICATION",         // Must be FIRST_APPLICATION
      "cardType": "BLUE",                             // Must be BLUE
      "givenInformationIsCorrectAndComplete": true,   // Must be true
      "hasAcceptedEmailUsage": true,                  // true or false
      "hasAcceptedPrivacyPolicy": true,               // Must be true
      "wantsDigitalCard": true,                       // Must be true
      "wantsPhysicalCard": false,                     // Must be false
      "blueCardEntitlement": {
        "entitlementType": "WORK_AT_ORGANIZATIONS",   // Must be WORK_AT_ORGANIZATIONS
        "workAtOrganizationsEntitlement": {
          "list": {
            "amountOfWork": 7.5,                      // Amount of hours worked per week on average
            "organization": {
              "address": {
                "country": {
                  "shortText": "Deutschland"
                },
                "houseNumber": {
                  "shortText": "123"
                },
                "location": {
                  "shortText": "München"
                },
                "postalCode": {
                  "shortText": "80331"
                },
                "street": {
                  "shortText": "Example Street"
                }
              },
              "category": {"shortText": "Sport"},     // Must be Sport
              "contact": {
                "email": {"email": "[email protected]"},
                "hasGivenPermission": true,           // Must be true
                "name": {"shortText": "Jane Doe"},
                "telephone": {"shortText": "0150123456789"}
              },
              "name": {
                "shortText": "Sportverein Augsburg-Nord"
              }
            },
            "payment": false,                         // Must be false
            "responsibility": {"shortText": "Trainer"},
            "workSinceDate": {"date": "2020-10-06"},  // ISO8601 date strings YYYY-MM-DD
            "isAlreadyVerified": true                 // Must be true, so that we can mark the application as verified. 
                                                      // If this is set to true, but not valid application token is set 
                                                      // the application is rejected and an error code returned.
          }
        }
      }
    },
    "personalData": {
      "address": {
        "country": {
          "shortText": "Deutschland"
        },
        "houseNumber": {
          "shortText": "123"
        },
        "location": {
          "shortText": "München"
        },
        "postalCode": {
          "shortText": "80331"
        },
        "street": {
          "shortText": "Example Street"
        }
      },
      "dateOfBirth": {
        "date": "1990-01-01"
      },
      "emailAddress": {
        "email": "[email protected]"
      },
      "forenames": {
        "shortText": "John"
      },
      "surname": {
        "shortText": "Doe"
      },
      "telephone": {
        "shortText": "123456789"
      }
    }
  },
  "project": "bayern.ehrenamtskarte.app"              // Must be bayern.ehrenamtskarte.app  
}

Get Region ID for application

Get all Regions

All available regions and their IDs can be obtained by calling the following graphql endpoint:

query getRegions($project: String!) {
  regions: regionsInProject(project: $project) {
    id
    prefix
    name
  }
}

Variables

{
  "project": "bayern.ehrenamtskarte.app"
}

Get Region By Postal Code

query getRegionsByPostalCode($postalCode: String!, $project: String!) {
  regions: regionsByPostalCode(postalCode: $postalCode, project: $project) {
    id
    name
    prefix
  }
}

{
  "postalCode": "86152",
  "project": "bayern.ehrenamtskarte.app"
}