deleteSourceIdentity

  • Web Services
  • UMPI
  • API Documentation

The deleteSourceIdentity web service is used to physically delete one of your source records from your instance of Universal MPI. When source records are added or updated in your various source applications/databases, you use the postIdentity service to synchronize those adds/updates to Universal MPI.

When source records are deleted from your source applications/databases, you use the deleteSourceIdentity web service to delete them from Universal MPI to ensure Universal MPI is in synch.

If the source record you are deleting from Universal MPI is the only source record in a given Universal MPI entity, then the Universal MPI entity itself, including all data corresponding to your source record, will be deleted. If the source record you are deleting from Universal MPI is part of a Universal MPI entity that is also made up of other source records, that Universal MPI entity will remain (with its LinkID unchanged), but the data corresponding to the deleted source record will be removed from Universal MPI.

deleteSourceIdentity JSON request

  • The request includes:

    • A tracking ID (an optional identifier that the client can supply to track the response)
    • The Source+Native ID of the source record you wish to delete
  • {
      "trackingId": "string",
         "content": {
         "source": { 
               "name": "string",
           "id": "string"
         }
      }
    }

deleteSourceIdentity JSON response

  • The response includes

    • The Source+Native ID of the source record you wish to delete The response includes:
    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service (see section 3.1 above for more information)
    • The LinkID of the Universal MPI entity that was modified (in the case where the Universal MPI entity also included other source records which remain active)
    • The LinkID of the Universal MPI entity that was deleted (only in the case where the Universal MPI entity contained a single source record, the source record you deleted)
  • {
      "trackingId": "string",
        "auditId": UUID, 
        "success": boolean, 
        "retryableError": boolean,
      "message": "string", 
       "errors": [
        "string" 
      ],
      "content": {
        "linkIdsModified": ["string"], 
           "linkIdsDeleted": ["string"]
      }
    }