Get Sanctioned Screenings
get
/tradeParties/{contactGid}/sanctionedScreenings
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.sanctionedScreenings
Type:
Show Source
object
-
complianceRuleGid: string
The GID for the GTM compliance rule. You can configure screening to fit any combination of rules or policies that you deem to be necessary. Compliance rules can be added to a rule set, rule sets can be added to rule set groups, and rule set groups can be combined into a compliance policy which is then used in transaction screening.
-
complianceRuleGroupGid: string
The GID for the GTM compliance rule group. The compliance rule group is considered an optional input for sanctioned territory screening. If no compliance rule group is provided, the service preference given in user preference is considered for getting compliance rule group information. If a user preference has not been designated, screening will be done against all sanction rules using the Cumulative algorithm.
-
controlCode: string
The control type and control code are linked to the compliance rule.
-
controlTypeGid: string
The GID for the GTM control type. The control type is linked to the compliance rule.
-
domainName: string
Database domain where this data is stored.
-
gtmContactStScreenGid: string
The GID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
-
gtmContactStScreenXid: string
The XID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
-
links: array
links
Read Only:
true
-
regulationReferenceGid: string
The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.