Models & Relationships

The objects you manipulate through the Izix API and how they relate.


classDiagram
    direction LR
    class Organization
    class Profile {
      profile_external_reference
      email
      plates
      tags
    }
    class AccessPolicy {
      access_strategy
      timetable
    }
    class ParkingLot
    class Gate
    class GateSpecification
    class AccessRight {
      valid_from
      valid_to
      planning_period
    }
    class Reservation {
      from
      to
    }
    Organization "1" --> "*" Profile
    Organization "1" --> "*" AccessPolicy
    AccessPolicy "*" --> "1" ParkingLot
    ParkingLot "1" --> "*" Gate
    Gate "1" --> "*" GateSpecification
    Profile "1" --> "*" AccessRight
    AccessRight "*" --> "1" AccessPolicy
    Profile "1" --> "*" Reservation
    Reservation "*" --> "1" AccessPolicy
ConceptDefinition
OrganizationA customer company in Izix. It holds its profiles, its access policies and its settings (SSO, directory sync). Partner credentials may manage several organizations, selected with organization_id.
User / ProfileA user is a physical person. A profile is that person inside one organization. A user can have profiles in several organizations. Integrations work at profile level.
TagA label on a profile. Administrators can link tags to access policies so rights are granted automatically.
CredentialWhat identifies a profile at the gate: licence plate (ANPR), keypad code, QR code, or a remote opening from an app.
Parking lotA physical parking with its capacity.
Access policyThe rules under which an organization uses capacity in a parking lot: strategy (booking, community booking, first come first served, preferential), timetable, booking window, cost.
Access rightThe link between a profile and an access policy, with a validity period. Without an access right a profile can neither book nor enter.
ReservationCapacity held for a profile on an access policy for a period. Scheduled reservations are booked in advance. First come, first served reservations are created automatically at entry and closed at exit.
SessionThe actual stay in the parking, anchored to a reservation, with its entry and exit passages.
ReleaseA period during which a preferential reservation is given back to the pool, typically during holidays.
Gate / gate specificationA physical access point. A gate has one or more specifications, each identified by the ID used to open it remotely.

Did this page help you?