Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
Platform Knowledgebase
Platform Knowledgebase
nopaneltrue


Page Index

...

The Platform 2024.1 Release introduces a new API for Contacts, Connections and Registrations.retrieving a list of a licensees contacts and their details including

  • Phone and Address information

  • Roles they are connected in

  • Projects they’re linked to as a customer (if any)

  • Integration subscription links

Calling

It is called like this;

...

https://development-eros-platform-apisubscription.azurewebsites.net/api/json/metadata?op=GetLicenseeContactList

For each contact, you will 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

    IsConnected - True if this contact has at least 1 active connection to the licensee. Without an active connection only public profile information for the contact is returned.

Note: if a contact is only connected to the licensee with pending connection requests the data returned will be limited for that contact.

  • Contact & Profile information 

    • When IsConnected is false only the following information is returned

      • Title

      • First name

      • Surname

      • Trading name 

      • Legal name

      • Contact type id and name

      • Profile Info information (Description, Industry, working for, working areas)

      • TimezoneTime zone

  • Contact Details (phone/fax/email etc  no details returned if contact has no active real connection to the licensee)Not returned when IsConnected is false

  • 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

    )

    • The role id, name and connection status

  • Linked Projects the contact may be connected to as a customer.

  • Integration Subscription links - active and inactive