Express Connect
Dokumentation för API-funktioner

Prenumerationer kan sättas upp för information som förändras i Vitec via Office-produkterna, Express eller Connect. När information förändras så kontrollerar Vitec vilka prenumerationer som berörs. Om det finns prenumerationer som matchar förändringarna så skickas notifieringar ut för berörda prenumerationerna.

Den URL som notifieras ska returnera HTTP statuskod i 200 serien. Svarar ni inte omgående så kommer vi att anta att ni svarat med 200 OK.

Manuell notifikation

Innan Vitec aktiverar prenumerationen så kan ni prova att manuellt skapa en notifiering via Vitec Connect notifikationstest

Prenumeration

En prenumeration beskriver kriterier över vilka förändringar som ska trigga notifieringar.

De prenumerationsobjekt som ni kan prenumerera på är följande:

  • Estate - Bostad
    • House - Villa
    • Cottage - Fritidshus
    • HousingCooperative - Bostadsrätt
    • Plot - Tomt
    • Condominium - Ägarlägenhet
    • Farm - Lantbruk
    • ForeignProperty - Utlandsbostad
    • CommercialProperty - Kommersiellt objekt
    • Premises - Lokal
  • Project - Projekt
  • User - Användare
  • Office - Kontor
  • Contact - Kontakt
    • Person - Person
    • Company - Företag
    • Estate - Dödsbo
    • Association - Förening
  • EstateContact - Relationen mellan en bostad och en kontakt
    • EstateContactBuyer - Köpare
    • EstateContactSeller - Säljare
    • EstateContactSpeculator - Spekulanter
  • OfficeEstateAgent - Relationen mellan ett kontor och en användare
    • Affiliation - Tillhörighet
  • Meeting - Mötesbokning
  • Note - Notering
  • Area - Område

De händelser som kan anges är uppdateringar, raderingar eller båda.

  • Update - Uppdatering
  • Remove - Radering

Förutom ovan så finns det kriterier som är beroende på vilken typ av information som berörs.

För bostäder och projekt så går det att specificera om notifieringen endast gäller bostäder och projekt som annonseras på hemsida och vilken typ av status som bostaden eller projektet ska ha.

För kontakter går det att ange vilken typ av kontakt som avses (Personer, företag och/eller dödsbo).

För relationer mellan bostäder och kontakter går det att ange vilken typ av relation som avses (köpare, säljare och/eller intressenter).

För att skapa en prenumeration, kontakta Vitec så sätter vi upp en prenumeration åt er.

Format på notifikationer som berör Agent, Office, Estate, Project och Contact

Parametrarna kommer både med som url parametrar och som POST data i JSON format. Undantaget är data parametern som endast skickas med i POST datat.

  • name: Namnet på prenumerationen
  • type: Agent, Office, Estate, Project, Contact
  • id: Id på användaren, kontoret, bostaden, projektet eller kontakten
  • event: Update, Remove
  • customerId: Id på det kontoret som ändringen tillhör

Extra parametrar om typen är Estate:

  • subType: House, HousingCooperative, Cottage, Plot
  • data.status: Status på bostaden

Möjliga värden på bostadsstatus:

  • AssignmentAttempt - Intagsförsök
  • AssignmentAccepted - Intaget
  • ForSale - Till salu
  • Sold - Såld
  • Paused - Vilande
  • NoAssignment - Inget uppdrag
  • AssignmentWithdrawn - Återtagen
  • ReservedNotForSale - Reserverad/Ej till salu
  • NotForSale - Ej till salu
  • SoldReferenceObject - Såld/Referensobjekt
  • Coming - Kommande
  • SoonForSale - Snart till salu
  • PreSale - Försprång (Mellan kommande och till salu)
  • ReadyForRent - Hyresledig
  • TentativelyRented - Uthyrd preliminärt
  • Rented - Uthyrd
  • AppointedAdmission - Tillträdd

Extra parametrar om typen är Project:

  • data.status: Status på projektet

