Schema for Contact
This section provides an overview of the schemas related to the Contact (CON). Each schema details the structure and fields required for the CON-related requests and responses.
NOTE
When making an API request using the Contact (CON) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "contact"
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.
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": "068C83BA-995F-08C3-50CE-AD43545B3EB5", "schema": "contact", "languages": [ "en" ] } | ||
Prefix | prefix | lstring | { en:"Mr" } | |
First Name | firstName | True | string | John |
Middle Name | middleName | string | Smith | |
Last Name | lastName | True | string | Doe |
Gender | gender | Eterm | ||
Job Title | designation | lstring | { en:"Software" } | |
Organization | organization | True | lstring | { "en": "Test Organization" } |
Acronym | organizationAcronym | lstring | { "en": "CSBD" } | |
Department / Division / Unit | department | lstring | { "en": "Division" } | |
Type of Organization | organizationType | Eterm | { "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" } | |
Street Address | address | lstring | { "en": "560 Franklin" } | |
City | city | lstring | { "en": "Cambridge" } | |
State or Province | state | lstring | { "en": "Ontario" } | |
Postal Code or Zip | postalCode | lstring | { "en": "N1R 7Z1" } | |
Country of Contact | country | True | Eterm | { "identifier": "ca" } |
Phone Number(s) | phones | string[] | [ "54825578896" ] | |
Fax Number(s) | faxes | string[] | [ "123456" ] | |
Email(s) | emails | True | string[] | [ "pramodjsam@gmail.com" ] |
Website Address(es) | websites | Elink[] | [ { "url": "http://www.google.com" } ] | |
Address Type | addressType | string | organization | |
Relevant Information | relevantInformation | lstring | ||
Relevant Documents | relevantDocuments | Elink[] | ||
Contact Type | type | True | string | person |
Country | government | Eterm | { "identifier": "af" } | |
Organization | contactOrganization | True | Ereference | { "identifier": "SIMP-22D52282-2FB2-AD2A-2965-476DFF6A7F37@1" } |