Jump to

• Request
• Response

Update a delegate's information

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}

Request

Path Parameters

• DelegateHeaderId(required): integer(int64)
  The unique identifier of a delegation.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DelegateContactId: integer (int64)
  Contact ID of the delegate as a contact.
• DelegateDetail: array Delegate Details
  Title: Delegate Details

  The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.
• DelegateEmailId: string
  Title: Delegate Email

  Maximum Length: 100

  The email of a delegate user.
• DelegateHistory: array Delegate Histories
  Title: Delegate Histories

  The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.
• DelegatePartyId: integer (int64)
  The party ID for the delegate user.
• DelegatePersonFirstName: string
  Title: Delegate First Name

  The first name of a delegate user.
• DelegatePersonLastName: string
  Title: Delegate Last Name

  The last name of a delegate user.
• DelegatePhoneAreaCode: string
  Title: Delegate Phone Area Code

  The phone area code of a delegate user.
• DelegatePhoneCountryCode: string
  Title: Delegate Phone Country Code

  The phone country code of a delegate user.
• DelegatePhoneExtension: string
  Title: Delegate Phone Extension

  The phone extension of a delegate user.
• DelegatePhoneNumber: string
  Title: Delegate Phone Number

  The phone number of a delegate user.
• DelegateProfileId: integer (int64)
  The account profile ID of a delegate user.
• DelegatePscUserId: integer (int64)
  The unique identifier of a delegate as a registered public user.
• DelegateUserGuid: string
  Maximum Length: 64

  The unique user GUID of a delegate user.
• DelegationStatus: string
  Title: Status

  Maximum Length: 30

  The status of the delegation request. Valid values are ORA_PR (Privileges Required), ORA_INS (Invitation Not Sent), ORA_IS (Invitation Sent), ORA_ID (Invitation Declined), ORA_RNS (Request not Sent), ORA_RS (Request Sent), ORA_RD (Request Declined), ORA_ACTIVE (Active), and ORA_DS (Disabled).
• DelegationType: string
  Title: Delegation Type

  Maximum Length: 30

  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.
• EmailSuppress: string
  Title: Suppress Email

  Maximum Length: 1

  Default Value: N

  Status indicating whether email notifications sent to the transaction owner for delegate actions are suppressed. Valid values are Y and N.
• PrivilegeType: string
  Title: Privilege Type

  Maximum Length: 30

  The delegation privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• PtoEmailId: string
  Title: Profile or Transaction Owner Email

  Maximum Length: 100

  Email of the profile or transaction owner.
• PtoPartyId: integer (int64)
  The party ID of the profile or transaction owner.
• PtoProfileId: integer (int64)
  The account profile ID of the profile or transaction owner.
• PtoPscUserId: integer (int64)
  The unique identifier for a transaction owner as a registered public user.
• PtoUserGuid: string
  Maximum Length: 64

  The unique user GUID for a delegate user.
• RequestType: string
  Maximum Length: 30

  Delegation request type. The value ORA_INVITE represents an invitation from the owner of a profile or transaction. The value ORA_REQUEST indicates that this is a request from a prospective delegate.
• StatusChangeDate: string (date)
  Date of the most recent delegation status change.
• ToDelegationStatus: string
  Maximum Length: 30

  A status indicating if a delegation change request is pending. The value is ORA_NR for a pending change request, or blank when there is no pending change request.
• ToDelegationType: string
  Title: Change Delegation To

  Maximum Length: 30

  The target delegation type for a delegation change request. The value ORA_PROFILE indicates that the delegation is for all transactions for a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.
• ToPrivilegeType: string
  Maximum Length: 30

  The target privilege type for a delegation change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.