Möjliga värden på projektstatus:

  • Paused - Vilande
  • Ongoing - Pågående
  • SoldOut - Slutsålt
  • Upcoming - Kommande

Extra parametrar om typen är Contact:

  • subType: Person, Company, Estate, Association
Exempel på notifiering för en förändring på en användare

http://connect.maklare.vitec.net/Reciever/?name=prenumerationsnamn&type=User&event=Update&customerId=M11385&id=HANE99C53F2DE4F489AB1E464D0F9AFFACD

POST data:
{
  "name": "prenumerationsnamn",
  "type": "User",
  "event": "Update",
  "customerId": "M11385",
  "id": "HANE99C53F2DE4F489AB1E464D0F9AFFACD"
}

Exempel på notifiering för en förändring på en bostadsrätt med status till salu

http://connect.maklare.vitec.net/Reciever/?name=prenumerationsnamn&type=Estate&event=Update&customerId=M11385&id=OBJ11385_1395932274&subtype=HousingCooperative

POST data:
{
  "name": "prenumerationsnamn",
  "type": "Estate",
  "event": "Update",
  "customerId": "M11385",
  "id": "OBJ11385_1395932274",
  "subtype": "HousingCooperative",
  "data": {
    "status": "ForSale"
  }
}

Format på notifikationer som berör EstateContact och OfficeEstateAgent

Parametrarna kommer både med som url parametrar och som POST data i JSON format. Undantaget är data parametern som endast skickas med i POST datat.

  • name: Namnet på prenumerationen
  • type: EstateContact, OfficeEstateAgent
  • event: Update, Remove
  • customerId: Id på det kontoret som ändringen tillhör

Om typen är EstateContact så skickas även följande med:

  • subType: EstateContactBuyer, EstateContactSeller, EstateContactSpeculator
  • relId1: Id på bostaden
  • relType1: Bostadens typ
  • relId2: Id på kontakten
  • relType2: Kontaktens typ

Om typen är OfficeEstateAgent så skickas även följande med:

  • subType: Affiliation
  • relId1: Id på användaren
  • relType1: User
  • relId2: CustomerId för kontoret, exempel M20005
  • relType2: Office
Exempel på notifiering för en förändring där en säljare tillkommer på en bostad

http://connect.maklare.vitec.net/Reciever/?name=prenumerationsnamn&type=EstateContact&event=Update&customerId=M11385&subType=EstateContactSeller&relId1=OBJ11385_1395932274&relType1=HousingCooperative&relId2=ADRB1173057ECD04D66B9D798812E09C1B5&relType2=Estate

POST data:
{
  "name": "prenumerationsnamn",
  "type": "EstateContact",
  "event": "Update",
  "customerId": "M11385",
  "subType": "EstateContactSeller",
  "relId1": "OBJ11385_1395932274",
  "relType1": "HousingCooperative",
  "relId2": "ADRB1173057ECD04D66B9D798812E09C1B5",
  "relType2": "Estate"
}

Exempel på notifiering för en förändring där en mäklare har fått en ny tillhörighet till ett kontor

http://connect.maklare.vitec.net/Reciever/?name=prenumerationsnamn&type=OfficeEstateAgent&event=Update&customerId=M11385&subType=Affiliation&relId1=HANE99C53F2DE4F489AB1E464D0F9AFFACD&relType1=User&relId2=M11385&relType2=Office

POST data:
{
  "name": "prenumerationsnamn",
  "type": "OfficeEstateAgent",
  "event": "Update",
  "customerId": "M11385",
  "subType": "Affiliation",
  "relId1": "HANE99C53F2DE4F489AB1E464D0F9AFFACD",
  "relType1": "User",
  "relId2": "M11385",
  "relType2": "Office"
}

Format på notifikationer som berör Meeting och Note

