mdb-v1/dev.sargunv.mobilitydata.mdb.v1

Package-level declarations

Types

data class AccessToken(val accessToken: String? = null, val expirationDatetimeUtc: IsoDateTime? = null, val tokenType: String? = null)

Access token returned by POST /v1/tokens/access.

AccessTokenRequest

@Serializable

data class AccessTokenRequest(val refreshToken: String)

Request body for POST /v1/tokens/access.

AvailabilityQuery

data class AvailabilityQuery(val from: IsoDateTime? = null, val to: IsoDateTime? = null, val limit: Int? = null, val offset: Int? = null, val sort: AvailabilitySort? = null)

Query parameters for GET /v1/gtfs_feeds/{id}/availability.

AvailabilityRequestMethod

@Serializable

@JvmInline

value class AvailabilityRequestMethod(val value: String)

HTTP method used for an availability check.

AvailabilitySort

@JvmInline

value class AvailabilitySort(val value: String)

Sort order for availability history.

BoundingBox

@Serializable

data class BoundingBox(val minimumLatitude: Double? = null, val maximumLatitude: Double? = null, val minimumLongitude: Double? = null, val maximumLongitude: Double? = null)

Geographic bounding box of a dataset.

BoundingFilterMethod

@JvmInline

value class BoundingFilterMethod(val value: String)

How a dataset bounding-box filter selects feeds.

CatalogAuth

sealed class CatalogAuth

Credentials for the Mobility Database Catalog API.

DatasetBboxFilter

data class DatasetBboxFilter(val minimumLatitude: Double, val maximumLatitude: Double, val minimumLongitude: Double, val maximumLongitude: Double)

Latitude and longitude extents for dataset_latitudes and dataset_longitudes.

DatasetQuery

data class DatasetQuery(val latest: Boolean? = null, val limit: Int? = null, val offset: Int? = null, val downloadedAfter: IsoDateTime? = null, val downloadedBefore: IsoDateTime? = null)

Query parameters for GET /v1/gtfs_feeds/{id}/datasets.

ExternalId

@Serializable

data class ExternalId(val externalId: String? = null, val source: String? = null)

Identifier for the same feed in an external or legacy database.

Feed

@Serializable(with = FeedSerializer::class)

sealed class Feed

A Mobility Database catalog feed.

FeedDataType

@Serializable

@JvmInline

value class FeedDataType(val value: String)

Catalog data_type discriminator: gtfs, gtfs_rt, or gbfs.

FeedId

@Serializable

@JvmInline

value class FeedId(val value: String)

Catalog identifier for a feed, such as mdb-1210.

FeedQuery

data class FeedQuery(val limit: Int? = null, val offset: Int? = null, val status: FeedStatus? = null, val provider: String? = null, val producerUrl: String? = null, val isOfficial: Boolean? = null)

Query parameters for GET /v1/feeds.

FeedRelatedLink

@Serializable

data class FeedRelatedLink(val code: String? = null, val description: String? = null, val url: String? = null, val createdAt: IsoDateTime? = null)

A related link attached to a feed.

FeedReliabilityReport

@Serializable

data class FeedReliabilityReport(val feedId: FeedId? = null, val hasSeal: Boolean? = null, val earnedAt: IsoDateTime? = null, val lostAt: IsoDateTime? = null, val evaluatedAt: IsoDateTime? = null, val onProbation: Boolean? = null, val probationEndsAt: IsoDateTime? = null, val criteria: List<ReliabilityCriterion>? = null)

Full Seal of Reliability breakdown for a GTFS feed.

FeedReliabilitySummary

@Serializable

data class FeedReliabilitySummary(val hasSeal: Boolean? = null, val earnedAt: IsoDateTime? = null, val lostAt: IsoDateTime? = null, val evaluatedAt: IsoDateTime? = null, val onProbation: Boolean? = null, val probationEndsAt: IsoDateTime? = null)