{
    "type":"object",
    "properties":{
        "DelegatePscUserId":{
            "type":"integer",
            "description":"The unique identifier of a delegate as a registered public user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EmailSuppress":{
            "title":"Suppress Email",
            "maxLength":"1",
            "type":"string",
            "description":"Status indicating whether email notifications sent to the transaction owner for delegate actions are suppressed. Valid values are Y and N.",
            "nullable":false,
            "default":"N"
        },
        "PtoUserGuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique user GUID for a delegate user.",
            "nullable":true
        },
        "PtoPscUserId":{
            "type":"integer",
            "description":"The unique identifier for a transaction owner as a registered public user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ToPrivilegeType":{
            "maxLength":"30",
            "type":"string",
            "description":"The target privilege type for a delegation change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":true
        },
        "DelegatePhoneAreaCode":{
            "title":"Delegate Phone Area Code",
            "type":"string",
            "description":"The phone area code of a delegate user.",
            "nullable":true,
            "x-queryable":false
        },
        "DelegateUserGuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique user GUID of a delegate user.",
            "nullable":true
        },
        "DelegationStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the delegation request. \nValid values are ORA_PR (Privileges Required), ORA_INS (Invitation Not Sent), ORA_IS (Invitation Sent), ORA_ID (Invitation Declined), ORA_RNS (Request not Sent), ORA_RS (Request Sent), ORA_RD (Request Declined), ORA_ACTIVE (Active), and ORA_DS (Disabled).",
            "nullable":false
        },
        "DelegatePersonFirstName":{
            "title":"Delegate First Name",
            "type":"string",
            "description":"The first name of a delegate user.",
            "nullable":false
        },
        "PtoProfileId":{
            "type":"integer",
            "description":"The account profile ID of the profile or transaction owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PtoPartyId":{
            "type":"integer",
            "description":"The party ID of the profile or transaction owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DelegateProfileId":{
            "type":"integer",
            "description":"The account profile ID of a delegate user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DelegateEmailId":{
            "title":"Delegate Email",
            "maxLength":"100",
            "type":"string",
            "description":"The email of a delegate user.",
            "nullable":false
        },
        "DelegateHistory":{
            "title":"Delegate Histories",
            "type":"array",
            "description":"The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDelegates-DelegateHistory-item-patch-request"
            }
        },
        "ToDelegationStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"A status indicating if a delegation change request is pending. The value is ORA_NR for a pending change request, or blank when there is no pending change request.",
            "nullable":true
        },
        "PtoEmailId":{
            "title":"Profile or Transaction Owner Email",
            "maxLength":"100",
            "type":"string",
            "description":"Email of the profile or transaction owner.",
            "nullable":true
        },
        "DelegatePhoneExtension":{
            "title":"Delegate Phone Extension",
            "type":"string",
            "description":"The phone extension of a delegate user.",
            "nullable":true,
            "x-queryable":false
        },
        "ToDelegationType":{
            "title":"Change Delegation To",
            "maxLength":"30",
            "type":"string",
            "description":"The target delegation type for a delegation change request. The value ORA_PROFILE indicates that the delegation is for all transactions for a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.",
            "nullable":true
        },
        "DelegatePhoneNumber":{
            "title":"Delegate Phone Number",
            "type":"string",
            "description":"The phone number of a delegate user.",
            "nullable":true
        },
        "DelegatePartyId":{
            "type":"integer",
            "description":"The party ID for the delegate user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DelegatePersonLastName":{
            "title":"Delegate Last Name",
            "type":"string",
            "description":"The last name of a delegate user.",
            "nullable":false
        },
        "StatusChangeDate":{
            "type":"string",
            "description":"Date of the most recent delegation status change.",
            "format":"date",
            "nullable":true
        },
        "DelegatePhoneCountryCode":{
            "title":"Delegate Phone Country Code",
            "type":"string",
            "description":"The phone country code of a delegate user.",
            "nullable":true,
            "x-queryable":false
        },
        "DelegateDetail":{
            "title":"Delegate Details",
            "type":"array",
            "description":"The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDelegates-DelegateDetail-item-patch-request"
            }
        },
        "DelegateContactId":{
            "type":"integer",
            "description":"Contact ID of the delegate as a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DelegationType":{
            "title":"Delegation Type",
            "maxLength":"30",
            "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.",
            "nullable":false
        },
        "PrivilegeType":{
            "title":"Privilege Type",
            "maxLength":"30",
            "type":"string",
            "description":"The delegation privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":false
        },
        "RequestType":{
            "maxLength":"30",
            "type":"string",
            "description":"Delegation request type. The value ORA_INVITE represents an invitation from the owner of a profile or transaction. The value ORA_REQUEST indicates that this is a request from a prospective delegate.",
            "nullable":false
        }
    }
}

Nested Schema : Delegate Details

Type: array

Title: Delegate Details

The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.

Show Source

• Array of: object publicSectorDelegates-DelegateDetail-item-patch-request

{
    "title":"Delegate Details",
    "type":"array",
    "description":"The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDelegates-DelegateDetail-item-patch-request"
    }
}

