Table of Contents

Class CompanyDetails

Namespace
Geotab.Checkmate.ObjectModel.Registration
Assembly
Geotab.Checkmate.ObjectModel.dll

Company details for registration.

public class CompanyDetails : IDefaultable
Inheritance
CompanyDetails
Implements
Inherited Members

Constructors

CompanyDetails()

Initializes a new instance of the CompanyDetails class.

public CompanyDetails()

CompanyDetails(string, string, string, string, int, string, bool, string, Guid?, RequireTraining?, string, Jurisdiction?, string, string?, string?, string?, string?, string?, string?, string?, string?, string?, string?)

Initializes a new instance of the CompanyDetails class.

public CompanyDetails(string companyName, string firstName, string lastName, string resellerName, int fleetSize, string comments, bool signUpForNew, string phoneNumber, Guid? industry, RequireTraining? requireTraining, string registrationDomain, Jurisdiction? jurisdiction, string timeZoneId = "America/New_York", string? companyPhoneNumber = null, string? country = null, string? state = null, string? city = null, string? website = null, string? accountId = null, string? brandingType = null, string? brandingName = null, string? email = null, string? language = null)

Parameters

companyName string

The company name.

firstName string

The account administrator first name.

lastName string

The account administrator last name.

resellerName string

The reseller name.

fleetSize int

The number of vehicle in the company fleet.

comments string

Free text field.

signUpForNew bool

Sign-up to receive news about new telematics products, events and promotions.

phoneNumber string

The account administrator phone number.

industry Guid?

The company industry.

requireTraining RequireTraining?

Sign-up administrator to be contacted for on-boarding training.

registrationDomain string

Name of the domain where database is registered.

jurisdiction Jurisdiction?

The jurisdiction to register the database in.

timeZoneId string

The IANA Timezone Id used to determine local work times. This is typically the "home location" of the admin user. Default ["America/New_York"].

companyPhoneNumber string

The company phone number. Default [null].

country string

The company's office country. Default [null].

state string

The company's office state. Default [null].

city string

The company's office city. Default [null].

website string

The company website. Default [null].

accountId string

The account id of the company that database should be created for. Default [null].

brandingType string

The branding type: co-branding, whitelabel, geotab. Default [null].

brandingName string

The branding name. Default [null].

email string

The primary contact email address. Default [null].

language string

The primary contact language. Default [null].

Fields

MaxBrandingNameLength

Maximum BrandingName length that can be inserted into the MyAdmin db without truncation. This field maps to dbBrandingName.

public const int MaxBrandingNameLength = 30

Field Value

int

MaxCityLength

Maximum City name length.

public const int MaxCityLength = 256

Field Value

int

MaxCommentsLength

Maximum Comments length that can be inserted into the MyAdmin db without truncation. This field maps to sComments.

public const int MaxCommentsLength = 1000

Field Value

int

MaxCompanyNameLength

Maximum CompanyName length that can be inserted into the MyAdmin db without truncation. This field maps to sCompanyName.

public const int MaxCompanyNameLength = 256

Field Value

int

MaxFullNameLength

Maximum FullName length that can be inserted into the MyAdmin db without truncation. This field maps to sAdminName.

public const int MaxFullNameLength = 100

Field Value

int

MaxPhoneNumberLength

Maximum PhoneNumber length that can be inserted into the MyAdmin db without truncation. This field maps to sAdminContactNo.

public const int MaxPhoneNumberLength = 16

Field Value

int

MaxResellerNameLength

Maximum ResellerName length that can be inserted into the MyAdmin db without truncation. This field maps to sDealerName.

public const int MaxResellerNameLength = 50

Field Value

int

MaxStateLength

Maximum State name length.

public const int MaxStateLength = 256

Field Value

int

Properties

AccountId

Gets or sets the company account id.

public string? AccountId { get; set; }

Property Value

string

string

BrandingName

Gets or sets the branding name. Maximum length [50].

