Migrating from GetPartnerInfo to GetPartnerInfoById

GetPartnerInfo relies on partner names to identify partners. Because multiple partners can now share the same name, name-based lookups can no longer reliably identify a single partner. As a result, we are deprecating GetPartnerInfo.

To ensure reliable lookups, migrate your API calls from GetPartnerInfo to:

• GetPartnerInfoById

These methods use unique identifiers and are not affected by duplicate partner names or naming changes.

Recommended actions

For new implementations

Do not use:

• GetPartnerInfo

Instead use:

• GetPartnerInfoById

For existing implementations

Plan to migrate from GetPartnerInfo to GetPartnerInfoById.

Partner IDs are available in the Cove web UI under Management > Customers.

Current GetPartnerInfo behavior

When a name is supplied, GetPartnerInfo:

1. Searches globally for the oldest active partner with the specified name.
2. Checks whether that partner is visible to the requestor and either:
3. Returns the partner if it is visible.
4. Returns a Not Found error if it is not visible.

As a result, a Not Found error can occur in either of the following situations:

• No partner exists with the specified name.
• A partner with that name exists, but the selected result is outside the requestor’s visible hierarchy.

Because the lookup evaluates only a single global match, a requestor can receive Not Found even when another partner with the same name exists within their own hierarchy.

GetPartnerInfo availability

GetPartnerInfo remains available during the migration period. No retirement date has been set, and we will provide an update once a retirement date is announced.

Related method

• GetPartnerInfoById