1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Communications
  4. Activity Communications

Get all activity communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorActivityCommunications

Request

Query Parameters
  • 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).
  • 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
  • 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 activity communication data using the specified record key.
      Finder Variables:
      • ActivityLogKey; integer; The unique identifier for the record key.
      • LnpRecordKey; integer; The unique identifier for the record key.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ActivityGroupId; string; The identifier for the activity group ID.
    • ActivityGroupName; string; The activity group name.
    • ActivityId; string; The identifier for the activity.
    • ActivityLogId; string; The unique identifier for the activity log ID.
    • ActivityLogKey; integer; The unique identifier for the entitlement activity log key.
    • ActivityName; string; The activity name.
    • ActivityStatus; string; The status of the activity.
    • ActualCompletionDate; string; The date when the activity is completed.
    • ApplExpirationDate; string; The date when the license or planning is no longer valid.
    • Applicant; integer; The party ID of the plannng applicant.
    • ApplicantBizProfileId; integer; The business profile used by the applicant.
    • ApplicantProfileId; integer; The user profile of the applicant.
    • AssigneeEmail; string; The email for the assigned planner.
    • AssigneeId; integer; The assigned planner ID.
    • AssigneeName; string; The name of the assigned planner.
    • AssigneePhone; string; The phone for the assigned planner.
    • AssigneeUserid; string; The assigned planner user ID.
    • AttributeCategory; string; The attribute category information.
    • BalanceDue; string; The balance due for the planning application.
    • BaseDate; string; The base date field used to calculate the activity due date.
    • Classification; string; The planning application classification.
    • DuedateBasis; string; The base date field used to calculate the activity due date.
    • EmailAddress1; string; The first email address of the planning applicant.
    • EmailAddress2; string; The second email address of the planning applicant.
    • LnpRecordId; string; The identifier for the planning record.
    • LnpRecordKey; integer; The key identifier for the planning record.
    • Meaning; string; The description of the base date.
    • OccuranceCount; integer; The activity occurence count.
    • OrganizationName; string; The business name of the applicant. For example, a contractor enters his or her contracting business name.
    • ParcelAddress1; string; The first line of the parcel or property address.
    • ParcelAddress2; string; The second line of the parcel or property address.
    • ParcelAddressKey; integer; The parcel address key.
    • ParcelCity; string; The city in the parcel or property address.
    • ParcelCountry; string; The country in the parcel or property address.
    • ParcelCounty; string; The county in the parcel or property address.
    • ParcelId; integer; The identifier of the record parcel.
    • ParcelKey; integer; The key of the record parcel.
    • ParcelPostalCode; string; The postal code in the parcel or property address.
    • ParcelProvince; string; The province in the parcel or property address.
    • ParcelState; string; The state in the parcel or property address.
    • ParcelType; string; The type of the current parcel.
    • PersonName; string; The planning applicant name.
    • PhoneAreaCode; string; The area code in the phone number of the planning applicant.
    • PhoneCountryCode; string; The country code in the phone number of the planning applicant.
    • PhoneExtension; string; The phone number extension for the planning applicant.
    • PhoneNumber; string; The planning applicant phone number.
    • PlannedDueDate; string; The activity planned due date.
    • PlanningDescription; string; The description of the planning type.
    • Planningstatus; string; The status of the planning record.
    • ProcessId; number; The transaction workflow process ID.
    • ProjectKey; integer; The project name information for a planning
    • PropertyDescription; string; The property description.
    • RecordStatus; string; The status of the record.
    • RecordType; string; The planning type. Agencies define the types of planning that they administer, for example, Residential Addition.
    • RecordTypeId; string; The identifier for a record type.
    • Subclassification; string; The planning application subclassification.
    • SubmitDate; string; The date when the license and planning transaction was submitted. Used in the application information component of the planning Designer.
    • SystemStatus; string; The system status.
    • TranType; string; The transaction type of the event trigger.
    • TransactionId; string; The transaction reference ID.
    • TransactionKey; integer; The transaction reference key.
    • TransactionReferenceId; string; The transaction reference ID.
    • TransactionReferenceKey; integer; The transaction reference key.
    • UpdatedByUser; string; The user who last updated the activity.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorActivityCommunications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorActivityCommunications-item-response
Type: object
Show Source
Back to Top