API for Contacts, Connections, Registrations

Articles in this section are for general users of Platform.

Platform Administration
Articles in this section may be useful for
staff maintaining the infrastructure
of the Platform.

Platform FAQ
Articles in this section provide answers to frequently asked questions on the Platform appliance.

Platform Release Information and Roadmap
Articles in this section give release notes and links to see the product roadmap.

Platform Resource Centre

Platform Ideas Portal

Perspective Platform Resource Centre

In this article, we take a high-level look at the steps to create a new portal licensee.

Page Index

Overview

The Platform 2024.1 Release introduces a new API for Contacts, Connections and Registrations.

It is called like this;

Follow the link here to see details of what you need to pass and what is returned.

For each contact, you get the following information

Contact & Profile information
- Note: When the contact has no active real connection to the licensee, (just a pending request) we limit the contact information we return to only be the following..
  - Title
  - FirstName
  - Surname
  - Trading Name
  - Legal Name
  - contact type id and name
  - Profile Info (Description, Industry, working for, working areas)
  - Timezone
Contact Details (phone/fax/email etc no details returned if contact has no active real connection to the licensee)
Connection information with the licensee (Active Connections and Requests) (only the following fields)
- Role Id and Name
- Connection Status and Id (Connection or Request)
- IsConnected (a bit field to indicate if the connection is a request or a connection, name it what you want)
Linked Projects as customers(only the following fields)
- guid
- name
Integration Subscription links (active/inactive - only the following fields)
- altKey
- SuiteDataSourceInstanceId
- DataSource Name