Schema for CPC
This section provides an overview of the schemas related to the Checkpoint Communiqué (CPC). Each schema details the structure and fields required for the CPC-related requests and responses.
NOTE
When making an API request using the Checkpoint Communiqué (CPC) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "absCheckpointCommunique"
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.
Title | Field | Mandatory | Type | Example |
---|---|---|---|---|
header | Eheader | { "identifier": "63B9CA56-9D43-E877-2A96-2C95986522D5", "schema": "absCheckpointCommunique", "languages": ["en"] } | ||
Title of this checkpoint communique | title | True | lstring | { "en": "Test Title" } |
Country issuing this checkpoint communique | government | True | Eterm | { "identifier": "af" } |
Links to internationally recognized certificate(s) of compliance (IRCC) that relate to this communique | absIRCCs | True | Ereference[] | [ { "identifier": "CB51626B-CF45-2AA0-3A24-459669DDCC34@1" } ] |
Checkpoint/s that collected or received the information | absCheckpoints | True | Ereference[] | [ { "identifier": "3E387C20-E70C-997B-EABB-BC4C9A1E142F@1" } ] |
The internationally recognized certificate of compliance (IRCC) is not available | absIRCCsNotAvailable | bool | True | |
Source of the genetic resource | sourceCountries | Eterm[] | [ { "identifier": "af" } ] | |
Person or entity who granted prior informed consent (PIC) | entityWhoGrantedPIC | Ereference | { "identifier": "DECLARE-ORGANISATION_19584_20241007134350919@1" } | |
Subject-matter or genetic resources relevant to the information collected or received | subjectMatter | lstring | { "en": "<div><!--block-->Test Info</div>" } | |
Specimen data | specimens | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] | |
Taxonomy | taxonomies | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] | |
Geographic coordinates | gisFiles | Elink[] | [ { "url": "/api/v2013/documents/63B9CA56-9D43-E877-2A96-2C95986522D5/attachments/615856/test.json", "name": "test.json", "tag": "Test Tag", "language": "en" } ] | |
gisMapCenter | EmapLocation | |||
Person or entity making information available to the checkpoint on the utilization of the genetic resource | personsAtCheckpoint | Ereference[] | [ { "identifier": "DECLARE-ORGANISATION_19584_20241007134350919@1" } ] | |
Reference or evidence of prior informed consent (PIC) | evidenceOfPIC | lstring | { "en": "<div><!--block-->Test Info</div>" } | |
Reference or evidence of establishment of mutually agreed terms (MAT) | evidenceOfMAT | lstring | { "en": "<div><!--block-->Test Info</div>" } | |
Person or entity to whom prior informed consent (PIC) was granted | entityToWhomPICGranted | Ereference | { "identifier": "DECLARE-ORGANISATION_19584_20241007134350919@1" } | |
Short description of the information collected or received by the checkpoint relevant to the utilization of genetic resources, including the type of use | description | True | lstring | { "en": "<div><!--block-->Test Info</div>" } |
Date of access to the genetic resources | dateOfAccess | DateTime | 2024-10-24 | |
Date on which the information was collected or received at the checkpoint | dateCollected | DateTime | 2024-10-26 | |
FROM | dateCollectedFrom | DateTime | 2024-10-01 | |
TO | dateCollectedTo | DateTime | 2024-10-23 | |
Additional Information | relevantInformation | lstring | { "en": "<div><!--block-->Test Info</div>" } | |
Other relevant website addresses and/or attached documents | relevantDocuments | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] | |
Keywords to describe the subject-matter or genetic resource(s) covered by the permit or its equivalent | keywords | Eterm[] | [ { "identifier": "term-id-1" }, { "identifier": "term-id-2" } ] | |
Other keywords | keywordOther | lstring | { "en": "Test Keywords" } |