Nested Schema : Delegate Histories

Type: array

Title: Delegate Histories

The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.

Show Source

• Array of: object schema

{
    "title":"Delegate Histories",
    "type":"array",
    "description":"The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDelegates-DelegateHistory-item-patch-request"
    }
}

Nested Schema : publicSectorDelegates-DelegateDetail-item-patch-request

Type: object

Show Source

• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• PrivilegeType: string
  Maximum Length: 30

  The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• PtoObjectId: string
  Maximum Length: 50

  The unique identifier of a permit or planning and zoning transaction.
• PtoObjectKey: integer (int64)
  The unique key of a permit or planning and zoning transaction.
• PtoObjectType: string
  Title: Transaction Type

  Maximum Length: 30

  The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.
• Status: string
  Title: Status

  Maximum Length: 30

  The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.
• ToPrivilegeType: string
  Title: Change Privilege To

  Maximum Length: 30

  The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.",
            "nullable":false
        },
        "PtoObjectKey":{
            "type":"integer",
            "description":"The unique key of a permit or planning and zoning transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PtoObjectType":{
            "title":"Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.",
            "nullable":false
        },
        "ToPrivilegeType":{
            "title":"Change Privilege To",
            "maxLength":"30",
            "type":"string",
            "description":"The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":true
        },
        "PrivilegeType":{
            "maxLength":"30",
            "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.",
            "nullable":false
        },
        "PtoObjectId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of a permit or planning and zoning transaction.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AttributeChanged: string
  Maximum Length: 30

  The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.
• ChangeAction: string
  Maximum Length: 30

  The action that created the change. Valid values are ACCEPTED and DECLINED.
• ChangeDate: string (date-time)
  The date and time when a change was made to a delegation???s status.
• DelegateDetailId: integer (int64)
  The delegation detail ID from the delegation detail table.
• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• NewValue: string
  Maximum Length: 30

  The new value of the attribute that was changed.
• PreviousValue: string
  Maximum Length: 30

  The previous value for the attribute that was changed.
• StatusUpdatedByGuid: string
  Maximum Length: 64

  The user GUID of the user whose action changed the status.

{
    "type":"object",
    "properties":{
        "ChangeAction":{
            "maxLength":"30",
            "type":"string",
            "description":"The action that created the change. Valid values are ACCEPTED and DECLINED.",
            "nullable":true
        },
        "StatusUpdatedByGuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The user GUID of the user whose action changed the status.",
            "nullable":false
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChangeDate":{
            "type":"string",
            "description":"The date and time when a change was made to a delegation???s status.",
            "format":"date-time",
            "nullable":false
        },
        "NewValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The new value of the attribute that was changed.",
            "nullable":true
        },
        "DelegateDetailId":{
            "type":"integer",
            "description":"The delegation detail ID from the delegation detail table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeChanged":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.",
            "nullable":false
        },
        "PreviousValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The previous value for the attribute that was changed.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorDelegates-item-response

Type: object

Show Source

• DelegateContactId: integer (int64)
  Contact ID of the delegate as a contact.
• DelegateDetail: array Delegate Details
  Title: Delegate Details

  The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.
• DelegateEmailId: string
  Title: Delegate Email

  Maximum Length: 100

  The email of a delegate user.
• DelegateHeaderId: integer (int64)
  The unique identifier of a delegation.
• DelegateHistory: array Delegate Histories
  Title: Delegate Histories

  The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.
• DelegatePartyId: integer (int64)
  The party ID for the delegate user.
• DelegatePersonFirstName: string
  Title: Delegate First Name

  The first name of a delegate user.
• DelegatePersonLastName: string
  Title: Delegate Last Name

  The last name of a delegate user.
• DelegatePhoneAreaCode: string
  Title: Delegate Phone Area Code

  The phone area code of a delegate user.
• DelegatePhoneCountryCode: string
  Title: Delegate Phone Country Code

  The phone country code of a delegate user.
• DelegatePhoneExtension: string
  Title: Delegate Phone Extension

  The phone extension of a delegate user.
• DelegatePhoneNumber: string
  Title: Delegate Phone Number

  The phone number of a delegate user.
• DelegatePreferredContactMethod: string
  Read Only: true

  The delegate user's preferred way of receiving communication. The value is ORA_TEXT for text or blank for email.
• DelegateProfileId: integer (int64)
  The account profile ID of a delegate user.
• DelegateProfileName: string
  Read Only: true

  Delegate user's account profile name.
• DelegatePscUserId: integer (int64)
  The unique identifier of a delegate as a registered public user.
• DelegateUserGuid: string
  Maximum Length: 64

  The unique user GUID of a delegate user.
• DelegateUserId: integer
  Read Only: true

  The unique Fusion user ID for the delegate user.
• DelegateUserName: string
  Title: Delegate User Name

  Read Only: true

  The user name that a delegate uses to sign into the system.
• DelegationStatus: string
  Title: Status

  Maximum Length: 30

  The status of the delegation request. Valid values are ORA_PR (Privileges Required), ORA_INS (Invitation Not Sent), ORA_IS (Invitation Sent), ORA_ID (Invitation Declined), ORA_RNS (Request not Sent), ORA_RS (Request Sent), ORA_RD (Request Declined), ORA_ACTIVE (Active), and ORA_DS (Disabled).
• DelegationType: string
  Title: Delegation Type

  Maximum Length: 30

  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.
• EmailSuppress: string
  Title: Suppress Email

  Maximum Length: 1

  Default Value: N

  Status indicating whether email notifications sent to the transaction owner for delegate actions are suppressed. Valid values are Y and N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrivilegeType: string
  Title: Privilege Type

  Maximum Length: 30

  The delegation privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• PtoEmailId: string
  Title: Profile or Transaction Owner Email

  Maximum Length: 100

  Email of the profile or transaction owner.
• PtoPartyId: integer (int64)
  The party ID of the profile or transaction owner.
• PtoPersonFirstName: string
  Title: Profile or Transaction Owner First Name

  Read Only: true

  The first name of the profile or transaction owner.
• PtoPersonLastName: string
  Title: Profile or Transaction Owner Last Name

  Read Only: true

  The last name of the profile or transaction owner.
• PtoPersonMiddleName: string
  Title: Profile or Transaction Owner Middle Name

  Read Only: true

  The middle name of the profile or transaction owner.
• PtoPersonName: string
  Title: Profile or Transaction Owner Name

  Read Only: true

  The name of the profile or transaction owner.
• PtoPhoneAreaCode: string
  Title: Profile or Transaction Owner Phone Area Code

  Read Only: true

  The phone area code of the profile or transaction owner.
• PtoPhoneCountryCode: string
  Title: Profile or Transaction Owner Phone Country Code

  Read Only: true

  The phone country code of the profile or transaction owner.
• PtoPhoneExtension: string
  Title: Profile or Transaction Owner Phone Extension

  Read Only: true

  The phone extension of the profile or transaction owner.
• PtoPhoneNumber: string
  Title: Profile or Transaction Owner Phone Number

  Read Only: true

  The phone number of the profile or transaction owner.
• PtoPreferredContactMethod: string
  Read Only: true

  The profile or transaction owner's preferred way of receiving communication. The value is ORA_TEXT for text, or blank for email.
• PtoProfileId: integer (int64)
  The account profile ID of the profile or transaction owner.
• PtoProfileName: string
  Read Only: true

  Profile or transaction owner's account profile name.
• PtoPscUserId: integer (int64)
  The unique identifier for a transaction owner as a registered public user.
• PtoUserGuid: string
  Maximum Length: 64

  The unique user GUID for a delegate user.
• PtoUserId: integer
  Read Only: true

  The unique Fusion user ID for the profile or transaction owner.
• PtoUserName: string
  Title: Profile or Transaction Owner User Name

  Read Only: true

  The user name of the profile or transaction owner.
• RequestType: string
  Maximum Length: 30

  Delegation request type. The value ORA_INVITE represents an invitation from the owner of a profile or transaction. The value ORA_REQUEST indicates that this is a request from a prospective delegate.
• StatusChangeDate: string (date)
  Date of the most recent delegation status change.
• ToDelegationStatus: string
  Maximum Length: 30

  A status indicating if a delegation change request is pending. The value is ORA_NR for a pending change request, or blank when there is no pending change request.
• ToDelegationType: string
  Title: Change Delegation To

  Maximum Length: 30

  The target delegation type for a delegation change request. The value ORA_PROFILE indicates that the delegation is for all transactions for a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.
• ToPrivilegeType: string
  Maximum Length: 30

  The target privilege type for a delegation change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.

{
    "type":"object",
    "properties":{
        "DelegatePscUserId":{
            "type":"integer",
            "description":"The unique identifier of a delegate as a registered public user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PtoUserName":{
            "title":"Profile or Transaction Owner User Name",
            "type":"string",
            "description":"The user name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailSuppress":{
            "title":"Suppress Email",
            "maxLength":"1",
            "type":"string",
            "description":"Status indicating whether email notifications sent to the transaction owner for delegate actions are suppressed. Valid values are Y and N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "PtoUserGuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique user GUID for a delegate user.",
            "nullable":true,
            "x-queryable":true
        },
        "PtoPscUserId":{
            "type":"integer",
            "description":"The unique identifier for a transaction owner as a registered public user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DelegateUserName":{
            "title":"Delegate User Name",
            "type":"string",
            "description":"The user name that a delegate uses to sign into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegatePreferredContactMethod":{
            "type":"string",
            "description":"The delegate user's preferred way of receiving communication. The value is ORA_TEXT for text or blank for email.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToPrivilegeType":{
            "maxLength":"30",
            "type":"string",
            "description":"The target privilege type for a delegation change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "PtoPhoneNumber":{
            "title":"Profile or Transaction Owner Phone Number",
            "type":"string",
            "description":"The phone number of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegatePhoneAreaCode":{
            "title":"Delegate Phone Area Code",
            "type":"string",
            "description":"The phone area code of a delegate user.",
            "nullable":true,
            "x-queryable":false
        },
        "PtoPhoneExtension":{
            "title":"Profile or Transaction Owner Phone Extension",
            "type":"string",
            "description":"The phone extension of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateUserGuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique user GUID of a delegate user.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegationStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the delegation request. \nValid values are ORA_PR (Privileges Required), ORA_INS (Invitation Not Sent), ORA_IS (Invitation Sent), ORA_ID (Invitation Declined), ORA_RNS (Request not Sent), ORA_RS (Request Sent), ORA_RD (Request Declined), ORA_ACTIVE (Active), and ORA_DS (Disabled).",
            "nullable":false,
            "x-queryable":true
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The unique identifier of a delegation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DelegatePersonFirstName":{
            "title":"Delegate First Name",
            "type":"string",
            "description":"The first name of a delegate user.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoProfileId":{
            "type":"integer",
            "description":"The account profile ID of the profile or transaction owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PtoPhoneAreaCode":{
            "title":"Profile or Transaction Owner Phone Area Code",
            "type":"string",
            "description":"The phone area code of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PtoPartyId":{
            "type":"integer",
            "description":"The party ID of the profile or transaction owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DelegateProfileId":{
            "type":"integer",
            "description":"The account profile ID of a delegate user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DelegateEmailId":{
            "title":"Delegate Email",
            "maxLength":"100",
            "type":"string",
            "description":"The email of a delegate user.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoPersonFirstName":{
            "title":"Profile or Transaction Owner First Name",
            "type":"string",
            "description":"The first name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PtoPreferredContactMethod":{
            "type":"string",
            "description":"The profile or transaction owner's preferred way of receiving communication. The value is ORA_TEXT for text, or blank for email.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateHistory":{
            "title":"Delegate Histories",
            "type":"array",
            "description":"The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDelegates-DelegateHistory-item-response"
            }
        },
        "ToDelegationStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"A status indicating if a delegation change request is pending. The value is ORA_NR for a pending change request, or blank when there is no pending change request.",
            "nullable":true,
            "x-queryable":true
        },
        "PtoPersonLastName":{
            "title":"Profile or Transaction Owner Last Name",
            "type":"string",
            "description":"The last name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PtoEmailId":{
            "title":"Profile or Transaction Owner Email",
            "maxLength":"100",
            "type":"string",
            "description":"Email of the profile or transaction owner.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegatePhoneExtension":{
            "title":"Delegate Phone Extension",
            "type":"string",
            "description":"The phone extension of a delegate user.",
            "nullable":true,
            "x-queryable":false
        },
        "DelegateUserId":{
            "type":"integer",
            "description":"The unique Fusion user ID for the delegate user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PtoPhoneCountryCode":{
            "title":"Profile or Transaction Owner Phone Country Code",
            "type":"string",
            "description":"The phone country code of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateProfileName":{
            "type":"string",
            "description":"Delegate user's account profile name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToDelegationType":{
            "title":"Change Delegation To",
            "maxLength":"30",
            "type":"string",
            "description":"The target delegation type for a delegation change request. The value ORA_PROFILE indicates that the delegation is for all transactions for a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegatePhoneNumber":{
            "title":"Delegate Phone Number",
            "type":"string",
            "description":"The phone number of a delegate user.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegatePartyId":{
            "type":"integer",
            "description":"The party ID for the delegate user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DelegatePersonLastName":{
            "title":"Delegate Last Name",
            "type":"string",
            "description":"The last name of a delegate user.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusChangeDate":{
            "type":"string",
            "description":"Date of the most recent delegation status change.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DelegatePhoneCountryCode":{
            "title":"Delegate Phone Country Code",
            "type":"string",
            "description":"The phone country code of a delegate user.",
            "nullable":true,
            "x-queryable":false
        },
        "PtoPersonName":{
            "title":"Profile or Transaction Owner Name",
            "type":"string",
            "description":"The name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateDetail":{
            "title":"Delegate Details",
            "type":"array",
            "description":"The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDelegates-DelegateDetail-item-response"
            }
        },
        "DelegateContactId":{
            "type":"integer",
            "description":"Contact ID of the delegate as a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DelegationType":{
            "title":"Delegation Type",
            "maxLength":"30",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoProfileName":{
            "type":"string",
            "description":"Profile or transaction owner's account profile name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PtoPersonMiddleName":{
            "title":"Profile or Transaction Owner Middle Name",
            "type":"string",
            "description":"The middle name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivilegeType":{
            "title":"Privilege Type",
            "maxLength":"30",
            "type":"string",
            "description":"The delegation privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoUserId":{
            "type":"integer",
            "description":"The unique Fusion user ID for the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestType":{
            "maxLength":"30",
            "type":"string",
            "description":"Delegation request type. The value ORA_INVITE represents an invitation from the owner of a profile or transaction. The value ORA_REQUEST indicates that this is a request from a prospective delegate.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Delegate Details

Type: array

Title: Delegate Details

The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.

Show Source

• Array of: object publicSectorDelegates-DelegateDetail-item-response

{
    "title":"Delegate Details",
    "type":"array",
    "description":"The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDelegates-DelegateDetail-item-response"
    }
}

Nested Schema : Delegate Histories

Type: array

Title: Delegate Histories

The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.

Show Source

• Array of: object publicSectorDelegates-DelegateHistory-item-response

{
    "title":"Delegate Histories",
    "type":"array",
    "description":"The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDelegates-DelegateHistory-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorDelegates-DelegateDetail-item-response

Type: object

Show Source

• DelegateDetailId: integer (int64)
  The unique identifier of a delegation detail record.
• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrivilegeType: string
  Maximum Length: 30

  The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• PtoObjectId: string
  Maximum Length: 50

  The unique identifier of a permit or planning and zoning transaction.
• PtoObjectKey: integer (int64)
  The unique key of a permit or planning and zoning transaction.
• PtoObjectType: string
  Title: Transaction Type

  Maximum Length: 30

  The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.
• Status: string
  Title: Status

  Maximum Length: 30

  The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.
• ToPrivilegeType: string
  Title: Change Privilege To

  Maximum Length: 30

  The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoObjectKey":{
            "type":"integer",
            "description":"The unique key of a permit or planning and zoning transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PtoObjectType":{
            "title":"Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DelegateDetailId":{
            "type":"integer",
            "description":"The unique identifier of a delegation detail record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ToPrivilegeType":{
            "title":"Change Privilege To",
            "maxLength":"30",
            "type":"string",
            "description":"The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivilegeType":{
            "maxLength":"30",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "PtoObjectId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of a permit or planning and zoning transaction.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorDelegates-DelegateHistory-item-response

Type: object

Show Source

• AttributeChanged: string
  Maximum Length: 30

  The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.
• ChangeAction: string
  Maximum Length: 30

  The action that created the change. Valid values are ACCEPTED and DECLINED.
• ChangeDate: string (date-time)
  The date and time when a change was made to a delegation???s status.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who initiated a delegation change request.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the delegation was created.
• DelegateDetailId: integer (int64)
  The delegation detail ID from the delegation detail table.
• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• DelegateHistoryId: integer (int64)
  The unique identifier for a delegation history record.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the delegation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the transaction delegation information.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated delegation information.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewValue: string
  Maximum Length: 30

  The new value of the attribute that was changed.
• PreviousValue: string
  Maximum Length: 30

  The previous value for the attribute that was changed.
• StatusUpdatedByGuid: string
  Maximum Length: 64

  The user GUID of the user whose action changed the status.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the transaction delegation information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateHistoryId":{
            "type":"integer",
            "description":"The unique identifier for a delegation history record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the delegation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who initiated a delegation change request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeAction":{
            "maxLength":"30",
            "type":"string",
            "description":"The action that created the change. Valid values are ACCEPTED and DECLINED.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusUpdatedByGuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The user GUID of the user whose action changed the status.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeDate":{
            "type":"string",
            "description":"The date and time when a change was made to a delegation???s status.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DelegateDetailId":{
            "type":"integer",
            "description":"The delegation detail ID from the delegation detail table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PreviousValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The previous value for the attribute that was changed.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NewValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The new value of the attribute that was changed.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChanged":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the delegation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated delegation information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

DelegateDetail

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetail

Parameters:

• DelegateHeaderId: $request.path.DelegateHeaderId

The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users.

DelegateHistory

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory

Parameters:

• DelegateHeaderId: $request.path.DelegateHeaderId

The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users.

declineInvitation

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/action/declineInvitation

Parameters:

• DelegateHeaderId: $request.path.DelegateHeaderId

Decline an invitation based on the given delegation ID and set the delegation to Disabled status

sendInvitation

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/action/sendInvitation

Parameters:

• DelegateHeaderId: $request.path.DelegateHeaderId

Send an invitation based on the given delegation ID, send out a notification, and set the delegation to Invitation Sent status

Back to Top