FactSet.SDK.FactSetConcordance 0.23.0

FactSet Concordance client library for .NET

The FactSet Concordance API enables Application Developers and Data Scientists to programmatically discover the FactSet Identifier for a specific Entity or Person based on attributes, such as name, URL, and location.FactSet Identifiers are mapped to industry-standard identifiers, as well as to a comprehensive set of reference data and unique content, to enhance the ability to quickly connect content sets.<p>

Using the submitted attributes, the FactSet Concordance API leverages FactSet’s extensive Entity Master, People, and Symbology databases to return potential candidate matches and a proposed match. The result is a concorded FactSet Identifier that can then be used as input throughout FactSet's expanding catalog of Content using our Content APIs or Standard DataFeeds.</p>

<b>There are two types of workflows supported in the API:</b>

<b>Entity & People Match:</b> The first workflow follows traditional API conventions in that a request is accepted and a response is returned synchronously enabling the concordance of up to 25 names in a single request. The response returns a list of 20 candidates as well as a proposed match.

<b>Entity & People Match - Bulk:</b> The second workflow allows you to input a large list of names within a .CSV file in a single request With this workflow, a task is created for uploading a set of queries. Once the task has completed, the client retrieves the concordance results through the /entity-decisions or /people-decisions endpoint. Note that in the Bulk workflow, only the matches for the records are returned. Candidates are not included.

Once the service has provided a list of concorded FactSet Identifiers, you can then use our Entity Mappings and People Mappings endpoints to further review the universe of mapped identifiers or modify existing records. </p>

This .NET package is automatically generated by the OpenAPI Generator project:

• API version: 2.6.0
• Package version: 0.23.0
• Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

Requirements

• .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.FactSetConcordance

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetConcordance

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
3. Install dependencies.
4. Run the following:

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.FactSetConcordance.Api;
using FactSet.SDK.FactSetConcordance.Client;
using FactSet.SDK.FactSetConcordance.Model;

namespace Example
{
    public static class GetEntityMappingDeleteForListExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetConcordance.Client.Configuration();

            // Examples for each supported authentication method are below,
            // choose one that satisfies your use case.

            /* (Preferred) OAuth 2.0: FactSetOAuth2 */
            // See https://github.com/FactSet/enterprise-sdk#oauth-20
            // for information on how to create the app-config.json file
            // See https://github.com/FactSet/enterprise-sdk-utils-dotnet#authentication
            // for more information on using the ConfidentialClient class
            ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
            config.OAuth2Client = confidentialClient;

            /* Basic authentication: FactSetApiKey */
            // See https://github.com/FactSet/enterprise-sdk#api-key
            // for information how to create an API key
            // config.Username = "USERNAME-SERIAL";
            // config.Password = "API-KEY";

            var apiInstance = new EntityMappingsApi(config);
            var entityMappingDeleteRequest = new EntityMappingDeleteRequest(); // EntityMappingDeleteRequest | A request to delete entity mappings specified by the client

            try
            {
                // Deletes mapping specified by the client.
                EntityMappingDeleteResponse result = apiInstance.GetEntityMappingDeleteForList(entityMappingDeleteRequest);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling EntityMappingsApi.GetEntityMappingDeleteForList: " + e.Message );
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Using a Proxy

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/content

Documentation for Models

• Model.CreateUniverseRequest
• Model.EntityDecisionsResponse
• Model.EntityMapping
• Model.EntityMappingDeleteRequest
• Model.EntityMappingDeleteResponse
• Model.EntityMappingRequest
• Model.EntityMappingResponse
• Model.EntityMatch
• Model.EntityMatchRequest
• Model.EntityMatchRequestInput
• Model.EntityMatchesResponse
• Model.EntityResponse
• Model.EntityTaskResponse
• Model.EntityTaskStatus
• Model.EntityTaskStatusResponse
• Model.EntityUniverseRequest
• Model.EntityUniverseResponse
• Model.EntityUniverseStatisticsResponse
• Model.ErrorResponse
• Model.ErrorResponseSubErrors
• Model.MapStatus
• Model.PeopleDecisions
• Model.PeopleDecisionsResponse
• Model.PeopleMapping
• Model.PeopleMappingDeleteResponse
• Model.PeopleMappingRequest
• Model.PeopleMappingResponse
• Model.PeopleMatch
• Model.PeopleMatchRequest
• Model.PeopleMatchRequestInput
• Model.PeopleMatchesResponse
• Model.PeopleTask
• Model.PeopleTaskResponse
• Model.PeopleTaskStatus
• Model.PeopleTaskStatusResponse
• Model.PeopleUniverseRequest
• Model.PeopleUniverseResponse
• Model.SnowflakeEntityMappingRequest
• Model.SnowflakeEntityMappingResponse
• Model.SnowflakeEntityMatchRequest
• Model.SnowflakeEntityMatchResponse
• Model.Universe
• Model.UniverseMeta
• Model.UniverseMetaResponse
• Model.UniverseStatistics
• Model.UniverseStatisticsResponse
• Model.UniversesResponse
• Model.UpdateUniverseRequest

Documentation for Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.