Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.partyScreenings"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeParties.partyScreenings

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyScreenings"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : tradeParties.partyScreenings

Type: object

Show Source

• 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.

{
    "properties":{
        "partyScreeningSequence":{
            "description":"Sequence number for potential matches.",
            "type":"number",
            "format":"int64"
        },
        "gtmDeniedPartyGid":{
            "description":"The GID for the denied party.",
            "type":"string"
        },
        "screeningStatus":{
            "description":"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<br> - No similarity exists between the restricted party list and the contact being screened.  Escalated -<br>The potential match was referred to another person for review.",
            "type":"string"
        },
        "approvedBy":{
            "description":"Approver for matches requiring review.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "matchFactor":{
            "description":"Match factor is determined by GTM and represents the match factor (matching percentage) between the party and the restricted party.",
            "type":"number",
            "format":"int32"
        },
        "gtmServicePrefGid":{
            "description":"The unique GID for the service preference used for screening.",
            "type":"string"
        },
        "partyScreeningComments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : partyScreeningComments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeParties.partyScreenings.partyScreeningComments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeParties.partyScreenings.partyScreeningComments

Type: object

Show Source

• 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.

{
    "properties":{
        "partyCommentSequence":{
            "description":"Sequence number for potential matches comment.",
            "type":"number",
            "format":"int64"
        },
        "commentText":{
            "description":"Text related to comment.",
            "type":"string"
        },
        "commentBy":{
            "description":"User entering the comment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top