These are the available methods with the DataSyncAPI:
  1. listXrefTypes--this method returns the highest level information. An example would be returning "Donation Form Cross-Reference" with an ID of 404. You can then use this ID to perform the other operations. You can also determine the foreign key field numbers and descriptions with this method.
  2. listComObjectsForXrefType--this method will list all of the Luminate values that can or have been cross referenced for a specific type. The type ID should have been retrieved from listXrefTypes. You can use this method to determine which Luminate values still need to be cross referenced by setting a value of false for the parameter "mapped" or allowing it to default to false. This method will return a "name" and "value". The value can then be used to for adding or removing cross references.
  3. addXref--this method can be used to add a cross reference for a Luminate value. Use the type ID retrieved from listXrefTypes and the value retrieved from listComObjectsForXrefType. You can set values for foreign_key0 to foreign_key9 depending on the specific cross reference type. The foreign_key# will correspond to the number returned in listXrefTypes.
  4. listXrefs--this method will show the Luminate values that have already been cross referenced. You can narrow your results by adding the cross reference type and/or the Luminate value. The unique cross reference ID will be part of the response.
  5. removeXref--this method will delete a cross reference. The only parameter here is the xref_id, which can be retrieved with listXrefs
To summarize, the order of operations should be the following:
  1. Use listXrefTypes to retrieve the cross reference type ID and and the allowed foreign key fields
  2. Use listComObjectsForXrefType to determine which Luminate values still need to be cross referenced using the type ID retrieved in step 1
  3. Use addXref to add a cross reference using the Luminate value retrieved in step 2, the type ID retrieved in step 1, and the foreign key fields retrieved in step 1
  4. Use listXrefs to find the unique ID of a cross reference that has already been created
  5. Use removeXref to remove an erroneous cross reference