Jump to

• Request
• Response

Get an Involved Party

get

/orderReleases/{orderReleaseGid}/involvedParties/{involvedPartyQualGidxinvolvedPartyContactGidxcomMethodGid}

Request

Path Parameters

• involvedPartyQualGidxinvolvedPartyContactGidxcomMethodGid(required): string
  Resource ID
• orderReleaseGid(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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication method for the involved party listed on the order release.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  The involved party contact for the qualifier listed on the order release.
• involvedPartyQualGid: string
  The involved party qualifier identifier.
• links: array links
  Read Only: true
• overrideAddresses: overrideAddresses
• overrideCity: string
  The location city that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overrideCountryCode3Gid: string
  The location country code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overrideLocationName: string
  The location name that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overridePostalCode: string
  The location postal code that is to be used for this involved party on an order release in place of (overridden) the one on the location table
• overrideProvince: string
  The location providence that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overrideProvinceCode: string
  The location providence code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The involved party qualifier identifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The involved party contact for the qualifier listed on the order release.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method for the involved party listed on the order release.",
            "type":"string"
        },
        "overrideLocationName":{
            "description":"The location name that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideCity":{
            "description":"The location city that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideProvince":{
            "description":"The location providence that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideProvinceCode":{
            "description":"The location providence code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideCountryCode3Gid":{
            "description":"The location country code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overridePostalCode":{
            "description":"The location postal code that is to be used for this involved party on an order release in place of (overridden) the one on the location table",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "overrideAddresses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.involvedParties.overrideAddresses"
                    }
                },
                "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 : overrideAddresses

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.involvedParties.overrideAddresses"
            }
        },
        "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 orderReleases.involvedParties.overrideAddresses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.involvedParties.overrideAddresses"
    }
}

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 : orderReleases.involvedParties.overrideAddresses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• lineSequence: number (int64)
  The line sequence (key) for the involved party on the order release.
• links: array links
  Read Only: true
• overrideAddressLine: string
  The address line that is to be used for this involved party on an order release in place (Overridden) of the one on the contact table for the involved party.

{
    "properties":{
        "lineSequence":{
            "description":"The line sequence (key) for the involved party on the order release.",
            "type":"number",
            "format":"int64"
        },
        "overrideAddressLine":{
            "description":"The address line that is to be used for this involved party on an order release in place (Overridden) of the one on the contact table for the involved party.",
            "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