Skip to content

Schema for CP

This section provides an overview of the schemas related to the Checkpoint (CP). Each schema details the structure and fields required for the CP-related requests and responses.

NOTE

When making an API request using the Checkpoint (CP) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "absCheckpoint" to ensure that the request is processed correctly and targets the appropriate data structure. Failure to provide the correct schema may result in an error or unexpected behavior in the response.

TitleFieldMandatoryTypeExample
headerEheader{ "identifier": "6BF5D309-6964-1993-0369-F3309CB48BB0", "schema": "absCheckpoint", "languages": ["en"] }
CountrygovernmentEterm{ "identifier": "us" }
Name of the checkpointnameTruelstring{ "en": "Test Checkpoint" }
Short description of any additional responsibilities (maximum 300 characters)responsibilitiesTruelstring{ "en": "<div><!--block-->Test description</div>" }
Area of jurisdiction:jurisdictionEterm{ "identifier": "7437F880-7B12-4F26-AA91-CED37250DD0A" }
Name of the sub-national jurisdictionjurisdictionNamelstring{ "en": "Test Sub jurisdiction" }
Send a copy of the communiqué to all competent national authorities within my countryinformAllAuthoritiesTrueboolTrue
Please select any national authorities whom you wish to send a copy of the communiquécontactsToInformEreference[][ { "identifier": "DECLARE-ORGANISATION_13394_20240830135408832@1" } ]
Additional InformationrelevantInformationlstring{ "en": "<div><!--block-->Test Information</div>" }
Other relevant website addresses and/or attached documentsrelevantDocumentsElink[][ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]