Skip to content

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.

TitleFieldMandatoryTypeExample
headerEheader { "identifier": "068C83BA-995F-08C3-50CE-AD43545B3EB5", "schema": "contact", "languages": [ "en" ] }
Prefixprefixlstring{ en:"Mr" }
First NamefirstNameTruestringJohn
Middle NamemiddleNamestringSmith
Last NamelastNameTruestringDoe
GendergenderEterm
Job Titledesignationlstring{ en:"Software" }
OrganizationorganizationTruelstring{ "en": "Test Organization" }
AcronymorganizationAcronymlstring{ "en": "CSBD" }
Department / Division / Unitdepartmentlstring{ "en": "Division" }
Type of OrganizationorganizationTypeEterm{ "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" }
Street Addressaddresslstring{ "en": "560 Franklin" }
Citycitylstring{ "en": "Cambridge" }
State or Provincestatelstring{ "en": "Ontario" }
Postal Code or ZippostalCodelstring{ "en": "N1R 7Z1" }
Country of ContactcountryTrueEterm{ "identifier": "ca" }
Phone Number(s)phonesstring[][ "54825578896" ]
Fax Number(s)faxesstring[][ "123456" ]
Email(s)emailsTruestring[][ "pramodjsam@gmail.com" ]
Website Address(es)websitesElink[][ { "url": "http://www.google.com" } ]
Address TypeaddressTypestringorganization
Relevant InformationrelevantInformationlstring
Relevant DocumentsrelevantDocumentsElink[]
Contact TypetypeTruestringperson
CountrygovernmentEterm{ "identifier": "af" }
OrganizationcontactOrganizationTrueEreference{ "identifier": "SIMP-22D52282-2FB2-AD2A-2965-476DFF6A7F37@1" }