Create a set of delegate information
post
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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(required): 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(required): string
Title:
Delegate First Name
The first name of a delegate user. -
DelegatePersonLastName(required): 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(required): 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(required): 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(required): 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(required): 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.
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
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
Nested Schema : schema
Type:
Show Source
object
-
DelegateDetailId: integer
(int64)
The unique identifier of a delegation detail record.
-
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
-
DelegateHistoryId: integer
(int64)
The unique identifier for a delegation history record.
-
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.
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.
Root Schema : publicSectorDelegates-item-response
Type:
Show Source
object
-
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.
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
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDelegates-DelegateDetail-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorDelegates-DelegateHistory-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DelegateDetail
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateDetailParameters:
- DelegateHeaderId:
$request.path.DelegateHeaderId
The delegate details resource is used to view, create, delete or modify delegate detail information for registered public users. - DelegateHeaderId:
- DelegateHistory
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistoryParameters:
- DelegateHeaderId:
$request.path.DelegateHeaderId
The delegate histories resource is used to view, create, delete or modify delegate history information for registered public users. - DelegateHeaderId:
- declineInvitation
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/action/declineInvitationParameters:
- DelegateHeaderId:
$request.path.DelegateHeaderId
Decline an invitation based on the given delegation ID and set the delegation to Disabled status - DelegateHeaderId:
- sendInvitation
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/action/sendInvitationParameters:
- 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 - DelegateHeaderId: