Skip to content

Latest commit

 

History

History
147 lines (132 loc) · 6.56 KB

tenancy_application_context.md

File metadata and controls

147 lines (132 loc) · 6.56 KB

Tenancy Application Context

Events

Events in this context are always fired for a single grem instance. The recipient header property must be set to the grem instance name in order to route the event to the customer, e.g. recipient: grem_demo1

Type GARAIO REM REM Description
TenancyApplication.Dossier.Selected ✅ ❌ A tenancy application has been selected on a tenancy application platform
TenancyApplication.Dossier.Received ✅ ❌  A tenancy application has been received on a tenancy application platform
TenancyApplication.AllDossiersProcessed ✅ ❌  All tenancy applications have been processed for the specified unit, on a tenancy application platform

TenancyApplication.Dossier.Selected

Field Type Content / Remarks
eventType string TenancyApplication.Dossier.Selected
data hash
  dossierId string Unique identifier within the tenancy application platform
  unitReference string String referencing an existing unit in the target GARAIO REM
  requestedMovingDate string ISO 8601 encoded date, eg '1980-02-17'; might be null
  applicants array list of applicants; must contain at least one applicant
    address hash address data for this applicant; might be null
      street string name of street, including the number, where appropriate
      zipCode string
      city string
      countryCode string ISO country code, eg 'CH'
    firstName string might be null
    surname string might be null
    dateOfBirth string ISO 8601 encoded date, eg '1980-02-17'; might be null
    homeTown string might be null
    jobTitle string might be null
    phoneNumber string might be null
    email string might be null
    nationalityCode string ISO country code, eg 'CH'; might be null
    language string language code eg 'DE', 'FR', 'IT' or 'EN'
    marriageStatus string Accepted statuses: unmarried, married, civil_union, divorced, widowed, separated; might be null
    salutation string Accepted salutations: none, Sir, Madam; not case sensitive

Example

{
  "eventType":"TenancyApplication.Dossier.Selected",
  "data":{
    "applicants":[
      {"address":
        {"city":"Bern",
         "countryCode":"CH",
         "street":"Gartenstr. 3",
         "zipCode":"3007"
        },
        "dateOfBirth":"1980-02-17",
        "email":"[email protected]",
        "firstName":"Max",
        "hometown":"Bern",
        "jobTitle":"Software Engineer",
        "language":"DE",
        "marriageStatus":"married",
        "nationalityCode":"CH",
        "phoneNumber":"555 123 456",
        "surname":"Muster",
        "salutation":"Sir"
      }
    ],
    "dossierId":"1111",
    "requestedMovingDate":"2019-08-01",
    "unitReference":"1234.01.0001"
  }
}

TenancyApplication.Dossier.Received

Field Type Content / Remarks
eventType string TenancyApplication.Dossier.Received
data hash
  unitReference string String referencing an existing unit in the target GARAIO REM
  dossierId string Unique identifier within the tenancy application platform
  title hash containing the title of the application in 4 languages
    de string String containing the title of the application in german
    fr string String containing the title of the application in french
    it string String containing the title of the application in italian
    en string String containing the title of the application in english
  text hash containing the text of the application in 4 languages
    de string Html string containing the text of the application in german
    fr string Html string containing the text of the application in french
    it string Html string containing the text of the application in italian
    en string Html string containing the text of the application in english
  url hash containing the url of the application for 4 languages
    de string String containing the url of the application in german
    fr string String containing the url of the application in french
    en string String containing the url of the application in english
    it string String containing the url of the application in italian

Example

{
  "eventType":"TenancyApplication.Dossier.Received",
  "data":{
    "title":
      {
        "de":"Neue Bewerbung für Gartenstrasse 1",
        "fr":"Nouveau dossier pour la Gartenstrasse 1",
        "it":"Neue Bewerbung für Gartenstrasse 1",
        "en":"New dossier for Gartenstrasse 1"
      },
      "text":
      {
        "de":"Bewerbung A<br>22.02.2020",
        "fr":"Dossier A<br>22.02.2020",
        "it":"Bewerbung A<br>22.02.2020",
        "en":"Dossier A<br>22.02.2020"
      },
      "url":
      {
        "de":"http://mieterplatform.ch/de/bewerbung/201",
        "fr":"http://mieterplatform.ch/fr/bewerbung/201",
        "it":"http://mieterplatform.ch/it/bewerbung/201",
        "en":"http://mieterplatform.ch/en/bewerbung/201"
      },
    "unitReference":"1234.01.0001",
    "dossierId":"1111"
  }
}

TenancyApplication.AllDossiersProcessed

Field Type Content / Remarks
eventType string TenancyApplication.AllDossiersProcessed
data hash
  unitReference string String referencing an existing unit in the target GARAIO REM

Example

{
  "eventType":"TenancyApplication.AllDossiersProcessed",
  "data":{
    "unitReference":"1234.01.0001"
  }
}