Embedded Seal of Reliability summary on a GTFS feed.

FeedStatus

@Serializable

@JvmInline

value class FeedStatus(val value: String)

Publication status of a feed.

GbfsEndpoint

@Serializable

data class GbfsEndpoint(val name: String? = null, val url: String? = null, val language: String? = null, val isFeature: Boolean? = null)

One endpoint in a GBFS version.

GbfsFeedQuery

data class GbfsFeedQuery(val limit: Int? = null, val offset: Int? = null, val provider: String? = null, val producerUrl: String? = null, val countryCode: String? = null, val subdivisionName: String? = null, val municipality: String? = null, val systemId: String? = null, val version: String? = null)

Query parameters for GET /v1/gbfs_feeds.

GbfsValidationReport

@Serializable

data class GbfsValidationReport(val validatedAt: IsoDateTime? = null, val totalError: Int? = null, val reportSummaryUrl: String? = null, val validatorVersion: String? = null)

Validation report for a GBFS version.

GbfsVersion

@Serializable

data class GbfsVersion(val version: String? = null, val createdAt: IsoDateTime? = null, val lastUpdatedAt: IsoDateTime? = null, val source: GbfsVersionSource? = null, val endpoints: List<GbfsEndpoint>? = null, val latestValidationReport: GbfsValidationReport? = null)

One GBFS specification version supported by a feed.

GbfsVersionSource

@Serializable

@JvmInline

value class GbfsVersionSource(val value: String)

Origin of a GbfsVersion row.

GtfsDataset

@Serializable

data class GtfsDataset(val id: String? = null, val feedId: FeedId? = null, val hostedUrl: String? = null, val note: String? = null, val downloadedAt: IsoDateTime? = null, val hash: String? = null, val hashMd5: String? = null, val boundingBox: BoundingBox? = null, val validationReport: ValidationReport? = null, val serviceDateRangeStart: IsoDateTime? = null, val serviceDateRangeEnd: IsoDateTime? = null, val agencyTimezone: String? = null, val zippedFolderSizeMb: Double? = null, val unzippedFolderSizeMb: Double? = null)

A GTFS dataset hosted by the catalog.

GtfsFeedAvailabilityCheck

@Serializable

data class GtfsFeedAvailabilityCheck(val checkedAt: IsoDateTime? = null, val success: Boolean? = null, val requestMethod: AvailabilityRequestMethod? = null, val statusCode: Int? = null, val latencyMs: Double? = null, val errorType: String? = null)

One scheduled availability check.

GtfsFeedAvailabilityResponse

@Serializable

data class GtfsFeedAvailabilityResponse(val feedId: FeedId? = null, val total: Int? = null, val offset: Int? = null, val limit: Int? = null, val checks: List<GtfsFeedAvailabilityCheck>? = null)

Historical availability checks for a GTFS feed.

GtfsFeedQuery

data class GtfsFeedQuery(val limit: Int? = null, val offset: Int? = null, val provider: String? = null, val producerUrl: String? = null, val countryCode: String? = null, val subdivisionName: String? = null, val municipality: String? = null, val isOfficial: Boolean? = null, val datasetBbox: DatasetBboxFilter? = null, val boundingFilterMethod: BoundingFilterMethod? = null)

Query parameters for GET /v1/gtfs_feeds.

GtfsRtFeedQuery

data class GtfsRtFeedQuery(val limit: Int? = null, val offset: Int? = null, val provider: String? = null, val producerUrl: String? = null, val entityTypes: List<RealtimeEntityType>? = null, val countryCode: String? = null, val subdivisionName: String? = null, val municipality: String? = null, val isOfficial: Boolean? = null)

Query parameters for GET /v1/gtfs_rt_feeds.

IsoDateTime

typealias IsoDateTime = @Serializable(with = IsoDateTimeSerializer::class) Instant

Instant encoded as an ISO-8601 date-time string.

IsoDateTimeSerializer

object IsoDateTimeSerializer : KSerializer<Instant>

