Get all delegate information
get
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the delegate that matches the primary key specified.
Finder Variables:- DelegateHeaderId; integer; The unique identifier for a delegate.
- simpleSearchFinder: Finds the delegate information that matches the specified filter values.
Finder Variables:- sValue; string.
- value; string; The filter values such as Delegate Header ID to be applied when finding delegate information.
- PrimaryKey: Finds the delegate that matches the primary key specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- DelegateContactId; integer; Contact ID of the delegate as a contact.
- DelegateEmailId; string; The email of a delegate user.
- DelegateHeaderId; integer; The unique identifier of a delegation.
- DelegatePartyId; integer; The party ID for the delegate user.
- DelegatePersonFirstName; string; The first name of a delegate user.
- DelegatePersonLastName; string; The last name of a delegate user.
- DelegatePhoneNumber; string; The phone number of a delegate user.
- DelegatePreferredContactMethod; string; The delegate user's preferred way of receiving communication. The value is ORA_TEXT for text or blank for email.
- DelegateProfileId; integer; The account profile ID of a delegate user.
- DelegateProfileName; string; Delegate user's account profile name.
- DelegatePscUserId; integer; The unique identifier of a delegate as a registered public user.
- DelegateUserGuid; string; The unique user GUID of a delegate user.
- DelegateUserId; integer; The unique Fusion user ID for the delegate user.
- DelegateUserName; string; The user name that a delegate uses to sign into the system.
- DelegationStatus; string; 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; 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; Status indicating whether email notifications sent to the transaction owner for delegate actions are suppressed. Valid values are Y and N.
- PrivilegeType; string; 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; Email of the profile or transaction owner.
- PtoPartyId; integer; The party ID of the profile or transaction owner.
- PtoPersonFirstName; string; The first name of the profile or transaction owner.
- PtoPersonLastName; string; The last name of the profile or transaction owner.
- PtoPersonMiddleName; string; The middle name of the profile or transaction owner.
- PtoPersonName; string; The name of the profile or transaction owner.
- PtoPhoneAreaCode; string; The phone area code of the profile or transaction owner.
- PtoPhoneCountryCode; string; The phone country code of the profile or transaction owner.
- PtoPhoneExtension; string; The phone extension of the profile or transaction owner.
- PtoPhoneNumber; string; The phone number of the profile or transaction owner.
- PtoPreferredContactMethod; string; The profile or transaction owner's preferred way of receiving communication. The value is ORA_TEXT for text, or blank for email.
- PtoProfileId; integer; The account profile ID of the profile or transaction owner.
- PtoProfileName; string; Profile or transaction owner's account profile name.
- PtoPscUserId; integer; The unique identifier for a transaction owner as a registered public user.
- PtoUserGuid; string; The unique user GUID for a delegate user.
- PtoUserId; integer; The unique Fusion user ID for the profile or transaction owner.
- PtoUserName; string; The user name of the profile or transaction owner.
- RequestType; string; 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 of the most recent delegation status change.
- ToDelegationStatus; string; 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; 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; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
- getProfileDelegationPrivilege
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDelegates/action/getProfileDelegationPrivilegeGet the delegation privilege based on a given profile ID or Transaction ID