Schema for PRO
This section provides an overview of the schemas related to the ABS Procedures (PRO). Each schema details the structure and fields required for the PRO-related requests and responses.
NOTE
When making an API request using the ABS Procedures (PRO) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "absProcedure"
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": "83B2A1B2-95A5-6723-6C0D-28BC3143B321", "schema": "absProcedure", "languages": ["en"] } | ||
Country | government | True | Eterm | { "identifier": "af" } |
This is an ABS procedure for: | name | True | lstring | { "en": "Test Info" } |
Area of jurisdiction | jurisdiction | True | Eterm | { "identifier": "5B6177DD-5E5E-434E-8CB7-D63D67D5EBED", "customValue": { "en": "Test Jurisdiction" } } |
Where should applications for access be made? | contacts | True | Ereference[] | [{ "identifier": "DECLARE-ORGANISATION_24185_20241104154859186@1" }] |
Where should applications for access be made? | links | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] | |
What are the conditions or requirements a potential user needs to fulfil to apply for access? | requirements | lstring | { "en": " | |
Please provide a step-by-step description or a visual representation of the ABS procedure | description | lstring | { "en": " | |
For example, you may wish to attach a flow chart or timeline. | descriptionLinks | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] | |
Does the applicant need to provide any documents? | hasApplicationDocuments | True | bool | True |
Please provide information on application forms or required documents (e.g.: copy of applicant’s national passport) | applicationInformation | lstring | { "en": " | |
Please attach relevant application form/documents or provide a link to website | applicationLinks | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] | |
Please provide information on whom the application should be sent to | applicationContacts | Ereference[] | [{ "identifier": "DECLARE-ORGANISATION_24185_20241104154859186@1" }] | |
Are there application fees? | hasApplicationFees | True | bool | True |
Please provide any additional information on application fees | applicationFeesInformation | lstring | { "en": " | |
How long does the application process take | duration | int | 3 | |
Days Months Years | durationPeriod | string | months | |
Relevant ABS measure(s) | relevantMeasures | Ereference[] | [{ "identifier": "A3722021-0CC0-B195-75BE-954F133FF78B@1" }] | |
Keywords | keywords | Eterm[] | [{ "identifier": "EC94899F15EE40C6A0F7D0B1F774A521" }] | |
Please use this field to provide any other relevant information that may not have been addressed elsewhere in the record. | relevantInformation | lstring | { "en": " | |
Other relevant website addresses and/or attached documents | relevantDocuments | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] |