wm.tn.profile:getExternalID
Retrieves an external ID for a trading partner.
Input Parameters
partnerID | String The internal identifier for a trading partner for which to retrieve an external ID. |
idType | String Deprecated. Use idTypeDesc instead. |
idTypeDesc | String The type of the external ID to retrieve. The value must match one of the values in the Description column of the IDType table in the Trading Networks database (for example, DUNS; DUNS+4; EULER, User Defined 3). Supply a value for either idTypeDesc or idTypeCode. |
idTypeCode | String The type of the external ID to retrieve. The value must match one of the values in the Type column of the IDType table in the Trading Networks database (for example, 1, 2, 3). Supply a value for either idTypeCode or idTypeDesc. |
Output Parameters
id | String The requested external ID. |
Usage Notes
When exchanging documents, partners typically identify themselves within a document using some well-known ID scheme, such as a D-U-N-S number. If you know a partner's internal ID, use this service to get the external ID you need.
Supply a value for either
idTypeDesc or
idTypeCode. If you supply values for both of these parameters, the service uses
idTypeCode and ignores
idTypeDesc.
As of version 4.6,
Trading Networks allows you to store multiple IDs of the same type for a partner. If the partner identified by the
partnerID parameter has more than one ID of the requested type, this service will return the first ID in the database, which is usually the first one you entered. To retrieve all IDs of a particular type for a partner, use the
wm.tn.profile:getExternalIDs service.