Public

Schemas OpenAPI

interface MapLocationPublicShortSchema {
  id: string
  name: string
  type: string
  countryId?: string
  qualityOfLifeIndex: number
  latitude: number
  longitude: number
}
interface MapLocationPublicSchema extends MapLocationPublicShortSchema {
    cities: MapLocationPublicShortSchema[]
    currency: {
        id: string
        name: string
        symbol: string
        rate: string
        collectedAt: Date
    }
    mapIndices: [
        {
            id: string
            type: string
            name: string
            numbeoItemId: number
            lowestValue: number
            highestValue: number
            averageValue: number
        },
    ]
}

Routes appelées

PREFIX: https://api.staging.pilot-student.creatiwity.net/public

GET /map-locations?type=<COUNTRY | CITY>

Réponse

{
  "code": 200,
  "body": MapLocationPublicShortSchema[]
}

GET /map-locations/:id

Paramètres de la route

interface MapLocationRequestParams {
  id: string // l'identifiant ISO du pays. ex: FR
}

Réponse

{
  "code": 200,
  "body": MapLocationPublicSchema
}