Serializer for Instant that reads and writes ISO-8601 date-time strings.

LatestDataset

@Serializable

data class LatestDataset(val id: String? = null, val hostedUrl: String? = null, val boundingBox: BoundingBox? = null, val downloadedAt: IsoDateTime? = null, val hash: String? = null, val hashMd5: String? = null, val serviceDateRangeStart: IsoDateTime? = null, val serviceDateRangeEnd: IsoDateTime? = null, val agencyTimezone: String? = null, val zippedFolderSizeMb: Double? = null, val unzippedFolderSizeMb: Double? = null, val validationReport: ValidationReport? = null)

Latest dataset summary embedded on a GTFS feed.

License

@Serializable

data class License(val id: String? = null, val type: String? = null, val isSpdx: Boolean? = null, val name: String? = null, val url: String? = null, val description: String? = null, val createdAt: IsoDateTime? = null, val updatedAt: IsoDateTime? = null, val licenseTags: List<String>? = null)

A catalog license as returned by GET /v1/licenses.

LicenseMatchRequest

@Serializable

data class LicenseMatchRequest(val licenseUrl: String)

Request body for POST /v1/licenses:match.

LicenseMatchType

@Serializable

@JvmInline

value class LicenseMatchType(val value: String)

Kind of license URL match.

LicenseQuery

data class LicenseQuery(val limit: Int? = null, val offset: Int? = null)

Query parameters for GET /v1/licenses.

LicenseRule

@Serializable

data class LicenseRule(val name: String? = null, val label: String? = null, val description: String? = null, val type: LicenseRuleType? = null)

One permission, condition, or limitation on a license.

LicenseRuleType

@Serializable

@JvmInline

value class LicenseRuleType(val value: String)

Kind of LicenseRule.

LicenseWithRules

@Serializable

data class LicenseWithRules(val id: String? = null, val type: String? = null, val isSpdx: Boolean? = null, val name: String? = null, val url: String? = null, val description: String? = null, val createdAt: IsoDateTime? = null, val updatedAt: IsoDateTime? = null, val licenseTags: List<String>? = null, val licenseRules: List<LicenseRule>? = null)

A catalog license including its rules, as returned by GET /v1/licenses/{id}.

Location

@Serializable

data class Location(val countryCode: String? = null, val country: String? = null, val subdivisionName: String? = null, val municipality: String? = null)

Geographic area associated with a feed.

LocationQuery

data class LocationQuery(val limit: Int? = null, val offset: Int? = null, val searchQuery: String? = null, val countryCode: String? = null, val subdivisionCode: String? = null, val locationType: LocationType? = null)

Query parameters for GET /v1/locations.

LocationSearchResponse

@Serializable

data class LocationSearchResponse(val total: Int? = null, val results: List<LocationSearchResult>? = null)

Paginated location search response.

LocationSearchResult

@Serializable

data class LocationSearchResult(val locationId: Int? = null, val parentLocationId: Int? = null, val name: String? = null, val altName: String? = null, val locationType: LocationType? = null, val countryName: String? = null, val countryCode: String? = null, val subdivisionName: String? = null, val subdivisionCode: String? = null, val pathNames: List<String>? = null, val displayName: String? = null)

One location in a search result page.

LocationType

@Serializable

@JvmInline

value class LocationType(val value: String)

Kind of catalog location.

MatchingLicense

@Serializable

data class MatchingLicense(val licenseId: String? = null, val licenseUrl: String? = null, val normalizedUrl: String? = null, val matchType: LicenseMatchType? = null, val confidence: Double? = null, val spdxId: String? = null, val matchedName: String? = null, val matchedCatalogUrl: String? = null, val matchedSource: String? = null, val notes: String? = null, val regionalId: String? = null)

One catalog license that matched a submitted URL.

MdbV1Client

class MdbV1Client : AutoCloseable

HTTP client for the Mobility Database Catalog API v1.

