IRN Contacts API

  • SECTIONS
  • Overview
  • API Definition
  • SDK Libraries
  • Code Snippet
  • Changelog
Overview

IRN Contacts API Overview

The IRN Contacts API enables Application Developers to programmatically manage and process proprietary contact contents in FactSet IRN.

Our APIs provide a channel to Contribute and Consume internal research/RMS data (IRN Notes, Meetings, Symbols and Contacts). The IRN Configuration API also allows you to get your custom IRN configuration details which support your custom workflows.

There are three types of workflows supported with the API:

  1. Business Continuity and Compliance: Retrieve scheduled backups of all RMS data, including text markup and attachments, for business continuity and compliance purposes.
  2. Real Time Research Access: Integrate internal research into additional tools, client portals or proprietary interfaces in a real-time manner.
  3. Single Research Hub / Integration: Leverage the IRN API to allow notes created in parallel systems to integrate with the larger research workflow across FactSet.

Technical Details

The IRN API delivers data in a JSON format, refer to the documentation for more information about the API Contract.

Requests made from Developer’s Portal could be directed to Production Environment https://api.factset.com/research/irn/v1 or Sandbox Environment https://api-sandbox.factset.com/research/irn/v1/ based on your preference and selection as you execute the request in the portal.

Production Environment will point to client's exiting IRN database where you will be able to create and extract research contents directly to and from your IRN system.

Sandbox environment is an empty IRN container available for you to use as a development area when exploring IRN APIs. Initially you will need to use POST requests before GET to have sample data with which to experiment your create and extract research workflows. The IRN Custom Symbols  API enables Application Developers to programmatically manage and process proprietary custom symbol contents in FactSet IRN. Our APIs provide a channel to Contribute and Consume internal research/RMS data (IRN Notes, Meetings, Symbols and Contacts). The IRN Configuration API also allows you to get your custom IRN configuration details which support your custom workflows.

API Definition
SDK Libraries
Code Snippet
Work with Contacts
using FactSet.SDK.IRNContacts.Api;
using FactSet.SDK.IRNContacts.Client;
using FactSet.SDK.IRNContacts.Model;
using System.Net;
using System.Text.Json;

namespace ConsoleApp
{
    internal class Program
    {
        private static Configuration _irnApiConfiguration;
        private const string BASE_PATH = "https://api.factset.com/research/irn";
        private const string USER_NAME = "USERNAME-SERIAL";
        private const string PASSWORD = "BzS1sZf2yFmuBgpLCMTE7n3N2WYm7Eseq3d17G9g";
        static void Main(string[] args)
        {
            var apiInstance = new ContactsApi(GetIrnApiConfiguration());

            var serializerOptions = new JsonSerializerOptions
            {
                PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
                WriteIndented = true
            };

            try
            {
                ApiResponse<List<ContactSummaryDto>> response = apiInstance.GetContactsWithHttpInfo();

                if (response.StatusCode == HttpStatusCode.OK)
                {
                    Console.WriteLine(JsonSerializer.Serialize(response.Data, serializerOptions));
                };

                var contactSaveDto = new ContactSaveDto("primaryemailaddresscs3@gmail.com");
                ApiResponse<NewItemDto> result = apiInstance.CreateContactWithHttpInfo(contactSaveDto);

                if (result.StatusCode == HttpStatusCode.Created)
                {
                    Console.WriteLine(JsonSerializer.Serialize(result.Data, serializerOptions));
                };
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling Contacts API: " + e.Message);
                Console.WriteLine("Status Code: " + e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }

        private static Configuration GetIrnApiConfiguration()
        {
            ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
            if (_irnApiConfiguration != null)
            {
                return _irnApiConfiguration;
            }

            _irnApiConfiguration = new Configuration
            {
                BasePath = BASE_PATH,
                Username = USER_NAME,
                Password = PASSWORD,
            };

            return _irnApiConfiguration;
        }
    }
}
Changelog

v1

Summary

V1.0 Released on 8th Feb 2020

Functionality Additions

  • Contact CustomField
    • Get Contact CustomFields
    • Create Contact CustomField
    • Get Contact CustomField by Id
    • Update Contact CustomField
    • Delete Contact CustomField
    • Reorder Contact CustomField
  • Contact Relationships
    • Get Contact Relationship by Id
    • Update Contact Relationship
    • Delete Contact Relationship
    • Create Contact Relationship
    • Get Contact Relationships
  • Contact Roles
    • Get Contact Roles
    • Create Contact Role
    • Update Contact Role
    • Delete Contact Role
  • Contacts
    • Get Contacts
    • Update Contacts
    • Delete Contacts
    • Get Contact by Id
    • Update Contact
    • Get Contact's about field content
    • Get Contact Interactions
    • Get Contact audit history
    • Get Contact's relationships
  • Contact Types
    • Get Contact Types
    • Create Contact Type
    • Update Contact Type
    • Delete Contact Type
  • Phonenumber Types
    • Get Phonenumber Types
    • Create Phonenumber Type
    • Update Phonenumber Type
    • Delete Phonenumber Type
  • Relationship Categories
    • Get Relationship Categories
    • Delete Relationship Category
    • Update Relationship Category
    • Create Relationship Category
    • Reorder Relationship Categories
  • Relationships
    • Get Relationships
    • Delete Relationship
    • Update Relationship
    • Create Relationship

Changes

No Changes

Bug Fixes

No Fixes

v1.1

Summary

v1.1 Released on 16th May 2020

Changes

  • Relationships
    • Introduced a unique field called "Relationship Code"
    • Introduced parameter for filtering contact to contact and contact to symbol relationships