Page Comparison

...
Excerpt
This method returns information related with a contact information. Single contact information is returned by each call
Resource URL

Parameters

Name
Type
Description
token
String
The token retrieved from the login method
contact_information_identifier
(mandatory)
Identifier
The identifier of the contact information that should be returned as a result. The allowed contact information identifier fields are the following:
Include Page
	V4:contact_information_identifier
	V4:contact_information_identifier
fields_set
(optional)
List of Strings, comma separated
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Expand
title	Example 1
HTTP Method: GET
Request:
Response:
Code Block
language	javascript
theme	Confluence	language	javascript
linenumbers	true
    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "udf_string_10": null,
           "organizational_unit": 0,
           "udf_float_1": 10,
           "udf_string_11": null,
           "udf_float_2": 20,
		   "preferred_language": "ENG",
           "udf_string_12": null,
           "udf_float_3": 30,
           "udf_string_13": null,
           "udf_float_4": 40,
           "udf_string_14": null,
           "udf_float_5": 50,
           "udf_string_15": null,
           "udf_string_1": "udf string 1",
           "name": "Louis Kozior",
           "udf_string_16": null,
           "udf_float_6": 60,
           "udf_string_2": "udf string 2",
           "udf_float_7": 70,
           "udf_string_3": "udf string 3",
           "privacy_level":
           {
               "number": "8",
               "hierarchy_level": 0,
               "name": "Regular Customers",
               "id": "EDE9CDE326E4F9846A50D5BCF61CD720"
           },
           "company_name": null,
           "udf_float_8": 80,
           "udf_string_4": "udf string 4",
           "udf_string_5": "udf string 5",
           "udf_string_6": "udf string 6",
           "udf_string_7": "udf string 7",
           "udf_string_8": "udf string 16",
           "udf_string_9": null,
           "last_name": "Kozior",
           "id": "1F1D2D0DFD164BFA801BE87CA9E33915",
           "relation_set":
           [
               {
                   "contact":
                   {
                       "last_name": "Kozior",
                       "life_cycle_state": "MARKETING",
                       "middle_name": "Aloz",
                       "company_profile": null,
                       "title": "Sir",
                       "type": "PERSON",
                       "first_name": "Louis",
                       "name": null,
                       "id": "1F1D2D0DFD164BFA801BE87CA9E33915",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "FEMALE",
                           "passport_number": "CD112234",
                           "social_security_number": "EF112234",
                           "date_of_birth":
                           {
                               "month": 5,
                               "day": 12,
                               "year": 1981
                           },
                           "name_day":
                           {
                               "month": 8,
                               "day": 18
                           },
                           "id_number": "AB112234"
                       }
                   },
                   "notes": null,
                   "type": "Family Member",
                   "id": "52062CE827B445DDA9100F2BDB04F06D"
               }
           ],
           "log_information":
           {
               "updated_date": "2015-04-28T16:51:51",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-04-28T16:51:50",
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               }
           },
           "life_cycle_state": "MARKETING",
           "first_name": "Louis",
           "type": "PERSON",
           "notes": "Marios Lannister 28/4/2015 16:51:51 Family",
           "addresses_set":
           [
               {
                   "care_of": "Maria Kyriacou",
                   "street_number": "8",
                   "udf_string_10": null,
                   "udf_float_1": 10,
                   "udf_string_11": null,
                   "street_name": "Ilia Papakiriakou",
                   "udf_float_2": 20,
                   "udf_string_12": null,
                   "udf_float_3": 30,
                   "udf_string_13": null,
                   "udf_float_4": 40,
                   "udf_string_14": null,
                   "udf_string_15": null,
                   "po_box": "70022",
                   "udf_string_1": "udf string 1",
                   "udf_string_16": null,
                   "udf_string_2": "udf string 2",
                   "floor": 2,
                   "udf_string_3": "udf string 3",
                   "area": "Plati",
                   "udf_string_4": "udf string 4",
                   "district": "Nicosia",
                   "udf_string_5": "udf string 5",
                   "udf_string_6": "udf string 6",
                   "udf_string_7": "udf string 7",
                   "state": "Active",
                   "udf_string_8": "udf string 16",
                   "udf_string_9": null,
                   "country":
                   {
                       "three_character_code": "CYP",
                       "two_character_code": "CY",
                       "name": "CYPRUS",
                       "id": "181",
                       "alternative_code": null
                   },
                   "id": "A939A8F2FF7F4D37AEF3ED5A34A8238E",
                   "postal_code": "3020",
                   "udf_date_1": "2014-05-05T15:49:59",
                   "udf_date_2": "2014-06-05T15:49:59",
                   "udf_date_3": "2014-07-05T15:49:59",
                   "udf_date_4": "2014-08-05T15:49:59",
                   "po_box_postal_code": "AG70022",
                   "apartment_number": "202",
                   "town_city": "Aglanjia",
                   "type": "Home",
                   "municipality": "Aglanjia"
               }
           ],
           "title": "Sir",
           "company_profile":
           {
               "tax_reference_number": null,
               "annual_turnover": null,
               "number_of_employees": null,
               "profile_year": null,
               "established_date": null,
               "industry_sector":
               {
                   "name": "FOREX",
                   "id": "D8ACF18AB4494AD33738A9F4C94E6995",
                   "alternative_code": "FRX"
               },
               "registered_in_country": null,
               "vat_registration_number": null,
               "industry":
               {
                   "name": "Marketing",
                   "id": "31BC2070C79EAE5455BFAD41599C5190",
                   "code": "MK"
               },
               "vat_registration_date": null,
               "vat_registered_by": null,
               "registration_number": null
           },
           "udf_date_1": "2014-05-05T15:49:59",
           "phones_set":
           [
               {
                   "notes": null,
                   "udf_float_1": null,
                   "udf_float_2": null,
                   "udf_date_1": null,
                   "udf_float_3": null,
                   "udf_date_2": null,
                   "number": "22114455",
                   "udf_float_4": null,
                   "udf_date_3": null,
                   "udf_date_4": null,
                   "udf_string_1": null,
                   "udf_string_2": null,
                   "udf_string_3": null,
                   "udf_string_4": null,
                   "udf_string_5": null,
                   "udf_string_6": null,
                   "udf_string_7": null,
                   "state": "Active",
                   "udf_string_8": null,
                   "country":
                   {
                       "three_character_code": "USA",
                       "two_character_code": "US",
                       "name": "UNITED STATES",
                       "id": "127",
                       "alternative_code": null
                   },
                   "full_number": "00122114455",
                   "type": "Landline",
                   "id": "F593DEF1C332469B939E358A28773FB9",
                   "area_code": "1"
               }
           ],
           "udf_date_2": "2014-06-05T15:49:59",
           "udf_date_3": "2014-07-05T15:49:59",
           "udf_date_4": "2014-08-05T15:49:59",
           "udf_date_5": null,
           "udf_date_6": null,
           "demographics":
           {
               "gender": "FEMALE",
               "passport_issued_by_country":
               {
                   "three_character_code": "GRC",
                   "two_character_code": "GR",
                   "name": "GREECE",
                   "id": "209",
                   "alternative_code": null
               },
               "passport_number": "CD112234",
               "social_security_number": "EF112234",
               "country_of_residence":
               {
                   "three_character_code": "CYP",
                   "two_character_code": "CY",
                   "name": "CYPRUS",
                   "id": "181",
                   "alternative_code": null
               },
               "industry_sector":
               {
                   "name": "FOREX",
                   "id": "D8ACF18AB4494AD33738A9F4C94E6995",
                   "alternative_code": "FRX"
               },
               "date_of_birth":
               {
                   "month": 5,
                   "day": 12,
                   "year": 1981
               },
               "name_day":
               {
                   "month": 8,
                   "day": 18
               },
               "id_number": "AB112234",
               "id_issued_by_country":
               {
                   "three_character_code": "CYP",
                   "two_character_code": "CY",
                   "name": "CYPRUS",
                   "id": "181",
                   "alternative_code": null
               },
               "industry":
               {
                   "name": "Marketing",
                   "id": "31BC2070C79EAE5455BFAD41599C5190",
                   "code": "MK"
               }
           },
           "udf_date_7": null,
           "udf_date_8": null,
           "owned_by_group":
           {
               "community_name": "Internal Community",
               "name": "Main Group",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "description": "Main Group",
               "alternative_code": "MG1"
           },
           "middle_name": "Aloz",
           "emails_set":
           [
               {
                   "notes": null,
                   "udf_float_1": null,
                   "udf_float_2": null,
                   "udf_date_1": null,
                   "udf_float_3": null,
                   "udf_date_2": null,
                   "udf_float_4": null,
                   "udf_date_3": null,
                   "udf_date_4": null,
                   "udf_string_1": null,
                   "udf_string_2": null,
                   "udf_string_3": null,
                   "udf_string_4": null,
                   "udf_string_5": null,
                   "udf_string_6": null,
                   "udf_string_7": null,
                   "state": "Active",
                   "udf_string_8": null,
                   "type": "Personal",
                   "id": "827AEC3875474B99B7829FCA52D2E4F8",
                   "email": "brianakozior@gmail.com"
               }
           ],
           "category":
           {
               "name": "Contact Category",
               "id": "486B0C17A39E5F5339BD16B288AE12FE",
               "code": "Contact Category"
           }
       }
    }
...
Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions
