Vitec Enum Mappings
This document provides mappings for all integer enum values used in the Vitec API.
Note: Enum values should be verified against the latest Vitec Swagger documentation at: https://hub.megler.vitec.net/swagger/
Estate Enums
brokerRole (BrokerWithRole)
The role of a broker/agent on an estate listing.
| Value | Label | Description |
|---|---|---|
| 1 | MainBroker | Primary/lead broker |
| 2 | ResponsibleBroker | Responsible broker |
| 3 | Assistant | Assistant broker |
| 4 | ResponsibleSettlement | Responsible for settlement |
| 5 | SecondaryAssistant | Secondary assistant |
Maps to: BrokerWithRole.BrokerRole
Swagger Reference: See Vitec API /Estates/{estateId} endpoint, field brokersIdWithRoles[].brokerRole
estateBaseType
The base type/category of the property (Grunntype).
| Value | Label | Description |
|---|---|---|
| 0 | NotSet | Not set/undefined |
| 1 | Detached | Residential property |
| 2 | Leisure | Leisure/vacation property |
| 3 | Business | Commercial/business property |
| 4 | Project | New construction project |
| 5 | Plot | Land/plot |
| -1 | Unknown | Unknown type |
Maps to: Estate.EstateBaseType
Swagger Reference: See Vitec API /Estates endpoint, field estateBaseType
assignmentTypeGroup
Assignment category grouping (Oppdragskategorigruppe).
| Value | Label | Description |
|---|---|---|
| 0 | NotSet | Not set |
| 1 | Sale | Property sale |
| 2 | Rent | Property rental |
| 3 | Valuation | Valuation/appraisal |
| 4 | Settlement | Settlement |
| 5 | ForeClosure | Foreclosure |
| 6 | CommercialArea | Commercial area |
| 7 | ProjectSale | New construction project sale |
| 8 | CommercialSale | Commercial property sale |
| 9 | CommercialRent | Commercial property rental |
| 10 | Administration | Property administration |
Maps to: Estate.AssignmentTypeGroup
Swagger Reference: See Vitec API /Estates endpoint, field assignmentTypeGroup
ownership (OwnershipType)
The type of property ownership (Eierform).
| Value | Label | Description |
|---|---|---|
| 0 | Owned | Full ownership (freehold) |
| 1 | Cooperative | Housing cooperative (you own shares) |
| 2 | Stock | Share apartment |
| 3 | Bond | Bond apartment |
| 4 | Condominium | Condominium (sectioned ownership) |
Maps to: Estate.Ownership
Swagger Reference: See Vitec API /Estates endpoint, field ownership
status (Estate Status)
The current listing status of the property (Oppdragsstatus).
| Value | Label | Description |
|---|---|---|
| 0 | Request | Initial inquiry/request |
| 1 | Preparation | Preparing for listing |
| 2 | ForSale | Actively for sale |
| 3 | Sold | Property sold |
| 4 | Reserved | Reserved/under contract |
| 5 | Archived | Archived |
| 6 | Expired | Listing expired |
| 7 | Terminated | Terminated/withdrawn |
Maps to: Estate.Status
Swagger Reference: See Vitec API /Estates endpoint, field status
facilities
Property facilities/amenities (stored as List
| Value | Label | Norwegian | Description |
|---|---|---|---|
| 1 | Lift | Heis | Elevator/lift |
| 2 | Garage | Garasje | Garage parking |
| 3 | Veranda | Veranda | Veranda/balcony |
Maps to: Estate.Facilities (List
Swagger Reference: See Vitec API /Estates/{estateId} endpoint, field facilities[]
Employee Enums
employeePositions.type (EmployeePosition)
Employee position/role type.
| Value | Label | Description |
|---|---|---|
| 0 | Unknown | Unknown position |
| 1 | Realtor | Real estate agent/broker |
| 2 | ManagingDirector | Managing director |
| 3 | SubjectMatterComplianceManager | Subject matter compliance manager |
| 4 | AntiMoneyLaunderingManager | Anti-money laundering manager |
| 5 | Assistant | Assistant |
| 6 | SettlementEmployee | Settlement employee |
| 7 | Administration | Administration |
| 8 | RealEstateAttorney | Real estate attorney |
| 9 | SalesManager | Sales manager |
| 10 | OfficeManager | Office manager |
Maps to: EmployeePosition.Type
Swagger Reference: See Vitec API /Employees endpoint, field employees[].employeePositions[].type
Project Enums
project.status (Project Status)
Housing project status.
| Value | Label | Description |
|---|---|---|
| 0 | Request | Initial inquiry/request |
| 1 | Preparation | Preparing for listing |
| 2 | ForSale | Actively for sale |
| 3 | Sold | Project sold |
| 4 | Reserved | Reserved/under contract |
| 5 | Archived | Archived |
| 6 | Expired | Listing expired |
| 7 | Terminated | Terminated/withdrawn |
Maps to: Project.Status
Swagger Reference: See Vitec API /Estates/{estateId}/Project endpoint, field project.status
currentProjectPhase (ProjectLifecycleStatus)
Current phase of the housing project lifecycle.
| Value | Label | Description |
|---|---|---|
| 0 | Planning | Planning/design phase |
| 1 | SaleStart | Sales phase started |
| 2 | BuildStart | Construction phase started |
| 3 | MovingIn | Completion/handover phase |
Maps to: ProjectLifecycleStatus.CurrentPhase
Swagger Reference: See Vitec API /Estates/{estateId}/Project endpoint, field project.currentProjectPhase
Shared Class Enums
energyLetter (Energy Rating)
The energy efficiency rating letter (A-G scale) - Energibokstav.
| Value | Label | Description |
|---|---|---|
| 1 | A | Highest efficiency (best) |
| 2 | B | High efficiency |
| 3 | C | Good efficiency |
| 4 | D | Average efficiency |
| 5 | E | Below average |
| 6 | F | Low efficiency |
| 7 | G | Very low efficiency (worst) |
Maps to: EnergyRating.EnergyLetter
Swagger Reference: See Vitec API /Estates/{estateId} endpoint, field energyLetter
Notes: Note that value 0 does not exist; ratings start at 1 for 'A'
energyColorCode (Energy Rating Color)
The color code associated with the energy rating (Energifargekode/Oppvarmingskarakter).
| Value | Label | Description |
|---|---|---|
| 1 | Green | Best efficiency (dark green) |
| 2 | LightGreen | Good efficiency (light green) |
| 3 | Yellow | Average efficiency |
| 4 | Orange | Below average |
| 5 | Red | Low efficiency |
| -1 | Unknown | Unknown/not rated |
Maps to: EnergyRating.EnergyColorCode
Swagger Reference: See Vitec API /Estates/{estateId} endpoint, field energyColorCode
Notes: - Corresponds roughly to energy letter ranges - Green (1) = A-B, LightGreen (2) = C, Yellow (3) = D, Orange (4) = E, Red (5) = F-G
coOwnershipType (Matrikkel)
Co-ownership type in cadastral records.
| Value | Label | Description |
|---|---|---|
| 0 | Unknown | Unknown co-ownership type |
| 1 | None | No co-ownership |
| 2 | JointOwnership | Joint ownership |
| 3 | FarmCommons | Farm commons |
Maps to: Matrikkel.CoOwnershipType
Swagger Reference: See Vitec API /Estates/{estateId} endpoint, field matrikkel[].coOwnershipType
showingType (Showing)
Type of property viewing/showing.
| Value | Label | Description |
|---|---|---|
| 0 | Showing | Regular/open showing |
| 1 | PrivateShowing | Private viewing by appointment |
Maps to: Showing.Type
Swagger Reference: See Vitec API /Estates/{estateId}/Showings endpoint, field showings[].showingType
linkType (PropertyLink)
Type of external link.
| Value | Label | Description |
|---|---|---|
| 0 | Other | Other link type |
| 1 | Video | Video tour (YouTube, Vimeo) |
| 2 | Vr3d | 360° virtual tour (VR/3D) |
| 3 | Homepage | Homepage/website link |
Maps to: PropertyLink.Type
Swagger Reference: See Vitec API /Estates/{estateId}/GetEstatesLinks endpoint, field links[].linkType
docType (PropertyDocument)
Document type/category.
| Value | Label | Description |
|---|---|---|
| 1 | SelfDeclaration | Self declaration |
| 2 | Shareholders | Shareholders information |
| 3 | AdDraft | Advertisement draft |
| 5 | PropertyInformation | Property information |
| 6 | BidForm | Bid form |
| 7 | Various | Various documents |
| 9 | PropertyProfile | Property profile |
| 10 | PropertyValuation | Property valuation |
| 11 | EnergyCertificate | Energy certificate |
| 12 | EmailReceived | Email received |
| 13 | EmailSent | Email sent |
| 14 | ElectronicValuation | Electronic valuation |
| 15 | Invoice | Invoice |
| 16 | CompletionCertificate | Completion certificate |
| 17 | PlotContract | Plot contract |
| 18 | CompanyCertificate | Company certificate |
| 19 | Financinginformation | Financing information |
| 20 | PreemptiveInformation | Preemptive information |
| 21 | ListingAgreementRenewal | Listing agreement renewal |
| 22 | Authorization | Authorization |
| 23 | Warranties | Warranties |
| 24 | LandregistryTranscript | Land registry transcript |
| 25 | LandownerInformation | Landowner information |
| 26 | OwnerChange | Owner change |
| 27 | Contract | Contract |
| 28 | MunicipalInformation | Municipal information |
| 29 | ConcessionForm | Concession form |
| 31 | ValuationTax | Valuation tax |
| 32 | ListingAgreement | Listing agreement |
| 33 | Settlement | Settlement |
| 34 | SettlementForm | Settlement form |
| 35 | AcquisitionProtocol | Acquisition protocol |
| 36 | LienOther | Lien (other) |
| 37 | Lien | Lien |
| 38 | LienRevokedConfirmation | Lien revoked confirmation |
| 39 | LienLock | Lien lock |
| 40 | ZoningplanMap | Zoning plan map |
| 41 | Floorplan | Floor plan |
| 42 | RemainingDebt | Remaining debt |
| 43 | PropertyDescription | Property description |
| 44 | PropertyDescriptionDraft | Property description draft |
| 45 | SectioningRequest | Sectioning request |
| 46 | Easement | Easement |
| 47 | Deed | Deed |
| 48 | BoardApproval | Board approval |
| 49 | Drawing | Drawing |
| 50 | SupplementaryAgreement | Supplementary agreement |
| 51 | Transport | Transport |
| 52 | Statute | Statute |
| 53 | OpenHouseList | Open house list |
| 54 | AuthorizationBuyer | Authorization (buyer) |
| 55 | SettlementBuyer | Settlement (buyer) |
| 56 | BrokerValuation | Broker valuation |
| 57 | AcceptanceLetterBuyer | Acceptance letter (buyer) |
| 58 | AcceptanceLetterSeller | Acceptance letter (seller) |
| 59 | Lease | Lease |
| 60 | InsuranceSeller | Insurance (seller) |
| 61 | InsuranceBuyer | Insurance (buyer) |
| 62 | Pricelist | Price list |
| 63 | Declaration | Declaration |
| 64 | CoverLetter | Cover letter |
| 65 | SettlementLineupSeller | Settlement lineup (seller) |
| 66 | SettlementLineupBuyer | Settlement lineup (buyer) |
| 67 | ProAndContraScheme | Pro and contra scheme |
| 69 | AccountingInformation | Accounting information |
| 70 | Requisition | Requisition |
| 71 | Offer | Offer |
| 72 | InterestReport | Interest report |
| 73 | LienBuyer | Lien (buyer) |
| 74 | PrerequisiteLetterBank | Prerequisite letter (bank) |
| 75 | ContractAttachment | Contract attachment |
| 76 | PropertyDescriptionAttachment | Property description attachment |
| 77 | MoneyLaunderingDocument | Money laundering document |
| 78 | CompanyDocument | Company document |
| 79 | ShareDocument | Share document |
| 80 | Will | Will |
| 81 | MutualWill | Mutual will |
| 82 | GrantOfProbate | Grant of probate |
| 83 | EstateAuthorization | Estate authorization |
| 84 | DocumentFeeRationale | Document fee rationale |
| 85 | BidJournal | Bid journal |
| 86 | BidAttachment | Bid attachment |
| 88 | ConfirmedLandregistryTranscript | Confirmed land registry transcript |
| 89 | ConsentFromLessor | Consent from lessor |
| 90 | ConsentFromRightsHolderToEncumbrance | Consent from rights holder to encumbrance |
| 91 | HouseRules | House rules |
| 92 | BuildingDrawings | Building drawings |
| 93 | DeliveryDescription | Delivery description |
| 94 | SettlementFormSeller | Settlement form (seller) |
| 95 | SettlementFormBuyer | Settlement form (buyer) |
| 96 | ConditionReportArchive | Condition report archive |
| 97 | SignedPurchaseContract | Signed purchase contract |
| 1000 | PropertyDescriptionDocuments | Property description documents |
Maps to: PropertyDocument.Type
Swagger Reference: See Vitec API /Estates/{estateId}/Documents endpoint, field documents[].docType
Implementation Examples
Option 1: C# Enums
public enum VitecEstateStatus
{
Request = 0,
Preparation = 1,
ForSale = 2,
Sold = 3,
Reserved = 4,
Archived = 5,
Expired = 6,
Terminated = 7
}
// Usage:
var statusLabel = ((VitecEstateStatus)estate.Status).ToString();
Option 2: Lookup Dictionary
public static class VitecEnumLabels
{
public static readonly Dictionary<int, string> EstateStatus = new()
{
{ 0, "Request" },
{ 1, "Preparation" },
{ 2, "For Sale" },
{ 3, "Sold" },
{ 4, "Reserved" },
{ 5, "Archived" },
{ 6, "Expired" },
{ 7, "Terminated" }
};
public static string GetStatusLabel(int status)
=> EstateStatus.TryGetValue(status, out var label) ? label : "Unknown";
}
Option 3: Database Table
CREATE TABLE VitecEnumMappings (
EnumType VARCHAR(50) NOT NULL,
EnumValue INT NOT NULL,
LabelEnglish VARCHAR(100),
Description VARCHAR(500),
PRIMARY KEY (EnumType, EnumValue)
);
-- Example inserts:
INSERT INTO VitecEnumMappings VALUES
('EstateStatus', 0, 'Request', 'Initial inquiry/request'),
('EstateStatus', 1, 'Preparation', 'Preparing for listing');
How to Populate This Document
- Access Vitec Swagger: Go to https://hub.megler.vitec.net/swagger/
- Find the Endpoint: Navigate to the relevant API endpoint (e.g.,
/Estates,/Estates/{estateId}) - Locate the Enum Field: Find the enum field in the request/response schema
- Check the Description: Vitec Swagger should list the enum values and their meanings
- Update This Document: Add or update enum entries with actual values and descriptions
Testing
When testing enum mappings:
- Verify in Vitec Test Environment: Check actual API responses
- Test Edge Cases: Unknown enum values (e.g., new values added by Vitec)
- Handle Nulls: Some enums may be nullable
- Version Changes: Vitec may add new enum values over time
Maintenance
- Review Regularly: Check Vitec Swagger for new enum values
- Version Documentation: Note which Vitec API version these mappings are valid for
- Changelog: Document when enum values change or new ones are added