Get an activity communication item
get
/fscmRestApi/resources/11.13.18.05/publicSectorActivityCommunications/{publicSectorActivityCommunicationsUniqID}
Request
Path Parameters
-
publicSectorActivityCommunicationsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ActivityLogKey and LnpRecordKey ---for the Activity Communications resource and used to uniquely identify an instance of Activity Communications. The client should not generate the hash key value. Instead, the client should query on the Activity Communications collection resource with a filter on the primary key values in order to navigate to a specific instance of Activity Communications.
For example: publicSectorActivityCommunications?q=ActivityLogKey=<value1>;LnpRecordKey=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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(required):
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(required):
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 : publicSectorActivityCommunications-item-response
Type:
Show Source
object
-
ActivityGroupId: string
Read Only:
true
Maximum Length:30
The identifier for the activity group ID. -
ActivityGroupName: string
Title:
Activity Group
Read Only:true
Maximum Length:250
The activity group name. -
ActivityId: string
Title:
Activity ID
Read Only:true
Maximum Length:50
The identifier for the activity. -
ActivityLogId: string
Maximum Length:
65
The unique identifier for the activity log ID. -
ActivityLogKey: integer
The unique identifier for the entitlement activity log key.
-
ActivityName: string
Title:
Activity
Read Only:true
Maximum Length:250
The activity name. -
ActivityStatus: string
Title:
Activity Status
Read Only:true
Maximum Length:30
The status of the activity. -
ActualCompletionDate: string
(date)
Title:
Completion Date
Read Only:true
The date when the activity is completed. -
ApplExpirationDate: string
(date-time)
Title:
Application Expiration Date
Read Only:true
The date when the license or planning is no longer valid. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the plannng applicant. -
ApplicantBizProfileId: integer
(int64)
Title:
Business Profile
Read Only:true
The business profile used by the applicant. -
ApplicantProfileId: integer
(int64)
Title:
Applicant Profile
Read Only:true
The user profile of the applicant. -
AssigneeEmail: string
Title:
Assigned Planner Email
The email for the assigned planner. -
AssigneeId: integer
(int64)
Read Only:
true
The assigned planner ID. -
AssigneeName: string
Title:
Assigned Planner Name
Read Only:true
The name of the assigned planner. -
AssigneePhone: string
Title:
Assigned Planner Phone
Read Only:true
The phone for the assigned planner. -
AssigneeUserid: string
Read Only:
true
Maximum Length:64
The assigned planner user ID. -
AttributeCategory: string
Read Only:
true
Maximum Length:30
The attribute category information. -
BalanceDue: string
Title:
Balance Due
Read Only:true
The balance due for the planning application. -
BaseDate: string
(date)
Read Only:
true
The base date field used to calculate the activity due date. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The planning application classification. -
DuedateBasis: string
Read Only:
true
Maximum Length:30
The base date field used to calculate the activity due date. -
EmailAddress1: string
Title:
Applicant Email 1
Read Only:true
Maximum Length:320
The first email address of the planning applicant. -
EmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The second email address of the planning applicant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Application ID
Read Only:true
Maximum Length:50
The identifier for the planning record. -
LnpRecordKey: integer
(int64)
Read Only:
true
The key identifier for the planning record. -
Meaning: string
Read Only:
true
Maximum Length:80
The description of the base date. -
OccuranceCount: integer
(int32)
Title:
Activity Count
Read Only:true
The activity occurence count. -
OrganizationName: string
Read Only:
true
Maximum Length:360
The business name of the applicant. For example, a contractor enters his or her contracting business name. -
ParcelAddress1: string
Title:
Parcel Address 1
Read Only:true
Maximum Length:240
The first line of the parcel or property address. -
ParcelAddress2: string
Title:
Parcel Address 2
Read Only:true
Maximum Length:240
The second line of the parcel or property address. -
ParcelAddressKey: integer
(int64)
Read Only:
true
The parcel address key. -
ParcelCity: string
Title:
Parcel City
Read Only:true
Maximum Length:60
The city in the parcel or property address. -
ParcelCountry: string
Title:
Parcel Country
Read Only:true
Maximum Length:60
The country in the parcel or property address. -
ParcelCounty: string
Title:
Parcel County
Read Only:true
Maximum Length:60
The county in the parcel or property address. -
ParcelId: integer
(int64)
Read Only:
true
The identifier of the record parcel. -
ParcelKey: integer
(int64)
Read Only:
true
The key of the record parcel. -
ParcelPostalCode: string
Title:
Parcel Postal Code
Read Only:true
Maximum Length:60
The postal code in the parcel or property address. -
ParcelProvince: string
Title:
Parcel Province
Read Only:true
Maximum Length:60
The province in the parcel or property address. -
ParcelState: string
Title:
Parcel State
Read Only:true
Maximum Length:60
The state in the parcel or property address. -
ParcelType: string
Read Only:
true
Maximum Length:30
The type of the current parcel. -
PersonName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The planning applicant name. -
PhoneAreaCode: string
Title:
Applicant Phone Area Code
Read Only:true
Maximum Length:10
The area code in the phone number of the planning applicant. -
PhoneCountryCode: string
Title:
Applicant Phone Country Code
Read Only:true
Maximum Length:10
The country code in the phone number of the planning applicant. -
PhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The phone number extension for the planning applicant. -
PhoneNumber: string
Title:
Applicant Phone Number
Read Only:true
Maximum Length:40
The planning applicant phone number. -
PlannedDueDate: string
(date)
Title:
Planned Due Date
Read Only:true
The activity planned due date. -
PlanningDescription: string
Title:
Application Description
Read Only:true
Maximum Length:1000
The description of the planning type. -
Planningstatus: string
Title:
Application Status
Read Only:true
Maximum Length:15
The status of the planning record. -
ProcessId: number
Read Only:
true
The transaction workflow process ID. -
ProjectKey: integer
(int64)
Title:
Project
Read Only:true
The project name information for a planning -
PropertyDescription: string
Read Only:
true
Maximum Length:240
The property description. -
RecordStatus: string
Read Only:
true
Maximum Length:15
The status of the record. -
RecordType: string
Title:
Application Type
Read Only:true
Maximum Length:100
The planning type. Agencies define the types of planning that they administer, for example, Residential Addition. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The identifier for a record type. -
Subclassification: string
Title:
Subclassification
Read Only:true
Maximum Length:10
The planning application subclassification. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date when the license and planning transaction was submitted. Used in the application information component of the planning Designer. -
SystemStatus: string
Read Only:
true
Maximum Length:15
The system status. -
TransactionId: string
Read Only:
true
Maximum Length:50
The transaction reference ID. -
TransactionKey: integer
(int64)
Read Only:
true
The transaction reference key. -
TransactionReferenceId: string
Read Only:
true
Maximum Length:50
The transaction reference ID. -
TransactionReferenceKey: integer
(int64)
Read Only:
true
The transaction reference key. -
TranType: string
Read Only:
true
Maximum Length:30
The transaction type of the event trigger. -
UpdatedByUser: string
Read Only:
true
Maximum Length:64
The user who last updated the activity.
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.