Schema for IRCC

This section provides an overview of the schemas related to the Internationally Recognized Certificates of Compliance (IRCC). Each schema details the structure and fields required for the IRCC-related requests and responses.

NOTE

When making an API request using the Internationally Recognized Certificates of Compliance (IRCC) schema, it is essential to include the correct schema identifier. The schema parameter must be set to "absPermit" to ensure that the request is processed accurately and interacts with the correct data structure. Using an incorrect schema may lead to errors or unintended results in the API response.

The table below outlines the structure of the request body, including the fields, their types, and whether they are mandatory. Example values are provided for clarity.

Title	Field	Mandatory	Type	Example
	header		Eheader	{ "identifier": "CB51626B-CF45-2AA0-3A24-459669DDCC34", "schema": "absPermit", "languages": [ "en" ] }
Country	government	True	Eterm	{"identifier": "af"}
	updateReason		lstring
Competent national authority (CNA) responsible for issuing this permit or its equivalent	absCNA	True	Ereference	{"identifier": "C84C7E6C-134C-F1B1-9A3B-B7443F135239@2"}
Reference number of the permit or its equivalent	title	True	lstring	{"en": "123456"}
Additional national references or identifiers	referenceToNationalPermit		lstring	{"en": "strsgfsgfdxgf"}
Date of issuance of the permit or its equivalent	dateOfIssuance	True	Date (YYYY-MM-DD)	"2024-07-02"
Prior Informed Consent (PIC) Information (Select any of the two from below)
The provider	providers	True	Ereference[]	[ { "identifier": "DECLARE-ORGANISATION_3386_20240709020251617@1" } ]
This information is confidential	providersConfidential		bool	{providersConfidential: true}
Person or entity to whom prior informed consent (PIC) was granted
	entitiesToWhomPICGranted	True	Ereference[]	[ { "identifier": "DECLARE-ORGANISATION_3386_20240709020251617@1" } ]
This information is confidential	entitiesToWhomPICGrantedConfidential		bool	true
Subject-matter or genetic resource (Select any of the two from below)
1. Subject-matter or genetic resources covered by the permit or its equivalent	subjectMatter	True	lstring	{"en": " asdf " }
2. This information is confidential	subjectMatterConfidential		bool	{subjectMatterConfidential: true}
Keywords to describe the subject-matter or genetic resource(s) covered by the permit or its equivalent	keywords		Eterm[]	[ { "identifier": "357DBB22-6A6C-4C49-BA1F-037320B09247" } ]
Other keywords	keywordOther	True	lstring
Additional subject-matter or genetic resources information (Select any one of the three below)
1. Specimen data	specimens		Elink[]	[ { "url": "https://www.Google.com", "name": "Google", "language": "en" } ]
2. Taxonomy	taxonomies		Elink[]	[ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]
3. Geographic coordinates	gisFiles		Elink[]
	gisMapCenter		EmapLocation
Amendment intent	amendmentIntent	True	AmendmentIntent
Provide a summary of the reason for the update of the record	amendmentDescription	True	lstring
Confirmation that prior informed consent (PIC) was obtained or granted	picGranted	True	bool	true
Additional information about the prior informed consent (PIC)	picInformation		lstring	{ "en": " asdfasdfasdf " }
Additional information about the prior informed consent (PIC) - Documents	picDocuments		Elink[]	[ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]
Confirmation that mutually agreed terms (MAT) were established	matEstablished	True	bool	true
Additional information about the mutually agreed terms (MAT) - Information	matInformation		lstring	{ "en": " asdf " }
Additional information about the mutually agreed terms (MAT) - Documents	matDocuments		Elink[]	[ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]
Information on the utilization of the genetic resource(s) (Select any one of the below)
1. Indicate if the permit or its equivalent covers commercial and/or non-commercial use	usages	True	Eterm[]	[ { "identifier": "5E833A3F-87D1-4ADD-8701-9F1B76383017" } ]
2. This information is confidential	usagesConfidential		bool	true
Additional information about the specified uses covered by the permit or its equivalent or use restrictions	usagesDescription		lstring	{ "en": " asdf " }
Conditions for third party transfer	thirdPartyTransferCondition		lstring	{ "en": " asdf " }
Date of expiry of the permit or its equivalent	dateOfExpiry		Date	"2024-07-16"
Copy of the permit or its equivalent, or other relevant open-access document	permitFiles		Elink[]	[ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]
Short description of the attached link(s) and/or file(s)	permitDescription		lstring	{ "en": " asdf " }
Additional Information	relevantInformation		lstring	{ "en": " asfd " }
Other relevant website addresses and/or attached documents	relevantDocuments		Eterm[]	[ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]
Notes	notes		string	"[\"[ Pramod Sam | Jul 8, 2024 8:10:52 PM ] - aasdfasdf\"]"
Links to other internationally recognized certificate(s) of compliance (IRCC) that relate(s) to this permit	relatedIRCC		Ereference[]	[ { "identifier": "8C22B282-BE5A-72D8-C754-932CC49CC9B4@1" } ]