public string? BrandingName { get; set; }

Property Value

string

string

BrandingType

Gets or sets the branding type: Co-Branding, Whitelabel.

public string? BrandingType { get; set; }

Property Value

string

string

City

Gets or sets the city where company office is located. Maximum length [256].

public string? City { get; set; }

Property Value

string

string

Comments

Gets or sets free text field. Maximum length [1000].

public string? Comments { get; set; }

Property Value

string

string

CompanyName

Gets or sets the company name. Maximum length [256].

public string? CompanyName { get; set; }

Property Value

string

string

CompanyPhoneNumber

Gets or sets the company phone number. Maximum length [50].

public string? CompanyPhoneNumber { get; set; }

Property Value

string

string

Country

Gets or sets the 2-letter ISO country code where company office is located. Maximum length [2].

public string? Country { get; set; }

Property Value

string

string

Email

Gets or sets the primary contact email.

public string? Email { get; set; }

Property Value

string

string

FirstName

Gets or sets the account administrator's first name. Maximum length [100] is shared between FirstName, one added space, and LastName.

public string? FirstName { get; set; }

Property Value

string

string

FleetSize

Gets or sets the number of vehicles in the company fleet.

public int? FleetSize { get; set; }

Property Value

int?

int

FullName

Gets the account administrator's first and last name.

public string FullName { get; }

Property Value

string

string

Industry

Gets or sets the company industry guid the same as SystemSettings Industry property.

public Guid? Industry { get; set; }

Property Value

Guid?

Guid

Jurisdiction

Gets or sets the Jurisdiction for data residency purposes.

public Jurisdiction? Jurisdiction { get; set; }

Property Value

Jurisdiction?

Jurisdiction

Language

Gets or sets the 2-letter ISO primary contact language code with 2-letter region code. For instance: "en-US" for English.

public string? Language { get; set; }

Property Value

string

string

LastName

Gets or sets the account administrator's last name. Maximum length [100] is shared between FirstName, one added space, and LastName.

public string? LastName { get; set; }

Property Value

string

string

PhoneNumber

Gets or sets the account administrator's phone number. Maximum length [50].

public string? PhoneNumber { get; set; }

Property Value

string

string

RegistrationDomain

Gets or sets the registration domain name where database is created.

public string? RegistrationDomain { get; set; }

Property Value

string

string

RequireTraining

Gets or sets whether administrator required training or not.

public RequireTraining? RequireTraining { get; set; }

Property Value

RequireTraining?

RequireTraining

ResellerName

Gets or sets the reseller name. Maximum length [50].

public string? ResellerName { get; set; }

Property Value

string

string

SignUpForNews

Gets or sets a value indicating whether sign-up to receive news about new telematics products, events and promotions.

public bool? SignUpForNews { get; set; }

Property Value

bool?

bool

State

Gets or sets the state where company office is located. Maximum length [256].

public string? State { get; set; }

Property Value

string

string

SubIndustry

Gets or sets the company sub industry guid.

public Guid? SubIndustry { get; set; }

Property Value

Guid?

Guid

TimeZoneId

Gets or sets the IANA Timezone Id of the device used to determine local work times. This is typically the "home location" of the admin user.

public string? TimeZoneId { get; set; }

Property Value

string

string

Remarks

Retrieve a list of valid timezone Id's by querying "GetTimeZones".

Website

Gets or sets the company website. Maximum length [256].

public string? Website { get; set; }

Property Value

string

string

Methods

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public void PopulateDefaults()

SetSubIndustry()

Sets the sub industry based on the industry.

public void SetSubIndustry()

ValidateForMyAdminDb()

Throws if any of the CompanyDetails string fields are too long for the MyAdmin database.

public void ValidateForMyAdminDb()

ValidateForNewFlowMyAdminDb()

Throws if any of the CompanyDetails string fields that are required in new registration flow are invalid for the MyAdmin database.

public void ValidateForNewFlowMyAdminDb()