Responses and Errors

Tip

Read the MDN documentation about the HTTP response status code in MDN Web Docs.

Successful

`200 Ok`

Route	Response
`/scopus-survey/api`	Renders the application API web page
`/scopus-survey/api/search-articles`	Downloads the CSV file of found articles
`/scopus-survey/api/table`	Renders the articles table web page

Redirection

`307 Temporary Redirect`

Any request URL that is not in the /scopus-survey/api route will be redirected to it. Redirects any request that is trying to access a not found/non-existent route.

Client Error

`401 Unauthorized`

Exception Message	Description
`Missing required API Key query parameter`	Required `API Key` query parameter not found in the request
`Missing required Access Token header`	Required `Access Token` header not found in the request
`Invalid Access Token`	`Access Token` header has an invalid pattern or is incorrect

`404 Not Found`

Exception Message	Description
`No articles found`	No articles were found matching the `Keywords`. The total search results are zero

`422 Unprocessable Content`

Exception Message	Description
`Validation error in request <{...}>`	FastAPI exception from Pydantic. The request contains invalid data/errors
`Missing required Keywords query parameter`	Required `Keywords` query parameter not found in the request
`There must be at least two keywords`	The number of `Keywords` is below the minimum required. Submit at least two `Keywords` to perform the search
`Invalid Keyword`	The `Keyword` submitted has an invalid pattern

Server Error

`500 Internal Error`

Exception Message	Description
`Validation error in response <{...}>`	FastAPI exception from Pydantic. The response contains invalid data/errors
`Pydantic validation error: ... validation errors for ...`	Pydantic exception. There is an error in the data being validated
`Error in decoding response from Scopus API`	JSON exception. The response body does not contain valid JSON to decode
`Error in validate response from Scopus API`	Serialization error. JSON response contains unmapped/invalid fields
`Unexpected application interruption`	Shutdown signal exit interrupt exception
`Unexpected error <...>`	Any unmapped/common exception

`502 Bad Gateway`

Exception Message	Description
`Invalid response from Scopus Search API`	Response from Scopus Search API has no content/data
`Invalid response from Scopus Abstract Retrieval API`	Response from Scopus Abstract Retrieval API has no content/data
`Connection error in request`	A connection error occurred while trying to send the request
`Unexpected error from request <...>`	An unmapped error/exception occurred while trying to send the request
`Invalid response from Scopus Search API`	Scopus Search API HTTP status error exception
`Invalid response from Scopus Abstract Retrieval API`	Scopus Abstract Retrieval API HTTP status error exception

`504 Gateway Timeout`

Exception Message	Description
`Request connection timeout`	The request connection has timed out

Scopus APIs Status Error

Tip

Read the documentation about responses for the Scopus Search API and Scopus Abstract Retrieval API.

Status code	Description
400	Invalid request. Invalid information submitted
401	User cannot be authenticated due to missing/invalid credentials
403	User cannot be authenticated or entitlements cannot be validated
429	The requester has exceeded the quota limits associated with their `API Key`
500	Scopus API internal processing error