Skip to main content

Screening – Updated

Added fields to support implementation of Alias Screening. There are no breaking changes here, so adapter implementations will continue to work as normal without the need of making any change.

Affected Endpoints​

  • POST /screeningreceptor/api/receptor

    • Added entityAliasId to ExternalIdDto. If not using AliasScreening, entityAliasId should be always set to PrimaryName (null will default to PrimaryName).
    • Renamed AliasDto to MatchDataAliasDto for aliasesList in MatchDataDto (this is not considered a breaking change as only the name of the model was changed).
    • Added externalIds and entityAliasIds to MatchDataDto and set externalId as obsolete, since it will be removed in the future. If not using AliasScreening, entityAliasId should be always set to PrimaryName (null will default to PrimaryName).

  • POST /{anyScreeningAdapter}/api/screen

    • Added entityAliases to ScreenRequestEntityDto. Only needed for providers that want to support AliasScreening.
    • Added entityAliases to OverriddenBatchEntityDto. Only needed for providers that want to support AliasScreening.

  • POST /{anyScreeningAdapter}/api/resolvematches

    • Added entityAliasId to ExternalIdDto (batchExternalIds and entities.externalIds). If not using AliasScreening, entityAliasId should be always set to PrimaryName (null will default to PrimaryName).
    • Added entityAliasIds to ResolveMatchesRequestEntityDto. Only needed for providers that want to support AliasScreening.
    • Added externalIds and entityAliasIds to ResolveMatchesRequestMatchDataDto and set externalId as obsolete, since it will be removed in the future. If not using AliasScreening, entityAliasId should be always set to PrimaryName (null will default to PrimaryName).

  • POST /{anyScreeningAdapter}/api/ongoingscreening

    • Added entityAliasesForEnable to OngoingScreeningRequestDto. Only needed for providers that want to support AliasScreening.

  • POST /{anyScreeningAdapter}/api/ongoingscreeningupdate

    • Added entityAliases to OngoingScreeningUpdateRequestDto. Only needed for providers that want to support AliasScreening.

  • GET /screeningquery/api/batch/{id}, GET /screeningquery/api/batch/journey/{journeyId}, GET /screeningquery/api/batch/journey/{journeyId}/process/{processId}

    • Added entityAliases to BatchEntitySearchDto.
    • Added entityAliasId to ExternalIdDto.

  • GET /screeningquery/api/batch/{batchId}/entity, GET /screeningquery/api/batch/{batchId}/entity/{entityId}

    • Added entityAliases to BatchEntityDto.
    • Added entityAliasId to ExternalIdDto.

  • GET /screeningquery/api/batch/{batchId}/entity/{entityId}/match, GET /screeningquery/api/batch/{batchId}/entity/{entityId}/match/{matchId}

    • Added entityAliasIds to MatchDto.
    • Added externalIds to MatchDataDto.
    • Renamed AliasDto to MatchDataAliasDto for aliasesList in MatchDataDto (this is not considered a breaking change as only the name of the model was changed).

  • GET /screeningquery/api/entity/{entityId}, POST /screeningquery/api/entity/getentitieslist

    • Added entityAliases to ScreeningEntityDto.