Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Error codes returned by the page API.

Indicates provided URL used to identify a page .INVALIDIndicates provided URL is emptyINVALID

Error Code

 

 

Description

 

Applicable to

 

HTTP Status Code

 

Status

HTTP Status Code

Internal/Client Facing

Response Examples

INSUFFICIENT_CONTENT

  • Whenever the number of characters in the text associated with the page is less than 50 characters, the further processing of page ceases and the status is saved in the DB.

422 - Unprocessable Entity

-> Client facing.

Image Added

PAGE_CONTENT_CLASSIFICATION_FAILED

  • Denotes the failure of the classification process, is usually the client facing generic error code for more granular internal error codes to ease for debugging purposes.

500 - Internal Server Error

-> Client facing.

Image Added

TEXT_EXTRACTION_REQUEST_FAILED

  • After the downloading of the page, when the request by PCE send to Tapas for further text extraction fails, this status is saved in the DB.

500 - Internal Server Error

-> Internal.

-> Mapped to PAGE_CONTENT_CLASSIFICATION_FAILED

Image Added

IMAGE_CLASSIFIACTION_REQUEST_FAILED

  • After the downloading of the page, when the request by PCE send to prism for threat analysis on the OG image of the page fails, this status is saved in the DB.

500 - Internal Server Error

-> Internal.

-> Mapped to PAGE_CONTENT_CLASSIFICATION_FAILED

Image Added

TEXT_EXTRACTION_RESPONSE_NOT_SUPPORTED

  • During text extraction if tapas detects that the language of the text is not supported by the classification models, this status is returned to verity router which in turn stores it in the DB.

200 - OK

-> Internal.
-> Mapped to status field NOT_SUPPORTED in verity response.

Image Added

TEXT_EXTRACTION_RESPONSE_INTERNAL_ERROR

  • When tapas’s systems encounter any internal errors during the text extraction process, this status is returned to verity router and saved as this error code in the DB.

500 - Internal Server Error

-> Internal.

-> Mapped to PAGE_CONTENT_CLASSIFICATION_FAILED

Image Added

TEXT_EXTRACTION_RESPONSE_INTERNAL_UNKNOWN

  • Post the text extraction, verity router only recognises only three statuses from tapas - “SUCCESS”, “NOT_SUPPORTED” and “INTERNAL_ERROR”, any other status returned by tapas is saved as this error code in the DB by verity router. 

500 - Internal Server Error

-> Internal.

-> Mapped to PAGE_CONTENT_CLASSIFICATION_FAILED

Image Added

PAGE_CONTENT_EXTRACTION_FAILED_WITH_403_FORBIDDEN

  • This error code primarily denotes that the PCE which is responsible for downloading the contents of a page is being denied by the host site from doing so mostly due to missing authorisation credentials.

  • When a client sees this code, it needs to make sure that the correct request parameters and the necessary header values are being passed to verity while sending the requests.

422 - Unprocessable Entity

-> Client facing.

Image Added

PAGE_CONTENT_EXTRACTION_FAILED_WITH_404_NOT_FOUND

  • This error code denotes that the PCE which is responsible for downloading the contents of a page is unable to find the webpage for the requested URL.

  • On receiving this code the client needs to ensure that the correct values of the URL and the necessary authorisation header values are passed in as the request parameters.

422 - Unprocessable Entity

-> Client facing.

Image Added

PAGE_CONTENT_EXTRACTION_FAILED_WITH_500_INTERNAL_SERVER_ERROR

  • This error code denotes that the PCE is experiencing errors while trying to download the contents of a page.

  • On receiving this error code, the client may retry with the request again after a while.

422 - Unprocessable Entity

-> Client facing.

Image Added

PAGE_CONTENT_EXTRACTION_FAILED_WITH_4XX

  • This error code denotes that the PCE which is responsible for downloading the contents of a page is facing issues that are mostly from the client side.

  • On receiving this code the client needs to ensure that the correct values of the URL and the necessary authorisation header values are passed in as the request parameters.

422 - Unprocessable Entity

-> Client facing.

Image Added

PAGE_CONTENT_EXTRACTION_FAILED_WITH_5XX

  • This error code denotes that the PCE which is responsible for downloading the contents of a page is experiencing internal issues.

  •  On receiving this error code, the client may retry with the request again after a while.

422 - Unprocessable Entity

-> Client facing.

Image Added

PAGE_CONTENT_EXTRACTION_FAILED

  • A generic error code denoting the failure of the PCE from downloading all the contents of a page successfully. This code is usually saved in the DB along with a more granular error code describing the failure reason of PCE and the status.

  • If this is the sole code present for a page in DB, it means that tapas has failed to send any value for the expected status field.

422 - Unprocessable Entity

-> Client facing.

Image Added

URL_CANNOT_EXCEED_2048_BYTES

  • This error code shows that the

  • URL being passed in the request is greater than 2048 bytes

●      pageUrl

400

  • and this is deemed to be invalid as this is the limit of Dynamo Db’s partition key’s size limit.

  • One action client can take on seeing this error code is to ensure that the URL is being stripped from possible query parameters.

400 - Bad (Invalid) request.

-> Client facing.

Image Added

URL_MISSING_HTTP_PROTOCOLIndicates

  • This error code shows that the

provided
  • requested URL is

missing the `http
  • not adhering the HTTP protocol.

  • The client should ensure that the URL is beginning with `http://

`
  • ' or

`https
  • https://

` protocol

●      pageUrl

●      callBackUrl

400

INVALID

  • ' .

400 - Bad (Invalid) request.

-> Client facing.

Image Added

URL_MUST_NOT_BE_EMPTY

  • This error code denotes that the

●      pageUrl

●      callBackUrl

400

  • request is missing the URL. 

400 - Bad (Invalid) request.

-> Client facing.

Image Added

URL_MALFORMEDIndicates

  • This error code denotes that the

provided
  • URL being requested cannot be

parsed
  • associated to a standard RFC 2396

compatible
  • value

●      pageUrl

●      callBackUrl

400

INVALID

DOMAIN_BLOCKED_BY_VERITY

Indicates that Verity is prohibited from crawling content from the provided domain

●      pageUrl

422

NOT_SUPPORTED
  • .

400 - Bad (Invalid) request.

-> Client facing.

Image Added

URL_CANNOT_EXCEED_2048_BYTES

  • This error code shows that the URL being passed in the request is greater than 2048 bytes and this is deemed to be invalid as this is the limit of Dynamo Db’s partition key’s size limit.

  • One action client can take on seeing this error code is to ensure that the URL is being stripped from possible query parameters.

400 - Bad (Invalid) request.

-> Client facing.

Image Added