openapi: 3.0.3
info:
title: Call Forwarding Signal Age Verification Population Density Data API
description: '# Overview
The Call Forwarding Signal API provides the API Consumer with
information about the status of the Call Forwarding Service on a specific
phone number. The main scope of the Call Forwarding Signal API is "anti
Fraud" to avoid fraudsters to use the Call Forwarding Service to carry
on a scam. Other use cases are anyway supported by the Call Forwarding
Signal API that also
provides additional endpoints to detect the general Call Forwarding
Service settings.
# Introduction
The Call Forwarding Service is provided by the Network to a phone
number. This service redirects the incoming call to that phone number
to an alternative destination such as another phone number or a voice mail
system. There are two main types of call forwarding settings:
unconditional and conditional.
The Call Forwarding Signal API can be invoked to detect if the unconditional
call forwarding service is active. The Call Forwarding Signal API can also
be invoked to
get the general status of the Call Forwarding Service (inactive,
conditional, unconditional). If conditional call forwarding is active,
the different type of settings are returned (''conditional_busy'',
''conditional_not_reachable'', ''conditional_no_answer'').
**Example use cases:**
[**Bank Frauds**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8694420)
[**Alert Interception**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8701847)
[**Call Forwarding Verification**](https://github.com/camaraproject/CallForwarding\Signal/discussions/3#discussioncomment-8915595)
# Quick Start
The Call Forwarding Signal API is a REST API based on the
CreateCallForwardingSignal resource.
This resource can be used, by the API Consumer, to specify the phone number
on which the Call Forwarding Service status must be verified, in case of
two-legged authentication. If three-legged authentication is used the phone
number is instead detected, by the API Producer, from the access token.
Before starting to use the Call Forwarding API, the developer needs to know
about the below specified details:
**phoneNumber**
This is the end user phone number. The Call Forwarding Signal API verifies
if a call forwarding
service is active on this phone number. Note: this parameter must be
must be provided/valued only in case of two-legged authentication.
In case of three-legged authentication the phone number is retrieved by
the access token.
**CreateCallForwardingSignal**
This is the resource the API Consumer uses to define the phone number to
be verified about the status of the Network Call Forwarding service.
**UnconditionalCallForwardingSignal**
This is the resource the API Consumer gets back, containing the information
about the Unconditional Call Forwarding Service status for the given phone
number (PhoneNumber).
**CallForwardingSignal**
This is the resource the API Consumer gets back, containing the information
about the general status of the Network Call Forwarding service for the
specified phone number.
The Call Forwarding Signal API provides two endpoints fulfilling the
following intents:
- **unconditional-call-forwardings**: Is the unconditional call fwd service
active on a specific phone number?
- **call-forwardings**: Which is the status of the call forwarding for a
specific phone number?
# API Documentation
## Details
The Call Forwarding Signal API is invoked by an API Consumer after the
Consent Management flow.
The API Consumer can request the API Producer for the status of the
Unconditional Call Forwarding service using the
unconditional-call-forwardings POST method. A boolean, with the information
about the activation status of the call forwarding service, will be
provided back via the UnconditionalCallForwardingSignal resource.
The API Consumer can also request the API Producer for the generic status of
the Call Forwarding service using the call-forwardings POST method. An array
of strings with the information of the type of active call forwarding
services will be provided back via the CallForwardingSignal resource.
# Authorization and authentication
The "Camara Security and Interoperability Profile" provides details of how
an API consumer requests an access token. Please refer to Identity and
Consent Management
(https://github.com/camaraproject/IdentityAndConsentManagement/)
for the released version of the profile.
The specific authorization flows to be used will be agreed upon during the
onboarding process, happening between the API consumer and the API
provider, taking into account the declared purpose for accessing the API,
whilst also being subject to the prevailing legal framework dictated by
local legislation.
In cases where personal data is processed by the API and users can
exercise their rights through mechanisms such as opt-in and/or opt-out,
the use of three-legged access tokens is mandatory. This ensures that
the API remains in compliance with privacy regulations, upholding the
principles of transparency and user-centric privacy-by-design.
# Identifying the phone number from the access token
This API requires the API consumer to identify a phone number as the
subject of the API as follows:
- When the API is invoked using a two-legged access token, the subject
will be identified from the optional `phoneNumber` object field, which
therefore MUST be provided.
- When a three-legged access token is used however, this optional
identifier MUST NOT be provided, as the subject will be uniquely
identified from the access token.
This approach simplifies API usage for API consumers using a
three-legged access token to invoke the API by relying on the
information that is associated with the access token and was
identified during the authentication process.
## Error handling:
- If the subject cannot be identified from the access token and the
optional `phoneNumber` object field is not included in the request, then
the server will return an error with the
`422 MISSING_IDENTIFIER` error code.
- If the subject can be identified from the access token and the
optional `phoneNumber` object field is also included in the request, then
the server will return an error with the `422 UNNECESSARY_IDENTIFIER`
error code. This will be the case even if the same device is
identified by these two methods, as the server is unable to make
this comparison.
# Additional CAMARA error responses
The list of error codes in this API specification is not exhaustive.
Therefore the API specification may not document some non-mandatory error
statuses as indicated in `CAMARA API Design Guide`.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release
associated to this API version for a complete list of error responses.
The applicable Commonalities Release can be identified in the
`API Readiness Checklist` document associated to this API version.
As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible
error response if it is explicitly documented in the API.
# FAQ''s
(FAQs will be added in a later version of the documentation)
'
version: wip
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
x-camara-commonalities: 0.6
servers:
- url: '{apiRoot}/call-forwarding-signal/vwip'
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
tags:
- name: Population Density Data
description: Operations to retrieve population density information.
paths:
/retrieve:
post:
tags:
- Population Density Data
summary: Retrieves population density information in a specified area
description: Retrieves population density estimation together with the estimation range related for a time slot for a given area (described as a polygon) as a data set consisting of a sequence of equally-sized objects covering the input polygon area.
operationId: retrievePopulationDensity
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PopulationDensityRequest'
example:
area:
areaType: POLYGON
boundary:
- latitude: 45.754114
longitude: 4.860374
- latitude: 45.753845
longitude: 4.863185
- latitude: 45.75249
longitude: 4.861876
- latitude: 45.751224
longitude: 4.861125
- latitude: 45.751442
longitude: 4.859827
startTime: '2024-04-23T14:44:18.165Z'
endTime: '2024-04-23T14:44:18.165Z'
precision: 7
required: true
callbacks:
populationDensityDataCallback:
'{$request.body#/sink}':
post:
tags:
- Population Density Data
summary: Population Density Data callback
description: 'Important: this endpoint is to be implemented by the API consumer.
The Population Density Data server will call this endpoint when the request result is ready.
'
operationId: postNotification
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: Population density data result.
content:
application/json:
schema:
$ref: '#/components/schemas/PopulationDensityAsyncResponse'
examples:
PopulationDensitySupportedAreaAsyncResponseExample:
$ref: '#/components/examples/PopulationDensitySupportedAreaAsyncResponseExample'
PopulationDensityAreaNotSupportedAsyncResponseExample:
$ref: '#/components/examples/PopulationDensityAreaNotSupportedAsyncResponseExample'
PopulationDensityPartOfAreaNotSupportedAsyncResponseExample:
$ref: '#/components/examples/PopulationDensityPartOfAreaNotSupportedAsyncResponseExample'
PopulationDensityOperationNotCompletedExample:
$ref: '#/components/examples/PopulationDensityOperationNotCompletedExample'
responses:
'204':
description: Successful notification
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
'400':
$ref: '#/components/responses/Generic400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'410':
$ref: '#/components/responses/Generic410'
'429':
$ref: '#/components/responses/Generic429'
security:
- {}
- notificationsBearerAuth: []
responses:
'200':
description: Population density data result.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/PopulationDensityResponse'
examples:
PopulationDensitySupportedAreaResponseExample:
$ref: '#/components/examples/PopulationDensitySupportedAreaResponseExample'
PopulationDensityAreaNotSupportedResponseExample:
$ref: '#/components/examples/PopulationDensityAreaNotSupportedResponseExample'
PopulationDensityPartOfAreaNotSupportedResponseExample:
$ref: '#/components/examples/PopulationDensityPartOfAreaNotSupportedResponseExample'
'202':
description: Population density data requested. This response is returned when the behaviour of the API is asynchronous.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptedAsyncResponse'
'400':
$ref: '#/components/responses/RetrieveLocationBadRequest400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'404':
$ref: '#/components/responses/Generic404'
'422':
$ref: '#/components/responses/RetrieveLocationUnprocessableContent422'
'429':
$ref: '#/components/responses/Generic429'
security:
- openId:
- population-density-data:read
components:
parameters:
x-correlator:
name: x-correlator
in: header
description: Correlation id for the different services.
schema:
$ref: '#/components/schemas/XCorrelator'
examples:
PopulationDensitySupportedAreaResponseExample:
value:
status: SUPPORTED_AREA
timedPopulationDensityData:
- startTime: '2024-01-03T10:00:00Z'
endTime: '2024-01-03T11:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 150
minPplDensity: 30
pplDensity: 60
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 40
pplDensity: 90
- geohash: ezdqemu
dataType: LOW_DENSITY
- startTime: '2024-01-03T11:00:00Z'
endTime: '2024-01-03T12:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 30
pplDensity: 70
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
- geohash: ezdqemu
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
PopulationDensityAreaNotSupportedResponseExample:
value:
status: AREA_NOT_SUPPORTED
timedPopulationDensityData: []
PopulationDensityOperationNotCompletedExample:
value:
status: OPERATION_NOT_COMPLETED
timedPopulationDensityData: []
statusInfo: Some error happened during the processing of the request
operationId: 2322f362-eaab-4cf3-86d2-efcbdf3a7cb4
PopulationDensitySupportedAreaAsyncResponseExample:
value:
status: SUPPORTED_AREA
timedPopulationDensityData:
- startTime: '2024-01-03T10:00:00Z'
endTime: '2024-01-03T11:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 150
minPplDensity: 30
pplDensity: 60
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 40
pplDensity: 90
- geohash: ezdqemu
dataType: LOW_DENSITY
- startTime: '2024-01-03T11:00:00Z'
endTime: '2024-01-03T12:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 30
pplDensity: 70
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
- geohash: ezdqemu
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
operationId: 2322f362-eaab-4cf3-86d2-efcbdf3a7cb4
PopulationDensityAreaNotSupportedAsyncResponseExample:
value:
status: AREA_NOT_SUPPORTED
timedPopulationDensityData: []
operationId: 2322f362-eaab-4cf3-86d2-efcbdf3a7cb4
PopulationDensityPartOfAreaNotSupportedResponseExample:
value:
status: PART_OF_AREA_NOT_SUPPORTED
timedPopulationDensityData:
- startTime: '2024-01-03T10:00:00Z'
endTime: '2024-01-03T11:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 150
minPplDensity: 30
pplDensity: 60
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 40
pplDensity: 90
- geohash: ezdqemu
dataType: NO_DATA
- startTime: '2024-01-03T11:00:00Z'
endTime: '2024-01-03T12:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 30
pplDensity: 70
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
- geohash: ezdqemu
dataType: NO_DATA
PopulationDensityPartOfAreaNotSupportedAsyncResponseExample:
value:
status: PART_OF_AREA_NOT_SUPPORTED
timedPopulationDensityData:
- startTime: '2024-01-03T10:00:00Z'
endTime: '2024-01-03T11:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 150
minPplDensity: 30
pplDensity: 60
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 40
pplDensity: 90
- geohash: ezdqemu
dataType: NO_DATA
- startTime: '2024-01-03T11:00:00Z'
endTime: '2024-01-03T12:00:00Z'
cellPopulationDensityData:
- geohash: ezdqemf
dataType: DENSITY_ESTIMATION
maxPplDensity: 100
minPplDensity: 30
pplDensity: 70
- geohash: ezdqemg
dataType: DENSITY_ESTIMATION
maxPplDensity: 200
minPplDensity: 40
pplDensity: 100
- geohash: ezdqemu
dataType: NO_DATA
operationId: 2322f362-eaab-4cf3-86d2-efcbdf3a7cb4
responses:
Generic410:
description: Gone
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 410
code:
enum:
- GONE
examples:
GENERIC_410_GONE:
description: Use in notifications flow to allow API Consumer to indicate that its callback is no longer available
value:
status: 410
code: GONE
message: Access to the target resource is no longer available.
Generic429:
description: Too Many Requests
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 429
code:
enum:
- QUOTA_EXCEEDED
- TOO_MANY_REQUESTS
examples:
GENERIC_429_QUOTA_EXCEEDED:
description: Request is rejected due to exceeding a business quota limit
value:
status: 429
code: QUOTA_EXCEEDED
message: Out of resource quota.
GENERIC_429_TOO_MANY_REQUESTS:
description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached
value:
status: 429
code: TOO_MANY_REQUESTS
message: Rate limit reached.
Generic400:
description: Problem with the client request
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
examples:
GENERIC_400_INVALID_ARGUMENT:
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or query param.
RetrieveLocationBadRequest400:
description: "Problem with the client request. In addition to generic scenarios of `INVALID_ARGUMENT`, `INVALID_CREDENTIAL`, `INVALID_TOKEN`, another scenarios may exist:\n - The area is not a polygon shape or exceeds supported complexity (\"code\": \"POPULATION_DENSITY_DATA.INVALID_AREA\", \"message\": \"The area is not a polygon shape or exceeds supported complexity\")\n - Indicated `startTime` is greater than the maximum allowed (\"code\": \"POPULATION_DENSITY_DATA.MAX_STARTTIME_EXCEEDED\", \"message\": \"Indicated startTime is greater than the maximum allowed\")\n - Indicated `startTime` is earlier than the minimum allowed (\"code\": \"POPULATION_DENSITY_DATA.MIN_STARTTIME_EXCEEDED\", \"message\": \"Indicated startTime is earlier than the minimum allowed\")\n - Indicated `endTime` is earlier than the `startTime` (\"code\": \"POPULATION_DENSITY_DATA.INVALID_END_TIME\", \"message\": \"Indicated endTime is earlier than the startTime\")\n - Indicated time period is partially in the past and partially in the future (\"code\": \"POPULATION_DENSITY_DATA.INVALID_TIME_PERIOD\", \"message\": \"time period is partially in the past and partially in the future\")\n - Indicated time period is greater than the maximum allowed (More than maximum hours between startTime and endTime) (\"code\": \"POPULATION_DENSITY_DATA.MAX_TIME_PERIOD_EXCEEDED\", \"message\": \"Indicated time period is greater than the maximum allowed (More than maximum hours between startTime and endTime)\")"
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
- INVALID_CREDENTIAL
- INVALID_TOKEN
- INVALID_SINK
- POPULATION_DENSITY_DATA.INVALID_AREA
- POPULATION_DENSITY_DATA.MAX_STARTTIME_EXCEEDED
- POPULATION_DENSITY_DATA.MIN_STARTTIME_EXCEEDED
- POPULATION_DENSITY_DATA.INVALID_END_TIME
- POPULATION_DENSITY_DATA.MAX_TIME_PERIOD_EXCEEDED
- POPULATION_DENSITY_DATA.INVALID_TIME_PERIOD
examples:
GENERIC_400_INVALID_ARGUMENT:
value:
status: 400
code: INVALID_ARGUMENT
message: Invalid input
GENERIC_400_INVALID_CREDENTIAL:
value:
status: 400
code: INVALID_CREDENTIAL
message: Only Access token is supported
GENERIC_400_INVALID_TOKEN:
value:
status: 400
code: INVALID_TOKEN
message: Only bearer token is supported
GENERIC_400_INVALID_SINK:
description: Invalid sink value
value:
status: 400
code: INVALID_SINK
message: sink not valid for the specified protocol
POPULATION_DENSITY_DATA_400_INVALID_AREA:
value:
status: 400
code: POPULATION_DENSITY_DATA.INVALID_AREA
message: The area is not a polygon shape or has an arbitrary complexity
POPULATION_DENSITY_DATA_400_MAX_STARTTIME_EXCEEDED:
value:
status: 400
code: POPULATION_DENSITY_DATA.MAX_STARTTIME_EXCEEDED
message: Indicated startTime is greater than the maximum allowed
POPULATION_DENSITY_DATA_400_MIN_STARTTIME_EXCEEDED:
value:
status: 400
code: POPULATION_DENSITY_DATA.MIN_STARTTIME_EXCEEDED
message: Indicated startTime is earlier than the minimum allowed
POPULATION_DENSITY_DATA_400_INVALID_END_TIME:
value:
status: 400
code: POPULATION_DENSITY_DATA.INVALID_END_TIME
message: Indicated endDate is earlier than the startTime
POPULATION_DENSITY_DATA_400_MAX_TIME_PERIOD_EXCEEDED:
value:
status: 400
code: POPULATION_DENSITY_DATA.MAX_TIME_PERIOD_EXCEEDED
message: Indicated time period is greater than the maximum allowed (More than maximum hours between startTime and endTime)
POPULATION_DENSITY_DATA_400_INVALID_TIME_PERIOD:
value:
status: 400
code: POPULATION_DENSITY_DATA.INVALID_TIME_PERIOD
message: Indicated time period is partially in the past and partially in the future
Generic401:
description: Unauthorized
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 401
code:
enum:
- UNAUTHENTICATED
examples:
GENERIC_401_UNAUTHENTICATED:
description: Request cannot be authenticated
value:
status: 401
code: UNAUTHENTICATED
message: Request not authenticated due to missing, invalid, or expired credentials.
RetrieveLocationUnprocessableContent422:
description: "Problem with the client request. The following scenarios may exist:\n - Indicated combination of area, time interval and precision is too big (\"code\": \"POPULATION_DENSITY_DATA.UNSUPPORTED_REQUEST\", \"message\": \"Indicated combination of area, time interval and precision is too big\")\n - Indicated cell precision (Geohash level) is not supported (\"code\": \"POPULATION_DENSITY_DATA.UNSUPPORTED_PRECISION\", \"message\": \"Indicated cell precision (Geohash level) is not supported\")\n - Indicated combination of area, time interval and precision is too big for a sync response (\"code\": \"POPULATION_DENSITY_DATA.UNSUPPORTED_SYNC_RESPONSE\", \"message\": \"Indicated combination of area, time interval and precision is too big for a sync response\")"
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 422
code:
enum:
- POPULATION_DENSITY_DATA.UNSUPPORTED_REQUEST
- POPULATION_DENSITY_DATA.UNSUPPORTED_PRECISION
- POPULATION_DENSITY_DATA.UNSUPPORTED_SYNC_RESPONSE
examples:
POPULATION_DENSITY_DATA_422_UNSUPPORTED_REQUEST:
value:
status: 422
code: POPULATION_DENSITY_DATA.UNSUPPORTED_REQUEST
message: Indicated combination of area, time interval and precision is too big for both synchronous and asynchronous processing
POPULATION_DENSITY_DATA_422_UNSUPPORTED_PRECISION:
value:
status: 422
code: POPULATION_DENSITY_DATA.UNSUPPORTED_PRECISION
message: Indicated cell precision (Geohash length) is not supported
POPULATION_DENSITY_DATA_422_UNSUPPORTED_SYNC_RESPONSE:
value:
status: 422
code: POPULATION_DENSITY_DATA.UNSUPPORTED_SYNC_RESPONSE
message: Indicated combination of area, time interval and precision is too big for synchronous processing and asynchronous processing is not enabled
Generic403:
description: Forbidden
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 403
code:
enum:
- PERMISSION_DENIED
examples:
GENERIC_403_PERMISSION_DENIED:
description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
value:
status: 403
code: PERMISSION_DENIED
message: Client does not have sufficient permissions to perform this action.
Generic404:
description: Not found
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 404
code:
enum:
- NOT_FOUND
examples:
GENERIC_404_NOT_FOUND:
description: Resource is not found
value:
status: 404
code: NOT_FOUND
message: The specified resource is not found.
schemas:
AreaType:
type: string
description: 'Type of this area.
POLYGON - The area is defined as a polygon.
'
enum:
- POLYGON
AcceptedAsyncResponse:
type: object
properties:
operationId:
$ref: '#/components/schemas/OperationId'
required:
- operationId
XCorrelator:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: b4333c46-49c0-4f62-80d7-f0ef930f1c46
PopulationDensityRequest:
type: object
description: 'Request object for retrieving population density data in a specified area. **NOTE**: The difference between `startTime` and `endTime` cannot be greater than 7 days.'
properties:
area:
$ref: '#/components/schemas/Area'
startTime:
type: string
format: date-time
description: Start date time. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/camara-project/refs/heads/main/openapi/camara-project-population-density-data-api-openapi.yml