Jump to

• Request
• Response

Update a delegate's information

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• DelegateHeaderId: integer
  The unique identifier of a delegation record.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorDelegateNotifications-item

Type: object

Show Source

• DelegateEmail(optional): string
  Title: Delegate Email

  The email of a delegate user.
• DelegateFirstName(optional): string
  Title: Delegate First Name

  The first name of a delegate user.
• DelegateHeaderId(optional): integer(int64)
  The unique identifier of a delegation record.
• DelegateLastName(optional): string
  Title: Delegate Last Name

  The last name of a delegate user.
• DelegatePhone(optional): string
  Title: Delegate Phone

  The phone number of a delegate user.
• DelegateType(optional): string
  Title: Delegation Type

  The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.
• DelegateUsername(optional): string
  Title: Delegate User Name

  The user name that a delegate uses to sign into the system.
• links(optional): array Items
  Title: Items

  Link Relations
• PrivilegeType(optional): string
  Title: Privilege Type

  The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• ProfileName(optional): string
  Title: Profile Name

  Profile or transaction owner's account profile name.
• ProfileType(optional): string
  Title: Profile Type

  The profile type of the profile owner's profile. It can be of type Personal or Business.
• PTOEmail(optional): string
  Title: Profile or Transaction Owner Email

  Email of the profile or transaction owner.
• PTOFirstName(optional): string
  Title: Profile or Transaction Owner First Name

  The first name of the profile or transaction owner.
• PTOLastName(optional): string
  Title: Profile or Transaction Owner Last Name

  The last name of the profile or transaction owner.
• PTOPhone(optional): string
  Title: Profile or Transaction Owner Phone

  The phone number of the profile or transaction owner.
• PTOUsername(optional): string
  Title: Profile or Transaction Owner User Name

  The user name of the profile or transaction owner.

{
    "properties":{
        "DelegateEmail":{
            "type":"string",
            "description":"The email of a delegate user.",
            "title":"Delegate Email"
        },
        "DelegateFirstName":{
            "type":"string",
            "description":"The first name of a delegate user.",
            "title":"Delegate First Name"
        },
        "DelegateHeaderId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a delegation record."
        },
        "DelegateLastName":{
            "type":"string",
            "description":"The last name of a delegate user.",
            "title":"Delegate Last Name"
        },
        "DelegatePhone":{
            "type":"string",
            "description":"The phone number of a delegate user.",
            "title":"Delegate Phone"
        },
        "DelegateType":{
            "type":"string",
            "description":"The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.",
            "title":"Delegation Type"
        },
        "DelegateUsername":{
            "type":"string",
            "description":"The user name that a delegate uses to sign into the system.",
            "title":"Delegate User Name"
        },
        "PTOEmail":{
            "type":"string",
            "description":"Email of the profile or transaction owner.",
            "title":"Profile or Transaction Owner Email"
        },
        "PTOFirstName":{
            "type":"string",
            "description":"The first name of the profile or transaction owner.",
            "title":"Profile or Transaction Owner First Name"
        },
        "PTOLastName":{
            "type":"string",
            "description":"The last name of the profile or transaction owner.",
            "title":"Profile or Transaction Owner Last Name"
        },
        "PTOPhone":{
            "type":"string",
            "description":"The phone number of the profile or transaction owner.",
            "title":"Profile or Transaction Owner Phone"
        },
        "PTOUsername":{
            "type":"string",
            "description":"The user name of the profile or transaction owner.",
            "title":"Profile or Transaction Owner User Name"
        },
        "PrivilegeType":{
            "type":"string",
            "description":"The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "title":"Privilege Type"
        },
        "ProfileName":{
            "type":"string",
            "description":"Profile or transaction owner's account profile name.",
            "title":"Profile Name"
        },
        "ProfileType":{
            "type":"string",
            "description":"The profile type of the profile owner's profile. It can be of type Personal or Business.",
            "title":"Profile Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorDelegateNotifications-item

Type: object

Show Source

• DelegateEmail(optional): string
  Title: Delegate Email

  The email of a delegate user.
• DelegateFirstName(optional): string
  Title: Delegate First Name

  The first name of a delegate user.
• DelegateHeaderId(optional): integer(int64)
  The unique identifier of a delegation record.
• DelegateLastName(optional): string
  Title: Delegate Last Name

  The last name of a delegate user.
• DelegatePhone(optional): string
  Title: Delegate Phone

  The phone number of a delegate user.
• DelegateType(optional): string
  Title: Delegation Type

  The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.
• DelegateUsername(optional): string
  Title: Delegate User Name

  The user name that a delegate uses to sign into the system.
• links(optional): array Items
  Title: Items

  Link Relations
• PrivilegeType(optional): string
  Title: Privilege Type

  The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• ProfileName(optional): string
  Title: Profile Name

  Profile or transaction owner's account profile name.
• ProfileType(optional): string
  Title: Profile Type

  The profile type of the profile owner's profile. It can be of type Personal or Business.
• PTOEmail(optional): string
  Title: Profile or Transaction Owner Email

  Email of the profile or transaction owner.
• PTOFirstName(optional): string
  Title: Profile or Transaction Owner First Name

  The first name of the profile or transaction owner.
• PTOLastName(optional): string
  Title: Profile or Transaction Owner Last Name

  The last name of the profile or transaction owner.
• PTOPhone(optional): string
  Title: Profile or Transaction Owner Phone

  The phone number of the profile or transaction owner.
• PTOUsername(optional): string
  Title: Profile or Transaction Owner User Name

  The user name of the profile or transaction owner.

{
    "properties":{
        "DelegateEmail":{
            "type":"string",
            "description":"The email of a delegate user.",
            "title":"Delegate Email"
        },
        "DelegateFirstName":{
            "type":"string",
            "description":"The first name of a delegate user.",
            "title":"Delegate First Name"
        },
        "DelegateHeaderId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a delegation record."
        },
        "DelegateLastName":{
            "type":"string",
            "description":"The last name of a delegate user.",
            "title":"Delegate Last Name"
        },
        "DelegatePhone":{
            "type":"string",
            "description":"The phone number of a delegate user.",
            "title":"Delegate Phone"
        },
        "DelegateType":{
            "type":"string",
            "description":"The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.",
            "title":"Delegation Type"
        },
        "DelegateUsername":{
            "type":"string",
            "description":"The user name that a delegate uses to sign into the system.",
            "title":"Delegate User Name"
        },
        "PTOEmail":{
            "type":"string",
            "description":"Email of the profile or transaction owner.",
            "title":"Profile or Transaction Owner Email"
        },
        "PTOFirstName":{
            "type":"string",
            "description":"The first name of the profile or transaction owner.",
            "title":"Profile or Transaction Owner First Name"
        },
        "PTOLastName":{
            "type":"string",
            "description":"The last name of the profile or transaction owner.",
            "title":"Profile or Transaction Owner Last Name"
        },
        "PTOPhone":{
            "type":"string",
            "description":"The phone number of the profile or transaction owner.",
            "title":"Profile or Transaction Owner Phone"
        },
        "PTOUsername":{
            "type":"string",
            "description":"The user name of the profile or transaction owner.",
            "title":"Profile or Transaction Owner User Name"
        },
        "PrivilegeType":{
            "type":"string",
            "description":"The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "title":"Privilege Type"
        },
        "ProfileName":{
            "type":"string",
            "description":"Profile or transaction owner's account profile name.",
            "title":"Profile Name"
        },
        "ProfileType":{
            "type":"string",
            "description":"The profile type of the profile owner's profile. It can be of type Personal or Business.",
            "title":"Profile Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top