deleteSourceIdentity

  • Web Services
  • API Documentation
  • Provider

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

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

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

deleteSourceIdentity JSON request

  • The response 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 want to delete
    • 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 Link ID of the Provider Data Management entity that was modified (in the case where the entity also included other source records which remain active)
    • The Link ID of the Provider Data Management entity that was deleted (only in the case where the 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"]
      }
    }