openapi: 3.2.0 info: title: Location Intelligence Geocoding API version: 2022.09.c description: Use LI API data to access RMS model insights in a flexible, scalable, and programmable way. The suite of layers includes exposure enhancement, geocoding, hazard, risk scoring, and loss costs to provide information for key decisions in the underwriting workflow, including screening, selection, and pricing. servers: - url: https://{host}/li description: Location Intelligence variables: host: enum: - api-euw1.rms.com - api-use1.rms.com default: api-euw1.rms.com description: 'Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com.' security: - apiKey: [] tags: - name: Geocoding description: Geocodes an address paths: /geocode/18.0: post: tags: - Geocoding summary: Geocode Address 18.0 requestBody: description: Address to geocode content: application/json: schema: $ref: '#/components/schemas/GeocodeInput' example: countryCode: US countryScheme: ISO2A admin1Code: CA postalCode: '94560' streetAddress: 7575 GATEWAY BLVD required: true responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/GeocodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1: post: tags: - Geocoding summary: Geocode Address 18.1 requestBody: description: Address to geocode content: application/json: schema: $ref: '#/components/schemas/GeocodeInput' example: countryCode: US countryScheme: ISO2A admin1Code: CA postalCode: '94560' streetAddress: 7575 GATEWAY BLVD required: true responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/GeocodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0: post: tags: - Geocoding summary: Geocode Address 21.0 requestBody: description: Address to geocode content: application/json: schema: $ref: '#/components/schemas/GeocodeInput' example: countryCode: US countryScheme: ISO2A admin1Code: CA postalCode: '94560' streetAddress: 7575 GATEWAY BLVD required: true responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/GeocodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0: post: tags: - Geocoding summary: Geocode Address 22.0 requestBody: description: Address to geocode content: application/json: schema: $ref: '#/components/schemas/GeocodeInput' example: countryCode: US countryScheme: ISO2A admin1Code: CA postalCode: '94560' streetAddress: 7575 GATEWAY BLVD required: true responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/GeocodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest: post: tags: - Geocoding summary: Geocode Address Latest requestBody: description: Address to geocode content: application/json: schema: $ref: '#/components/schemas/GeocodeInput' example: countryCode: US countryScheme: ISO2A admin1Code: CA postalCode: '94560' streetAddress: 7575 GATEWAY BLVD required: true responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/GeocodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin1: get: tags: - Geocoding summary: admin1 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin1Name schema: type: string description: Name of administrative level 1 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin1: get: tags: - Geocoding summary: admin1 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin1Name schema: type: string description: Name of administrative level 1 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin1: get: tags: - Geocoding summary: admin1 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin1Name schema: type: string description: Name of administrative level 1 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin1: get: tags: - Geocoding summary: admin1 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin1Name schema: type: string description: Name of administrative level 1 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin1: get: tags: - Geocoding summary: admin1 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin1Name schema: type: string description: Name of administrative level 1 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin1: get: tags: - Geocoding summary: admin1 Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin1Name schema: type: string description: Name of administrative level 1 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin1/{id}: get: tags: - Geocoding summary: admin1 by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin1/{id}: get: tags: - Geocoding summary: admin1 by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin1/{id}: get: tags: - Geocoding summary: admin1 by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin1/{id}: get: tags: - Geocoding summary: admin1 by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin1/{id}: get: tags: - Geocoding summary: admin1 by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin1/{id}: get: tags: - Geocoding summary: admin1 by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin2: get: tags: - Geocoding summary: admin2 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin2Name schema: type: string description: Name of administrative level 2 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin2: $ref: '#/paths/~1geocode~118.0~1admin2' get: tags: - Geocoding summary: admin2 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin2Name schema: type: string description: Name of administrative level 2 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin2: get: tags: - Geocoding summary: admin2 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin2Name schema: type: string description: Name of administrative level 2 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin2: get: tags: - Geocoding summary: admin2 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin2Name schema: type: string description: Name of administrative level 2 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin2: get: tags: - Geocoding summary: admin2 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin2Name schema: type: string description: Name of administrative level 2 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin2: get: tags: - Geocoding summary: admin2 Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin2Name schema: type: string description: Name of administrative level 2 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin2/{id}: get: tags: - Geocoding summary: admin2 by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin2/{id}: get: tags: - Geocoding summary: admin2 by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin2/{id}: get: tags: - Geocoding summary: admin2 by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin2/{id}: get: tags: - Geocoding summary: admin2 by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin2/{id}: get: tags: - Geocoding summary: admin2 by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin2/{id}: get: tags: - Geocoding summary: admin2 by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin3: get: tags: - Geocoding summary: admin3 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin3Code schema: type: string description: Code for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality - in: query name: admin3Name schema: type: string description: Name of administrative level 3 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin3: get: tags: - Geocoding summary: admin3 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin3Code schema: type: string description: Code for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality - in: query name: admin3Name schema: type: string description: Name of administrative level 3 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin3: get: tags: - Geocoding summary: admin3 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin3Code schema: type: string description: Code for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality - in: query name: admin3Name schema: type: string description: Name of administrative level 3 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin3: get: tags: - Geocoding summary: admin3 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin3Code schema: type: string description: Code for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality - in: query name: admin3Name schema: type: string description: Name of administrative level 3 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin3: get: tags: - Geocoding summary: admin3 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin3Code schema: type: string description: Code for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality - in: query name: admin3Name schema: type: string description: Name of administrative level 3 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin3: get: tags: - Geocoding summary: admin3 Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin3Code schema: type: string description: Code for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality - in: query name: admin3Name schema: type: string description: Name of administrative level 3 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin3/{id}: get: tags: - Geocoding summary: admin3 by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin3/{id}: get: tags: - Geocoding summary: admin3 by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin3/{id}: get: tags: - Geocoding summary: admin3 by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin3/{id}: get: tags: - Geocoding summary: admin3 by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin3/{id}: get: tags: - Geocoding summary: admin3 by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin3/{id}: get: tags: - Geocoding summary: admin3 by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin4: get: tags: - Geocoding summary: admin4 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin4Code schema: type: string description: Code for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district - in: query name: admin4Name schema: type: string description: Name of administrative level 4 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin4: get: tags: - Geocoding summary: admin4 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin4Code schema: type: string description: Code for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district - in: query name: admin4Name schema: type: string description: Name of administrative level 4 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin4: get: tags: - Geocoding summary: admin4 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin4Code schema: type: string description: Code for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district - in: query name: admin4Name schema: type: string description: Name of administrative level 4 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin4: get: tags: - Geocoding summary: admin4 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin4Code schema: type: string description: Code for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district - in: query name: admin4Name schema: type: string description: Name of administrative level 4 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin4: get: tags: - Geocoding summary: admin4 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin4Code schema: type: string description: Code for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district - in: query name: admin4Name schema: type: string description: Name of administrative level 4 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin4: get: tags: - Geocoding summary: admin4 Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: admin4Code schema: type: string description: Code for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district - in: query name: admin4Name schema: type: string description: Name of administrative level 4 - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/admin4/{id}: get: tags: - Geocoding summary: admin4 by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/admin4/{id}: get: tags: - Geocoding summary: admin4 by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/admin4/{id}: get: tags: - Geocoding summary: admin4 by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/admin4/{id}: get: tags: - Geocoding summary: admin4 by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin2Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/admin4/{id}: get: tags: - Geocoding summary: admin4 by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/admin4/{id}: get: tags: - Geocoding summary: admin4 by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood or district. responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableAdmin4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/city: get: tags: - Geocoding summary: city 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: cityCode schema: type: string description: Code for the city, City field represents a city or a town - in: query name: cityName schema: type: string description: city, field represents a city or a town - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/city: get: tags: - Geocoding summary: city 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: cityCode schema: type: string description: Code for the city, City field represents a city or a town - in: query name: cityName schema: type: string description: city, field represents a city or a town - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/city: get: tags: - Geocoding summary: city 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: cityCode schema: type: string description: Code for the city, City field represents a city or a town - in: query name: cityName schema: type: string description: city, field represents a city or a town - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/city: get: tags: - Geocoding summary: city 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: cityCode schema: type: string description: Code for the city, City field represents a city or a town - in: query name: cityName schema: type: string description: city, field represents a city or a town - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/city: get: tags: - Geocoding summary: city 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: cityCode schema: type: string description: Code for the city, City field represents a city or a town - in: query name: cityName schema: type: string description: city, field represents a city or a town - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/city: get: tags: - Geocoding summary: city Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: cityCode schema: type: string description: Code for the city, City field represents a city or a town - in: query name: cityName schema: type: string description: city, field represents a city or a town - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/city/{id}: get: tags: - Geocoding summary: city by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for city responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/city/{id}: get: tags: - Geocoding summary: city by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for city responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/city/{id}: get: tags: - Geocoding summary: city by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for city responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/city/{id}: get: tags: - Geocoding summary: city by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for city responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/city/{id}: get: tags: - Geocoding summary: city by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for city responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/city/{id}: get: tags: - Geocoding summary: city by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for city responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCityOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/country: get: tags: - Geocoding summary: country 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: countryName schema: type: string description: Name of Country - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/country: get: tags: - Geocoding summary: country 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: countryName schema: type: string description: Name of Country - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/country: get: tags: - Geocoding summary: country 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: countryName schema: type: string description: Name of Country - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/country: get: tags: - Geocoding summary: country 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: countryName schema: type: string description: Name of Country - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/country: get: tags: - Geocoding summary: country 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: countryName schema: type: string description: Name of Country - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/country: get: tags: - Geocoding summary: country Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: countryName schema: type: string description: Name of Country - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/country/{id}: get: tags: - Geocoding summary: country by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for Country responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/country/{id}: get: tags: - Geocoding summary: country by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for Country responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/country/{id}: get: tags: - Geocoding summary: country by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for Country responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/country/{id}: get: tags: - Geocoding summary: country by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for Country responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/country/{id}: get: tags: - Geocoding summary: country by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for Country responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/country/{id}: get: tags: - Geocoding summary: country by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for Country responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableCountryOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/locationCode: get: tags: - Geocoding summary: locationCode 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: locationCode schema: type: string description: location code, field represents a subregion such as postcode sector (UK), FSA (Canada) - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/locationCode: get: tags: - Geocoding summary: locationCode 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: locationCode schema: type: string description: location code, field represents a subregion such as postcode sector (UK), FSA (Canada) - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/locationCode: get: tags: - Geocoding summary: locationCode 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: locationCode schema: type: string description: location code, field represents a subregion such as postcode sector (UK), FSA (Canada) - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/locationCode: get: tags: - Geocoding summary: locationCode 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: locationCode schema: type: string description: location code, field represents a subregion such as postcode sector (UK), FSA (Canada) - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/locationCode: get: tags: - Geocoding summary: locationCode 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: locationCode schema: type: string description: location code, field represents a subregion such as postcode sector (UK), FSA (Canada) - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/locationCode: get: tags: - Geocoding summary: locationCode Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: locationCode schema: type: string description: location code, field represents a subregion such as postcode sector (UK), FSA (Canada) - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/locationCode/{id}: get: tags: - Geocoding summary: locationCode by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for location code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/locationCode/{id}: get: tags: - Geocoding summary: locationCode by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for location code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/locationCode/{id}: get: tags: - Geocoding summary: locationCode by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for location code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/locationCode/{id}: get: tags: - Geocoding summary: locationCode by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for location code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/locationCode/{id}: get: tags: - Geocoding summary: locationCode by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for location code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/locationCode/{id}: get: tags: - Geocoding summary: locationCode by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for location code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableLocationCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/postalCode: get: tags: - Geocoding summary: postalCode 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: postalCode schema: type: string description: Postal Code - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/postalCode: get: tags: - Geocoding summary: postalCode 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: postalCode schema: type: string description: Postal Code - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/postalCode: get: tags: - Geocoding summary: postalCode 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: postalCode schema: type: string description: Postal Code - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/postalCode: get: tags: - Geocoding summary: postalCode 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: postalCode schema: type: string description: Postal Code - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/postalCode: get: tags: - Geocoding summary: postalCode 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: postalCode schema: type: string description: Postal Code - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/postalCode: get: tags: - Geocoding summary: postalCode Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: admin1Code schema: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces - in: query name: admin2Code schema: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties - in: query name: postalCode schema: type: string description: Postal Code - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/postalCode/{id}: get: tags: - Geocoding summary: postalCode by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for postal code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/postalCode/{id}: get: tags: - Geocoding summary: postalCode by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for postal code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/postalCode/{id}: get: tags: - Geocoding summary: postalCode by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for postal code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/postalCode/{id}: get: tags: - Geocoding summary: postalCode by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for postal code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/postalCode/{id}: get: tags: - Geocoding summary: postalCode by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for postal code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/postalCode/{id}: get: tags: - Geocoding summary: postalCode by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for postal code responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTablePostalCodeOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/zone1: get: tags: - Geocoding summary: zone1 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone1Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/zone1: get: tags: - Geocoding summary: zone1 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone1Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/zone1: get: tags: - Geocoding summary: zone1 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone1Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/zone1: get: tags: - Geocoding summary: zone1 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone1Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/zone1: get: tags: - Geocoding summary: zone1 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone1Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/zone1: get: tags: - Geocoding summary: zone1 Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone1Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/zone1/{id}: get: tags: - Geocoding summary: zone1 by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for CRESTA zone. CRESTA represent globally uniform system for the accumulation risk control of natural hazards - particularly earthquakes, storms and floods responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/zone1/{id}: get: tags: - Geocoding summary: zone1 by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for CRESTA zone. CRESTA represent globally uniform system for the accumulation risk control of natural hazards - particularly earthquakes, storms and floods responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/zone1/{id}: get: tags: - Geocoding summary: zone1 by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for CRESTA zone. CRESTA represent globally uniform system for the accumulation risk control of natural hazards - particularly earthquakes, storms and floods responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/zone1/{id}: get: tags: - Geocoding summary: zone1 by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for CRESTA zone. CRESTA represent globally uniform system for the accumulation risk control of natural hazards - particularly earthquakes, storms and floods responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/zone1/{id}: get: tags: - Geocoding summary: zone1 by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for CRESTA zone. CRESTA represent globally uniform system for the accumulation risk control of natural hazards - particularly earthquakes, storms and floods responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/zone1/{id}: get: tags: - Geocoding summary: zone1 by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for CRESTA zone. CRESTA represent globally uniform system for the accumulation risk control of natural hazards - particularly earthquakes, storms and floods responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone1Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/zone3: get: tags: - Geocoding summary: zone3 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone3Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/zone3: get: tags: - Geocoding summary: zone3 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone3Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/zone3: get: tags: - Geocoding summary: zone3 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone3Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/zone3: get: tags: - Geocoding summary: zone3 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone3Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/zone3: get: tags: - Geocoding summary: zone3 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone3Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/zone3: get: tags: - Geocoding summary: zone3 Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone3Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/zone3/{id}: get: tags: - Geocoding summary: zone3 by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 3. Zone2 represents low-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/zone3/{id}: get: tags: - Geocoding summary: zone3 by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 3. Zone2 represents low-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/zone3/{id}: get: tags: - Geocoding summary: zone3 by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 3. Zone2 represents low-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/zone3/{id}: get: tags: - Geocoding summary: zone3 by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 3. Zone2 represents low-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/zone3/{id}: get: tags: - Geocoding summary: zone3 by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 3. Zone2 represents low-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/zone3/{id}: get: tags: - Geocoding summary: zone3 by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 3. Zone2 represents low-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone3Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/zone4: get: tags: - Geocoding summary: zone4 18.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone4Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/zone4: get: tags: - Geocoding summary: zone4 18.1 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone4Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/zone4: get: tags: - Geocoding summary: zone4 20.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone4Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/zone4: get: tags: - Geocoding summary: zone4 21.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone4Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/zone4: get: tags: - Geocoding summary: zone4 22.0 parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone4Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/zone4: get: tags: - Geocoding summary: zone4 Latest parameters: - in: query name: countryFips schema: type: string description: Country FIPS code - in: query name: zone4Name schema: type: string description: CRESTA zones - in: query name: limit schema: type: integer maximum: 1000 default: 100 description: The numbers of items to return - in: query name: offset schema: type: integer default: 0 description: The number of items to skip before starting to collect the result set responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4ListOutput' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '500': $ref: '#/components/responses/500Response' /geocode/18.0/zone4/{id}: get: tags: - Geocoding summary: zone4 by ID 18.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 4. Zone2 represents high-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/18.1/zone4/{id}: get: tags: - Geocoding summary: zone4 by ID 18.1 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 4. Zone2 represents high-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/20.0/zone4/{id}: get: tags: - Geocoding summary: zone4 by ID 20.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 4. Zone2 represents high-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/21.0/zone4/{id}: get: tags: - Geocoding summary: zone4 by ID 21.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 4. Zone2 represents high-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/22.0/zone4/{id}: get: tags: - Geocoding summary: zone4 by ID 22.0 parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 4. Zone2 represents high-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' /geocode/latest/zone4/{id}: get: tags: - Geocoding summary: zone4 by ID Latest parameters: - in: path name: id required: true schema: type: integer format: int64 description: Globally unique ID for zone 4. Zone2 represents high-resolution CRESTA zone responses: '200': description: Everything worked as expected. content: application/json: schema: $ref: '#/components/schemas/ReferenceTableZone4Output' '400': $ref: '#/components/responses/400Response' '401': $ref: '#/components/responses/401Response' '404': $ref: '#/components/responses/404Response' '500': $ref: '#/components/responses/500Response' components: schemas: ErrorItem: type: object properties: code: type: string example: ERR_XXXX description: 'Error codes: | Code | Description | |----------|-------------| | ERR_4000 | No details found for requested layer. | | ERR_4001 | Insufficient geocoding information. A required field is missing. | | ERR_4002 | Insufficient geocoding resolution to look up requested data. | | ERR_4003 | Location is in a region that is not supported by this layer. | | ERR_4005 | Insufficient information to look up requested data. | | ERR_4041 | Invalid input. | | ERR_4100 | Invalid lookupType. Valid lookups are ''wetOrDry'', ''floodDepth'', and ''proximity''. | | ERR_4101 | Invalid distanceUnit. Valid distanceUnits are ''meters'' and ''feet''. | | ERR_4102 | Invalid returnPeriod. Valid returnPeriods are 30, 50, 100, 200, 250, 500, and 1000. | | ERR_4103 | Invalid defended option. Valid defended options are ''true'' and ''false''. | | ERR_4104 | Invalid proximityDistance. Valid proximityDistances are positive numbers. | | ERR_4105 | Invalid distanceUnit. Valid distanceUnits are ''feet'', ''meters'', ''miles'', and ''km''. | | ERR_4106 | Insufficient information to look up requested data. Missing one or both of distanceUnit and proximityDistance. | | ERR_4300 | Invalid basement. Valid basements are ''yes'', ''no'', and ''default''. | | ERR_4400 | General error for the layer. | | ERR_4401 | Invalid address input. Incorrect field. | | ERR_4010 | Forbidden. | | ERR_4030 | Unauthorized. | | ERR_4040 | Not found. | | ERR_4050 | Method not allowed. | | ERR_4060 | Not acceptable. | | ERR_4080 | Request timeout. | | ERR_4130 | Request too large. | | ERR_4150 | Unsupported media type. | | ERR_4220 | Unprocessable entity. | | ERR_4290 | Quota exceeded. | | ERR_5000 | Internal server error. | | ERR_5040 | Gateway timeout. | ' message: type: string example: Error message ReferenceTablePostalCodeOutput: type: object properties: countryIso2a: type: string description: Country ISO2A code example: US maxLength: 2 countryFips: type: string description: Country FIPS code example: US maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: US maxLength: 4 countryName: type: string description: Name of Country example: United States maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 840 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: CA maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: CALIFORNIA maxLength: 256 admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 99999106 admin2Code: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: '001' maxLength: 16 admin2Name: type: string description: Name of administrative level 2 example: ALAMEDA COUNTY maxLength: 256 admin2GeoId: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: 99999206001 admin3Code: type: string description: Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: NE1 maxLength: 16 admin3Name: type: string description: Name of administrative level 3 example: '' maxLength: 256 admin3GeoId: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: 12695859 cityName: type: string description: Name of City/Town example: NEWARK maxLength: 256 cityGeoId: type: integer format: int64 description: Globally unique ID for City/Town example: 999993061080 postalCode: type: string description: Postal Code example: '94560' maxLength: 16 postalCodeGeoId: type: integer format: int64 description: Globally unique ID for postal code example: 99999494560 GeocodeInput: type: object required: - countryCode - countryScheme properties: id: type: integer format: int64 description: User defined id example: 0 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: CA maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: CALIFORNIA maxLength: 256 admin2Code: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: '001' maxLength: 16 admin2Name: type: string description: Name of administrative level 2 example: ALAMEDA COUNTY maxLength: 256 admin3Code: type: string description: Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: '' maxLength: 16 admin3Name: type: string description: Name of administrative level 3 example: '' maxLength: 256 admin4Code: type: string description: Code for administrative level 4 example: '044230130' maxLength: 16 admin4Name: type: string description: Name of administrative level 4 example: '044230130' maxLength: 256 cityName: type: string description: Name of City/Town example: NEWARK maxLength: 256 countryCode: type: string description: Country Code (optional for geocoding if latitude and longitude are provided) example: US maxLength: 4 countryName: type: string description: Name of Country example: United States maxLength: 512 countryScheme: type: string description: Standard for user-supplied country code (optional for geocoding if latitude and longitude are provided) example: ISO2A enum: - ISO2A - ISO3A - ISO3N - FIPS latitude: type: number format: double description: Location Latitude example: 37.54120000000001 minimum: -90 maximum: 90 longitude: type: number format: double description: Location Longitude example: -122.06061000000001 minimum: -180 maximum: 180 postalCode: type: string description: Postal Code example: '94560' maxLength: 16 streetAddress: type: string description: Address containing Number, Street Name, Street Type, etc. example: 7575 GATEWAY BLVD maxLength: 256 name: type: string description: Supplemental text captured for the address example: '' maxLength: 512 ReferenceTableCityListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableCityOutput' ReferenceTableZone4Output: type: object properties: countryIso2a: type: string description: Country ISO2A code example: CZ maxLength: 2 countryFips: type: string description: Country FIPS code example: EZ maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: CZ maxLength: 4 countryName: type: string description: Name of Country example: Czech Republic maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 203 zone4Name: type: string description: Name of CRESTA zone example: CZE_68742 maxLength: 256 zone4GeoId: type: integer format: int64 description: Globally unique ID for CRESTA zones. example: 64048047 ReferenceTableAdmin2Output: type: object properties: countryIso2a: type: string description: Country ISO2A code example: US maxLength: 2 countryFips: type: string description: Country FIPS code example: US maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: US maxLength: 4 countryName: type: string description: Name of Country example: United States maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 840 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: CA maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: CALIFORNIA maxLength: 256 admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 99999106 admin2Code: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: '001' maxLength: 16 admin2Name: type: string description: Name of administrative level 2 example: ALAMEDA COUNTY maxLength: 256 admin2GeoId: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: 99999206001 ReferenceTableAdmin1ListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableAdmin1Output' ReferenceTableLocationCodeListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableLocationCodeOutput' ReferenceTableZone1ListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableZone1Output' ReferenceTableAdmin4ListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableAdmin4Output' GeocodeOutput: type: object allOf: - $ref: '#/components/schemas/GeocodeInput' - type: object properties: admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 99999106 admin2GeoId: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: 99999206001 admin3GeoId: type: integer format: int64 description: Globally unique ID for administrative level 3. Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: 12695859 admin4GeoId: type: integer format: int64 description: Globally unique ID for administrative level 4. example: 62219571 admin5GeoId: type: integer format: int64 description: Globally unique ID for administrative level 5. example: 0 cityGeoId: type: integer format: int64 description: Globally unique ID for City/Town example: 999993061080 countryFips: type: string description: Country FIPS code example: US maxLength: 4 countryGeoId: type: integer description: Globally unique ID for Country example: 840 countryRmsCode: type: string description: RMS code for Country example: US maxLength: 4 geoDataSourceId: type: integer description: Geocode Data Source ID example: 8 geoMatchCode: type: string description: Code for portions of the input address that matched, did not match, or were modified during the geocoding process. example: T1-999993061080-T1A1-S0T100A100-S1A1-00-B-A-X maxLength: 255 locationCode: type: string description: Census Tract Number / Sonpo / Sector / Short Postal Code example: '060014443.01' maxLength: 16 locationCodeGeoId: type: integer format: int64 description: Unique identification code for the location example: 0 parcelId: type: integer format: int64 description: Parcel id example: 0 postalCodeGeoId: type: integer format: int64 description: Globally unique ID for postal code example: 99999494560 rmsGeoModelResolutionCode: type: integer description: 'Address match level: * `0` - None * `1` - Coordinate * `2` - Street / Parcel / Building * `3` - High Resolution Postcode / Other * `4` - Block Group/Census Tract * `5` - Postal code * `6` - Neighborhood * `7` - City * `8` - District / Municipality * `9` - County * `10` - State/Province * `11` - CRESTA * `12` - Multiple * `13` - User Defined * `14` - Country ' example: 2 minimum: 0 maximum: 14 rmsGeocodingResolutionCode: type: integer description: Indicates the geocoding resolutions that are supported by the ACORD standard example: 31 ugid: type: string description: Unique global identifier example: USS3121778167575 maxLength: 50 zone1Code: type: string description: CRESTA code example: A2 maxLength: 16 zone2Code: type: string description: zone2 code example: '' maxLength: 16 zone3Code: type: string description: zone3 code (Low Resolution CRESTA Zone) example: '' maxLength: 16 zone4Code: type: string description: zone4 code (High Resolution CRESTA Zone) example: '' maxLength: 16 zone3Name: type: string description: zone3 name (Low Resolution CRESTA Zone) example: '' maxLength: 256 zone4Name: type: string description: zone4 name (High Resolution CRESTA Zone) example: '' maxLength: 256 zone1GeoId: type: integer format: int64 description: Globally unique ID for Zone1 (CRESTA) example: 999995062 zone2GeoId: type: integer format: int64 description: Globally unique ID for Zone2 (CRESTA) example: 0 zone3GeoId: type: integer format: int64 description: Globally unique ID for Zone3 (Low Resolution CRESTA Zone) example: 22505979 zone4GeoId: type: integer format: int64 description: Globally unique ID for Zone4 (High Resolution CRESTA Zone) example: 20235111 dataVersion: type: string description: Data version example: xx.x.xxxx.x maxLength: 20 ReferenceTableAdmin4Output: type: object properties: countryIso2a: type: string description: Country ISO2A code example: PE maxLength: 2 countryFips: type: string description: Country FIPS code example: PE maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: PE maxLength: 4 countryName: type: string description: Name of Country example: Peru maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 604 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: '15' maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: Lima maxLength: 256 admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 2346482 admin2Code: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: '1501' maxLength: 16 admin2Name: type: string description: Name of administrative level 2 example: Lima maxLength: 256 admin2GeoId: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: 64079965 cityCode: type: string description: Code for city or town. example: '335570' maxLength: 16 cityName: type: string description: Name of city example: Lima CBD maxLength: 256 cityGeoId: type: integer format: int64 description: Globally unique ID for city or town. example: 30335570 admin4Code: type: string description: Code for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood/district. example: '71043' maxLength: 16 admin4Name: type: string description: Name of administrative level 4 example: Lima San Isidro CBD maxLength: 256 admin4GeoId: type: integer format: int64 description: Globally unique ID for administrative level 4. Admin4 represents smaller geographic divisions than Admin3, such as neighborhood/district. example: 71071043 ReferenceTableZone3Output: type: object properties: countryIso2a: type: string description: Country ISO2A code example: JP maxLength: 2 countryFips: type: string description: Country FIPS code example: JA maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: JP maxLength: 4 countryName: type: string description: Name of Country example: Japan maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 392 zone3Name: type: string description: Name of Low-resolution CRESTA Zone example: JPN_04 maxLength: 256 zone3GeoId: type: integer format: int64 description: Globally unique ID for Low-resolution CRESTA Zone. example: 64021802 ReferenceTableCityOutput: type: object properties: countryIso2a: type: string description: Country ISO2A code example: AG maxLength: 2 countryFips: type: string description: Country FIPS code example: AC maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: CB maxLength: 4 countryName: type: string description: Name of Country example: Antigua and Barbuda maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 28 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: '200' maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: Barbuda maxLength: 256 admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 60375118 admin2Code: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: '200' maxLength: 16 admin2Name: type: string description: Name of administrative level 2 example: Barbuda maxLength: 256 admin2GeoId: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: 2344541 admin3Code: type: string description: Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: '28200001' maxLength: 16 admin3Name: type: string description: Name of administrative level 3 example: AG001 maxLength: 256 admin3GeoId: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: 60372390 cityCode: type: string description: Code for City/Town example: '282001' cityName: type: string description: Name of City/Town example: The Caves maxLength: 256 cityGeoId: type: integer format: int64 description: Globally unique ID for City/Town example: 56228 ErrorOutput: type: object properties: contextId: type: string example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx additionalInfo: type: string example: '' errors: type: array items: $ref: '#/components/schemas/ErrorItem' ReferenceTableAdmin2ListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableAdmin2Output' ReferenceTableZone4ListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableZone4Output' ReferenceTableAdmin3ListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableAdmin3Output' ReferenceTableZone3ListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableZone3Output' ReferenceTableZone1Output: type: object properties: countryIso2a: type: string description: Country ISO2A code example: DK maxLength: 2 countryFips: type: string description: Country FIPS code example: DA maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: DK maxLength: 4 countryName: type: string description: Name of Country example: Denmark maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 208 zone1Name: type: string description: Name of CRESTA zone example: '3' maxLength: 256 zone1GeoId: type: integer format: int64 description: Globally unique ID for CRESTA zones. example: 60344626 ReferenceTablePostalCodeListOutput: type: array items: $ref: '#/components/schemas/ReferenceTablePostalCodeOutput' ReferenceTableLocationCodeOutput: type: object properties: countryIso2a: type: string description: Country ISO2A code example: GB maxLength: 2 countryFips: type: string description: Country FIPS code example: UK maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: GB maxLength: 4 countryName: type: string description: Name of Country example: United Kingdom maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 826 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: '103' maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: England maxLength: 256 admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 24554868 admin2Code: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: '103' maxLength: 16 admin2Name: type: string description: Name of administrative level 2 example: Dudley maxLength: 256 admin2GeoId: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: 30277299 admin3Code: type: string description: Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: E07CR0 maxLength: 16 admin3Name: type: string description: Name of administrative level 3 example: Dudley maxLength: 256 admin3GeoId: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts. example: 12695865 cityName: type: string description: Name of City/Town example: Halesowen maxLength: 256 cityGeoId: type: integer format: int64 description: Globally unique ID for City/Town example: 22165 locationCode: type: string description: Location Code example: B62 2 maxLength: 16 locationCodeGeoId: type: integer format: int64 description: Globally unique ID for postal code example: 60550885 ReferenceTableCountryOutput: type: object properties: countryIso2a: type: string description: Country ISO2A code example: US maxLength: 2 countryFips: type: string description: Country FIPS code example: US maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: US maxLength: 4 countryName: type: string description: Name of Country example: United States maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 840 ReferenceTableAdmin3Output: type: object properties: countryIso2a: type: string description: Country ISO2A code example: AE maxLength: 2 countryFips: type: string description: Country FIPS code example: AE maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: AE maxLength: 4 countryName: type: string description: Name of Country example: United Arab Emirates maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 784 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: '' maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: Dubai maxLength: 256 admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 2347111 admin2Code: type: string description: Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: '' maxLength: 16 admin2Name: type: string description: Name of administrative level 2 example: Dubai maxLength: 256 admin2GeoId: type: integer format: int64 description: Globally unique ID for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties. example: 61762805 admin3Code: type: string description: Code for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. example: '' maxLength: 16 admin3Name: type: string description: Name of administrative level 3 example: Umm Suqeim Second maxLength: 256 admin3GeoId: type: integer format: int64 description: Globally unique ID for administrative level 3. Admin3 represents smaller geographic divisions than Admin2, such as municipality. example: 61762880 ReferenceTableAdmin1Output: type: object properties: countryIso2a: type: string description: Country ISO2A code example: US maxLength: 2 countryFips: type: string description: Country FIPS code example: US maxLength: 4 countryRmsCode: type: string description: RMS code for Country example: US maxLength: 4 countryName: type: string description: Name of Country example: United States maxLength: 512 countryGeoId: type: integer description: Globally unique ID for Country example: 840 admin1Code: type: string description: Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: CA maxLength: 16 admin1Name: type: string description: Name of administrative level 1 example: CALIFORNIA maxLength: 256 admin1GeoId: type: integer format: int64 description: Globally unique ID for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces. example: 99999106 ReferenceTableCountryListOutput: type: array items: $ref: '#/components/schemas/ReferenceTableCountryOutput' responses: 404Response: description: Not found. content: application/json: schema: $ref: '#/components/schemas/ErrorOutput' 401Response: description: No valid API key provided. content: application/json: schema: $ref: '#/components/schemas/ErrorOutput' 500Response: description: Something went wrong on our end (this happens rarely) content: application/json: schema: $ref: '#/components/schemas/ErrorOutput' 400Response: description: The request was unacceptable, likely due to missing a required input. content: application/json: schema: $ref: '#/components/schemas/ErrorOutput' securitySchemes: RMS_Auth: type: apiKey name: Authorization in: header description: An API key is a token that enables a client application to make requests to tenant applications running on Intelligent Risk Platform. x-default: XXXXXXXXXX externalDocs: description: Find out more about RMS url: https://www.rms.com/programs/location-intelligence-api/ x-readme: explorer-enabled: false samples-languages: - curl - java - csharp - node - python proxy-enabled: true samples-enabled: true