ridbpy.models package

Submodules

Module contents

RIDB Data Models

pydantic model ridbpy.models.CampsiteAttributes[source]

Bases: RidbPyModel

Campsite Attributes

Config
  • orm_mode: bool = True

Fields
AttributeID: int
AttributeName: str
AttributeValue: Optional[str]
EntityId: int
EntityType: str
campsite: Campsites
pydantic model ridbpy.models.Campsites[source]

Bases: RidbPyModel

Campsite Information

Config
  • orm_mode: bool = True

Fields
CampsiteAccessible: bool
CampsiteID: int
CampsiteLatitude: float
CampsiteLongitude: float
CampsiteName: Optional[str]
CampsiteType: Optional[str]
CreatedDate: date
FacilityID: int
LastUpdatedDate: date
Loop: Optional[str]
TypeOfUse: str
attributes: List[CampsiteAttributes]
facility: Facilities
permitted_equipment: List[PermittedEquipment]
pydantic model ridbpy.models.PermittedEquipment[source]

Bases: RidbPyModel

Campsite Equipment Information

Config
  • orm_mode: bool = True

Fields
CampsiteID: int
EquipmentName: str
MaxLength: int
campsite: Campsites
pydantic model ridbpy.models.Facilities[source]

Bases: RidbPyModel

Facility Information

Config
  • orm_mode: bool = True

Fields
Enabled: bool
FacilityAdaAccess: Optional[str]
FacilityDescription: Optional[str]
FacilityDirections: Optional[str]
FacilityEmail: Optional[str]
FacilityID: str
FacilityLatitude: float
FacilityLongitude: float
FacilityMapURL: Optional[str]
FacilityName: Optional[str]
FacilityPhone: Optional[str]
FacilityReservationURL: Optional[str]
FacilityTypeDescription: Optional[str]
FacilityUseFeeDescription: Optional[str]
Keywords: Optional[str]
LastUpdatedDate: date
LegacyFacilityID: Optional[str]
OrgFacilityID: int
ParentOrgID: Optional[str]
ParentRecAreaID: Optional[str]
Reservable: bool
StayLimit: Optional[str]
addresses: List[FacilityAddresses]
campsites: List[Campsites]
recreation_area: RecAreas
pydantic model ridbpy.models.FacilityAddresses[source]

Bases: RidbPyModel

Addresses for Facilities

Config
  • orm_mode: bool = True

Fields
AddressCountryCode: Optional[str]
AddressStateCode: Optional[str]
City: Optional[str]
FacilityAddressID: str
FacilityAddressType: str
FacilityID: int
FacilityStreetAddress1: Optional[str]
FacilityStreetAddress2: Optional[str]
FacilityStreetAddress3: Optional[str]
LastUpdatedDate: date
PostalCode: Optional[str]
facility: Facilities
pydantic model ridbpy.models.RecAreaFacilities[source]

Bases: RidbPyModel

Join Table Between Recreation Areas and Facilities

Config
  • orm_mode: bool = True

Fields
field FacilityID: str [Required]
field RecAreaID: str [Required]
pydantic model ridbpy.models.Organizations[source]

Bases: RidbPyModel

Organization Information

Config
  • orm_mode: bool = True

Fields
LastUpdatedDate: date
OrgAbbrevName: Optional[str]
OrgID: str
OrgImageURL: Optional[str]
OrgJurisdictionType: Optional[str]
OrgName: str
OrgParentID: int
OrgType: str
OrgURLAddress: Optional[str]
OrgURLText: Optional[str]
recreation_areas: List[RecAreas]
pydantic model ridbpy.models.OrgEntities[source]

Bases: RidbPyModel

Organization Entity Information

Config
  • orm_mode: bool = True

Fields
EntityId: str
EntityType: str
OrgID: str
pydantic model ridbpy.models.RecAreaAddresses[source]

Bases: RidbPyModel

Recreation Area Addresses

Config
  • orm_mode: bool = True

Fields
AddressCountryCode: Optional[str]
AddressStateCode: Optional[str]
City: Optional[str]
LastUpdatedDate: date
PostalCode: Optional[str]
RecAreaAddressID: int
RecAreaAddressType: str
RecAreaID: int
RecAreaStreetAddress1: Optional[str]
RecAreaStreetAddress2: Optional[str]
RecAreaStreetAddress3: Optional[str]
recreation_area: RecAreas
pydantic model ridbpy.models.RecAreas[source]

Bases: RidbPyModel

Recreation Area Data

Config
  • orm_mode: bool = True

Fields
Enabled: bool
Keywords: Optional[str]
LastUpdatedDate: date
OrgRecAreaID: Optional[int]
ParentOrgID: int
RecAreaDescription: Optional[str]
RecAreaDirections: Optional[str]
RecAreaEmail: Optional[str]
RecAreaID: str
RecAreaLatitude: Optional[float]
RecAreaLongitude: Optional[float]
RecAreaMapURL: Optional[str]
RecAreaName: Optional[str]
RecAreaPhone: Optional[str]
RecAreaReservationURL: Optional[str]
RecAreaUseFeeDescription: Optional[str]
Reservable: bool
StayLimit: Optional[str]
addresses: List[RecAreaAddresses]
facilities: List[Facilities]
organization: Organizations