Release Page for Connect V2 APIs

Overview

Welcome to the Connect V2 API Release Page. This page provides comprehensive information about the new APIs available in Connect V2 and highlights the differences from the previous Enterprise V1 APIs.

Connect V2 API List

Explore the Full API Catalog: View the complete list of Connect V2 APIs

Comparison with Enterprise V1 APIs

1. Reduced Chattiness

   • Connect V2: The key names used in the objects across all Connect V2 APIs are consistent. This uniformity simplifies the learning curve for developers, making it easier to work with multiple APIs without needing to memorize different key names for similar data.

   • Enterprise V1: Across the Enterprise V1 APIs, there are instances where similar data is represented by different key names. For example, one API may use Organization while another uses OrganizationCode. This inconsistency requires developers to pay extra attention to the specific keys used in each API.

2. Expanded Query Parameters Set

   • Connect V2: The Connect V2 APIs introduce a richer and more flexible set of query parameters, including options like includeFields and includeAllFields. These parameters allow developers to tailor API responses more precisely to their needs, retrieving only the necessary data.

     • includeFields: This feature is available for both Search and Get By Id APIs. By using the includeFields query parameter, you can retrieve additional keys in lookup objects beyond the usual ones.
       
       Eg:- /api/v2/Accounts/10/00014166?includeFields=Type.Category
       In the above Get By Id example, for Accounts, passing includeFields with the value Type.Category will also include the Category key in the existing Type Lookup Object. By default, the existing Lookup Object only contains Code and Description keys.

     • includeAllFields: This feature is available for both Search and Get By Id APIs. By using the includeAllFields query parameter, you can fetch extra keys present in the V1 API.
       
       Eg:- /api/v2/Accounts/10/00020002?includeAllFields=true
       In the above Get By Id example, for Accounts, passing includeAllFields with the value true will return all the extra keys present in the V1 API. This feature is designed to reduce the chattiness of the API. If not specified, includeAllFields defaults to false, and only a limited number of keys are returned.

   • Enterprise V1: The Enterprise V1 APIs are more restrictive, offering a limited set of query parameters. This can lead to less flexibility when customizing API responses.

3. Lookups

   • Connect V2: The introduction of lookups in Connect V2 significantly enhances data retrieval efficiency. Lookups allow developers to fetch related data in a single API call, reducing the need for multiple requests.

   • Enterprise V1: Enterprise V1 lacks the lookup feature, requiring developers to make multiple API calls to gather related data.

4. Below table highlights the key differences between individual Connect V2 and Enterprise V1 API Responses:

5. Below section highlights the key differences between individual Connect V2 and Enterprise V1 API Responses:

1. Events

   • Connect V2:

     {
"Account":{"AccountCode":"ACADEMY","Class":"O","Name":"Academy of Performing Arts"},
"Category":{"Code":"LO","Description":"Local"},
"Class":{"Code":"COR","Description":"Corporate1"},
"Contact":{"AccountCode":"00000132","Class":"P","Email":"kim.boettcher@ungerboeck.com","FirstName":"Mary","LastName":"Unnerstall","MiddleInitial":"","Name":"Unnerstall, Mary","Phone":"441512606677"},
"Coordinator":{"AccountCode":"DIETER","Class":"P","Email":"dieteru@ungerboeck.com","FirstName":"Adam","LastName":"Alexander","MiddleInitial":"K","Name":"Alexander, Adam K.","Phone":"(636) 688 2000"},
"EndDateTime":"1998-05-15T16:15:00",
"InDateTime":"1998-05-15T07:00:00",
"OutDateTime":"1998-05-15T17:00:00",
"ParentEvent":{"EventID":9013,"Designation":"X","Description":"2006 Legal Developments Conference"},
"PreviousEvent":{"EventID":9013,"Designation":"X","Description":"2006 Legal Developments Conference"},
"StartDateTime":"1998-05-15T07:30:00",
"Status":{"Code":"20","Description":"20 code"},
"Type":{"Code":"MTG","Description":"MEETING"}
}

   • Enterprise V1:

     {
"Account":"ACADEMY","Category":"LO","Class":"COR","Contact":"00000132","Coordinator":"DIETER","EndDate":"1998-05-15T00:00:00","EndTime":"2000-01-01T16:15:00","InDate":"1998-05-15T00:00:00","InTime":"2000-01-01T07:00:00","OutDate":"1998-05-15T00:00:00","OutTime":"2000-01-01T17:00:00","ParentEvent":9013,"PreviousEvent":9013,"StartDate":"1998-05-15T00:00:00","StartTime":"2000-01-01T07:30:00","Status":"20","Type":"MTG"
}