Parametrarna kommer både med som url parametrar och som POST data i JSON format. Undantaget är data parametern som endast skickas med i POST datat.

  • name: Namnet på prenumerationen
  • id: Id på mötesbokningen eller noteringen
  • type: Meeting, Note
  • event: Update, Remove
  • customerId: Id på det kontoret som ändringen tillhör
  • relId1: Id på bostaden
  • relType1: Bostadens typ
  • relId2: Id på kontakten
  • relType2: Kontaktens typ
Exempel på notifiering för en förändring där en ny mötebokning läggs till

http://connect.maklare.vitec.net/Reciever/?name=prenumerationsnamn&type=Meeting&event=Update&customerId=M11385&id=CAL7216862FF0AD4AE38061A04A9AC4D60D&relId1=OBJ11385_1395932274&relType1=HousingCooperative&relId2=ADRB1173057ECD04D66B9D798812E09C1B5&relType2=Estate

POST data:
{
  "name": "prenumerationsnamn",
  "type": "Meeting",
  "event": "Update",
  "customerId": "M11385",
  "id": "CAL7216862FF0AD4AE38061A04A9AC4D60D",
  "subType": "EstateContactSeller",
  "relId1": "OBJ11385_1395932274",
  "relType1": "HousingCooperative",
  "relId2": "ADR3ADC7B7B0A9447CA97FCAB43E36B582C",
  "relType2": "Person"
}

Format på notifikationer som berör visningsdeltagare

Parametrarna kommer både med som url parametrar och som POST data i JSON format.

  • name: Namnet på prenumerationen
  • type: EstateContact
  • event: Update, Remove
  • customerId: Id på det kontoret som ändringen tillhör
  • subType: ViewingParticipant
  • relId1: Id på bostaden
  • relType1: Bostadens typ
  • relId2: Id på kontakten
  • relType2: Kontaktens typ
  • relId3: Id på visningen
  • relType3: Viewing
Exempel på notifiering för en förändring där en ny visningsdeltagare läggs till

http://connect.maklare.vitec.net/Reciever/?name=prenumerationsnamn&type=EstateContact&event=Update&customerId=M11385&subType=ViewingParticipant&relId1=OBJ11385_1395932274&relType1=HousingCooperative&relId2=ADRB1173057ECD04D66B9D798812E09C1B5&relType2=Estate&relId3=VISF20A42E75479481A98E2D55322305353&relType3=Viewing

POST data:
{
  "name": "prenumerationsnamn",
  "type": "EstateContact",
  "event": "Update",
  "customerId": "M11385",
  "subType": "ViewingParticipant",
  "relId1": "OBJ11385_1395932274",
  "relType1": "HousingCooperative",
  "relId2": "ADRB1DEE2F28780457D9D9791F5E3C3C2A1",
  "relType2": "Person",
  "relId3": "VISF20A42E75479481A98E2D55322305353",
  "relType3": "Viewing"
}

Format på notifikationer som berör sammanslagningar

Parametrarna kommer både med som url parametrar och som POST data i JSON format. Undantag är destinationId och sourceIds som enbart finns i POST data.

  • name: Namnet på prenumerationen
  • type: Merge
  • event: Merge
  • customerId: Id på det kontoret som ändringen tillhör
  • subType: Person
  • id: Id på målet med sammanslagningen
  • destinationId: Id på målet med sammanslagningen
  • sourceIds: Array med id på sammanslagna källor, dessa kommer att vara raderade och ersatta med destinationId
Exempel på notifiering för en sammanslagning för kontakt

http://connect.maklare.vitec.net/Reciever/?name=prenumerationsnamn&type=Merge&event=Merge&customerId=M11385&subType=Person&id=ADR8462BF8CEC9D4A3D875A7B4449997B00

POST data:
{
  "name": "prenumerationsnamn",
  "id": "ADR8462BF8CEC9D4A3D875A7B4449997B00",
  "type": "Merge",
  "event": "Merge",
  "customerId": "M11385",
  "subType": "Person",
  "destinationId": "ADR8462BF8CEC9D4A3D875A7B4449997B00",
  "sourceIds": ["ADRAC382A6314634AEB9ECC72A284B0DE09"]
}