Schema for NFP
This section provides an overview of the schemas related to the National Focal Point (NFP). Each schema details the structure and fields required for the NFP-related requests and responses.
NOTE
When making an API request using the National Focal Point (NFP) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "focalPoint"
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": "235A8B00-A995-5F7A-E827-FCC588C49C20", "schema": "focalPoint", "languages": ["en"] } | ||
government | Eterm | { "identifier": "1ECB698D-3F3D-41BC-BEBD-DD5C734BCDCF" } | ||
categories | string[] | [ "Test Category" ] | ||
description | string | Test Description | ||
title | lstring | { "en": "Test Information" } | ||
firstName | string | John | ||
middleName | string | Daniel | ||
lastName | string | Doe | ||
gender | Eterm | { "identifier": "1ECB698D-3F3D-41BC-BEBD-DD5C734BCDCF" } | ||
organization | lstring | { "en": "Test Information" } | ||
organizationAcronym | lstring | { "en": "Test Information" } | ||
organizationType | Eterm | { "identifier": "1ECB698D-3F3D-41BC-BEBD-DD5C734BCDCF" } | ||
designation | lstring | { "en": "Test Information" } | ||
department | lstring | { "en": "Test Information" } | ||
addressLine1 | lstring | { "en": "Test Information" } | ||
addressLine2 | lstring | { "en": "Test Information" } | ||
city | lstring | { "en": "Test Information" } | ||
state | lstring | { "en": "Test Information" } | ||
postalCode | lstring | { "en": "Test Information" } | ||
Country | country | Eterm | { "identifier": "1ECB698D-3F3D-41BC-BEBD-DD5C734BCDCF" } | |
phones | string[] | [ "5437897410" ] | ||
mobiles | string[] | [ "5437897410" ] | ||
faxes | string[] | [ "5437897410" ] | ||
emails | string[] | [ "test@email.com" ] | ||
websites | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] |