Get Party Screenings
get
/tradeParties/{contactGid}/partyScreenings
Request
Path Parameters
-
contactGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : tradeParties.partyScreenings
Type:
Show Source
object
-
approvedBy: string
Approver for matches requiring review.
-
domainName: string
Database domain where this data is stored.
-
gtmDeniedPartyGid: string
The GID for the denied party.
-
gtmServicePrefGid: string
The unique GID for the service preference used for screening.
-
links: array
links
Read Only:
true
-
matchFactor: number
(int32)
Match factor is determined by GTM and represents the match factor (matching percentage) between the party and the restricted party.
-
partyScreeningComments:
partyScreeningComments
-
partyScreeningSequence: number
(int64)
Sequence number for potential matches.
-
screeningStatus: string
Denied party to party screening status. Potential Match -Some similarities exist between the restricted party list and the contact being screened. Verified Match - The contact being screened matches a name on the restricted party list and the match has been verified by a user. Not a Match
- No similarity exists between the restricted party list and the contact being screened. Escalated -
The potential match was referred to another person for review.
Nested Schema : partyScreeningComments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : tradeParties.partyScreenings.partyScreeningComments
Type:
Show Source
object
-
commentBy: string
User entering the comment.
-
commentText: string
Text related to comment.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
partyCommentSequence: number
(int64)
Sequence number for potential matches comment.