README_DATA_BASIC

# This is the documentation for the BASIC version of the CBSE 2018 Schools data. 
# The BASIC data has 25 fields documented below for 20,367 schools.

# Go to the URL http://cbseaff.nic.in/cbse_aff/schdir_Report/AppViewdir.aspx?affno=<aff_no>
# to find the raw data for a given affiliation number.
CbseSchoolBasic {
  # School name
  # The name of the school in capital letters.
  required string name; 

  # Affiliation number
  # A usually 7 digit (70%) but occasionally 6 (30%) and 5 digit (2 instances) number.
  # This is a unique number for each school.
  required int aff_no;
  
  # Indian State/Union Territory or "Foreign Schools"
  # The name of the state or the string "Foreign Schools" if not from India.
  required State state;

  # Indian District (or Country if state == FOREIGN SCHOOlS)
  # FOREIGN SCHOOlS can be one of 25 countries.
  # Documentation is in README_DISTRICTS
  # (missing 2903/20367 - 14%)
  optional District district;

  # CBSE Region
  # The CBSE office this school is under the jurisdiction of.
  # FOREIGN SCHOOLS falls under the DELHI jurisdiction.
  requiered CbseRegion region;

  # Postal Address
  # The postal address of the school in all caps.
  required string address;

  # Pincode.
  # The Indian pincode of the school, usually empty for foreign schools.
  # (missing 642/20367 - 3%)
  optional int pincode;

  # Phone number with STD code.
  # ';' separated phone-numbers. Cleaned to have no '-', ' '. Cannot contain letters.
  # Empty/spammy values such as '-', '--', 'NA', 'XXX', '000' removed.
  # (missing 9999/20367 - 50%)
  optional string ph_no;

  # Office Phone number
  # ';' separated phone-numbers. Cleaned to have no '-', ' '. Cannot contain letters.
  # Empty/spammy values such as '-', '--', 'NA', 'XXX', '000' removed.
  # (missing 732/20367 - 4%)
  optional string off_ph_no;

  # Residential Phone number
  # ';' separated phone-numbers. Cleaned to have no '-', ' '. Cannot contain letters.
  # Empty/spammy values such as '-', '--', 'NA', 'XXX', '000' removed.
  # (missing 10604/20367 - 53%)
  optional string res_ph_no;

  # Fax number
  # Not guaranteed to be well formed or integral. Can contain '-'.
  # Can be '-' or '-----' when not present.
  # (missing 13754/20367 - 65%)
  optional string fax_no;

  # Email
  # Email address of the school or principal.
  # (missing 848/20367 - 4%)
  optional string email;

  # Website
  # Website of the school.
  # (missing 14228/20367 - 70%)
  optional string website;

  # Year Found
  # A 4 digit integral year between 1800 and 2018, denoting when the school was founded.
  # (missing 806/20367 - 4%)
  optional int year_found;

  # Date Opened
  # The date this school was opened in the form "Sep 9, 2010", or format "%b %-d, %Y"
  # (missing 1408/20367 - 7%)
  optional Date date_opened;

  # Principal Name
  # The string name of the principal. 
  # Cleaned to not have 'Mr' 'Mrs' 'Dr' etc prefixes. Normalized to have only one space between names. 
  # Cleaned to not be equal to 'PRINCIPAL' or contain 'PRINCIPAL' in the name.
  # (missing 389/20367 - 2%)
  optional string princi_name;

  # Sex
  # The gender/sex of the school/principal. Can take the values '0', '1' or '2'.
  # The meaning of these values is unclear. 
  # (missing 2922/20367 - 14%)
  optional Sex sex;

  # Principal Qualifications
  # The academic qualifications of the principal. 
  # (missing 5143/20367 - 25%)
  optional string princi_qual;  

  # Principal Experience as an Administrator (in years)
  # Integral value ranging from 0 to 60 years.
  # (missing 5526/20367 - 27%)
  optional int princi_exp_adm;

  # Principal Experience as a Teacher (in years)
  # Integral value ranging from 0 to 60 years.
  # (missing 5509/20367 - 27%)
  optional int princi_exp_teach;

  # Status of the school
  # Whether this school is a Middle, Secondary or Senior Secondary school.
  required Status status;

  # Affiliation Type of the school
  # Whether this school is provisionally or permanently affiliated.
  # Cleaned this field to change the spelling of 'Permanant' to 'Permanent'.
  # (missing 343/20367 - 2%)
  optional AffiliationType aff_type;

  # Affiliation Start Date
  # The date this school's affiliation began in the form "Sep 9, 2010", or format "%b %-d, %Y"
  # (missing 21/20367 - 0.1%)
  optional Date aff_start;

  # Affiliation End Date
  # The date this school's affiliation ended in the form "Sep 9, 2010", or format "%b %-d, %Y"
  # (missing 21/20367 - 0.1%)
  optional Date aff_end;

  # Name of Trust, Society or Managing Committee
  # Name of the overseeing company of this school.
  # (missing 738/20367 - 4%)
  optional string soc_name;

  enum AffiliationType {
    'Provisional', # count: 20004
    'Permanent', # count: 20
  }

  enum Status {
    'Middle Class', # count: 274
    'Secondary School', # count: 6921
    'Senior Secondary' # count: 13172
  }

  enum Sex {
    '0', # count: 6423
    '1', # count: 5829
    '2', # count: 5193
  }

  enum State {
    # Foreign Schools
    'FOREIGN SCHOOLS', # count: 220,
    # Indian States (29)
    'ANDHRA PRADESH', # count: 306,
    'ARUNACHAL PRADESH', # count: 310,
    'ASSAM', # count: 262,
    'BIHAR', # count: 831,
    'CHATTISGARH', # count: 564,
    'GOA', # count: 15,
    'GUJARAT', # count: 425,
    'HARYANA', # count: 1528,
    'HIMACHAL PRADESH', # count: 263,
    'JAMMU & KASHMIR', # count: 146,
    'JHARKHAND', # count: 425,
    'KARNATAKA', # count: 895,
    'KERALA', # count: 1341,
    'MADHYA PRADESH', # count: 1162,
    'MAHARASHTRA', # count: 833,
    'MANIPUR', # count: 71,
    'MEGHALAYA', # count: 26,
    'MIZORAM', # count: 14,
    'NAGALAND', # count: 36,
    'ODISHA', # count: 446,
    'PUNJAB', # count: 1314,
    'RAJASTHAN', # count: 1081,
    'SIKKIM', # count: 222,
    'TAMILNADU', # count: 830,
    'TELANGANA', # count: 268,
    'TRIPURA', # count: 54,
    'UTTAR PRADESH', # count: 3138,
    'UTTARAKHAND', # count: 588,
    'WEST BENGAL', # count: 305
    # Indian Union Territories (7)
    'ANDAMAN & NICOBAR', # count: 119
    'CHANDIGARH', # count: 163,
    'DADAR & NAGAR HAVELI', # count: 10,
    'DAMAN & DIU', # count: 5,
    'DELHI', # count: 2112,
    'LAKSHADWEEP', # count: 10,
    'PUDUCHERRY', # count: 29,
  }

  enum CbseRegion {
    'AJMER', # count: 2678
    # Region Code: 1
    # GUJARAT, MADHYA PRADESH, RAJASTHAN, DADAR & NAGAR HAVELI
    'ALLAHABAD', # count: 2053
    # UTTAR PRADESH (Eastern Districts)
    # Region Code: 56
    # Mathura, Bareilly, Shahjahanpur, Kasganj/Kashi Ram Nagar, Etah, Hathras/Mahamaya Nagar, Aligarh,
    # Pilibhit, Agra
    'BHUBANESWAR', # count: 1315
    # Region Code: 6
    # CHATTISGARH, ODISHA, WEST BENGAL
    'CHENNAI', # count: 3300
    # Region Code: 46
    # ANDHRA PRADESH, GOA, KARNATAKA, MAHARASHTRA, TAMILNADU, TELANGANA, ANDAMAN & NICOBAR, DAMAN & DIU, PUDUCHERRY
    'DEHRADUN', # count: 2332
    # Region Code: 58
    # UTTARAKHAND, UTTAR PRADESH (Western Districts)
    # Badaun, Baghpat, Bijnour, Bulandshahr, , GautamBudh Nagar(Noida), Ghaziabad, Hapur, J.P.Nagar/Amroha, Meerut,
    # Moradabad, Muzaffarnagar, Rampur, Saharanpur, Sambhal and Shamli
    'DELHI', # count: 2332
    # Region Code: 9
    # DELHI, FOREIGN SCHOOLS
    'GUWAHATI', # count: 995
    # Region Code: 3
    # ARUNACHAL PRADESH, ASSAM, MANIPUR, MEGHALAYA, MIZORAM, NAGALAND, SIKKIM, TRIPURA
    'PANCHKULA', # count: 3414
    # Region Code: 2
    # HARYANA, HIMACHAL PRADESH, JAMMU & KASHMIR, PUNJAB, CHANDIGARH
    'PATNA', # count: 1256
    # Region Code: 7
    # BIHAR, JHARKHAND
    'TRIVANDRUM', # count: 1351
    # Region Code: 48
    # KERALA, LAKSHADWEEP
  }
}