Metadata

@Serializable

data class Metadata(val version: String? = null, val commitHash: String? = null)

Build metadata for the catalog API process.

RealtimeEntityType

@Serializable

@JvmInline

value class RealtimeEntityType(val value: String)

GTFS Realtime entity type published by a feed.

Redirect

@Serializable

data class Redirect(val targetId: FeedId? = null, val comment: String? = null)

A replacement feed that should be used instead of the current one.

ReliabilityCriterion

@Serializable

data class ReliabilityCriterion(val criterion: ReliabilityCriterionId? = null, val status: ReliabilityCriterionStatus? = null, val inGracePeriod: Boolean? = null, val gracePeriodEndsAt: IsoDateTime? = null, val onProbation: Boolean? = null, val probationEndsAt: IsoDateTime? = null, val evaluatedAt: IsoDateTime? = null, val firstFailureAt: IsoDateTime? = null, val lastFailureAt: IsoDateTime? = null)

One criterion's contribution to the Seal of Reliability.

ReliabilityCriterionId

@Serializable

@JvmInline

value class ReliabilityCriterionId(val value: String)

Seal of Reliability criterion name.

ReliabilityCriterionStatus

@Serializable

@JvmInline

value class ReliabilityCriterionStatus(val value: String)

Verdict for one reliability criterion.

SearchFeedItem

@Serializable

data class SearchFeedItem(val id: FeedId? = null, val dataType: FeedDataType? = null, val status: FeedStatus? = null, val createdAt: IsoDateTime? = null, val official: Boolean? = null, val seasonal: Boolean? = false, val externalIds: List<ExternalId>? = null, val provider: String? = null, val feedName: String? = null, val note: String? = null, val feedContactEmail: String? = null, val sourceInfo: SourceInfo? = null, val redirects: List<Redirect>? = null, val locations: List<Location>? = null, val latestDataset: LatestDataset? = null, val entityTypes: List<RealtimeEntityType>? = null, val versions: List<String>? = null, val feedReferences: List<FeedId>? = null, val reliabilitySeal: FeedReliabilitySummary? = null)

One feed in a search result page.

SearchFeedsQuery

data class SearchFeedsQuery(val limit: Int? = null, val offset: Int? = null, val status: List<FeedStatus>? = null, val feedId: FeedId? = null, val dataType: List<FeedDataType>? = null, val isOfficial: Boolean? = null, val hasSeal: Boolean? = null, val version: List<String>? = null, val searchQuery: String? = null, val feature: List<String>? = null, val licenseIds: List<String>? = null, val licenseIsSpdx: Boolean? = null, val licenseTags: List<String>? = null)

Query parameters for GET /v1/search.

SearchFeedsResponse

@Serializable

data class SearchFeedsResponse(val total: Int? = null, val results: List<SearchFeedItem>? = null)

Envelope returned by GET /v1/search.

SourceInfo

@Serializable

data class SourceInfo(val producerUrl: String? = null, val isProducerUrlUnstable: Boolean? = null, val authenticationType: Int? = null, val authenticationInfoUrl: String? = null, val apiKeyParameterName: String? = null, val licenseUrl: String? = null, val licenseId: String? = null, val licenseIsSpdx: Boolean? = null, val licenseNotes: String? = null, val licenseTags: List<String>? = null)

Producer URL and how to authenticate to it.

ValidationReport

@Serializable

data class ValidationReport(val validatedAt: IsoDateTime? = null, val features: List<String>? = null, val validatorVersion: String? = null, val totalError: Int? = null, val totalWarning: Int? = null, val totalInfo: Int? = null, val uniqueErrorCount: Int? = null, val uniqueWarningCount: Int? = null, val uniqueInfoCount: Int? = null, val urlJson: String? = null, val urlHtml: String? = null)

GTFS validation report summary.

Properties

MdbJson

val MdbJson: Json

Pre-configured JSON instance for the Mobility Database Catalog API.