Get all pre-application meeting attributes
get
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingCommunications
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 notification row that matches the specified search criteria.
Finder Variables:- AssignedDatetime; string; The identifier of the date and time when a planner was assigned to Pre-application.
- AssigneeId; integer; The unique identifier of the assigned planner.
- LnpRecordKey; integer; The unique identifier of the Pre-application.
- MeetingId; integer; The unique identifier of the meeting.
- simpleSearchFinder: Finds the matching notification row by matching a list of fields.
Finder Variables:- value; string; Finds the value for which the search is performed.
- PrimaryKey: Finds the notification row that matches the specified search criteria.
-
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:- Address1; string; The address of the Pre-Application.
- Address2; string; The additional address of the Pre-Application.
- Address3; string; The additional address of the Pre-Application.
- Address4; string; The additional address of the Pre-Application.
- AgencyId; integer; The unique identifier of the public sector agency.
- Applicant; integer; The identifier of the applicant of the Pre-Application.
- ApplicantUserId; string; The user ID of the applicant as set up in the system.
- ApplicationStatus; string; The status of the application.
- AssignedDatetime; string; The identifier of the date and time when a planner was assigned to Pre-Application.
- AssigneeId; integer; The unique identifier of the assigned planner.
- City; string; The city of the Pre-Application.
- Classification; string; The unique identifier of the type of application.
- ContextRecordType; string; The unique identifier of the type of record.
- Country; string; The country of the Pre-Application.
- County; string; The county of the Pre-Application.
- Description; string; The additional information about the Pre-Application.
- DisplayName; string; The name of the planner.
- EmailAddress; string; The email of the planner.
- EmailAddress1; string; The email of the applicant.
- EmailAddress2; string; The additional email of the applicant.
- LnpRecordId; string; The unique identifier of the Pre-Application.
- LnpRecordKey; integer; The unique identifier of the Pre-Application.
- MeetingAgendaTextDisplay; string; The text of the meeting agenda.
- MeetingDurationHours; number; The unique identifier of the duration of the meeting.
- MeetingEndDttm; string; The unique identifier of the end date and time for the meeting.
- MeetingEndFormatted; string; The end date and time of the meeting shown in the agency date and time format.
- MeetingId; integer; The unique identifier of the meeting.
- MeetingStartDttm; string; The unique identifier of the start date and time for the meeting.
- MeetingStartFormatted; string; The start date and time of the meeting shown in the agency date and time format.
- MeetingSubject; string; The subject of the meeting.
- MeetingVenue; string; The identifier of the location of the meeting.
- PersonName; string; The name of the applicant.
- PlannerUserId; string; The user ID of the planner assigned to the application.
- PostalCode; string; The postal code of the Pre-Application.
- Province; string; The province of the Pre-Application.
- RecordTypeCode; string; The unique identifier of the Pre-Application.
- RecordTypeId; string; The record ID of the parent application for which the meeting is scheduled.
- State; string; The state of the Pre-Application.
- Status; string; The identifier of the status of the meeting.
- Subclassification; string; The identifier of the type of application based on classification.
- Tzname; string; The identifier of the time zone.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : publicSectorPreappMeetingCommunications
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 : publicSectorPreappMeetingCommunications-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
The address of the Pre-Application. -
Address2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
The additional address of the Pre-Application. -
Address3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
The additional address of the Pre-Application. -
Address4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
The additional address of the Pre-Application. -
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
The unique identifier of the public sector agency. -
Applicant: integer
(int64)
Title:
Applicant ID
Read Only:true
The identifier of the applicant of the Pre-Application. -
ApplicantUserId: string
Title:
Applicant User ID
Read Only:true
The user ID of the applicant as set up in the system. -
ApplicationStatus: string
Title:
Preapplication or Consultation Status
Read Only:true
Maximum Length:15
The status of the application. -
AssignedDatetime: string
(date-time)
Read Only:
true
The identifier of the date and time when a planner was assigned to Pre-Application. -
AssigneeId: integer
(int64)
Title:
Planner or Specialist ID
Read Only:true
The unique identifier of the assigned planner. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city of the Pre-Application. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The unique identifier of the type of application. -
ContextRecordType: string
Title:
Record Type ID
Read Only:true
Maximum Length:30
The unique identifier of the type of record. -
Country: string
Title:
Country
Read Only:true
Maximum Length:3
The country of the Pre-Application. -
County: string
Title:
County
Read Only:true
Maximum Length:60
The county of the Pre-Application. -
Description: string
Title:
Preapplication or Consultation Description
Read Only:true
Maximum Length:1000
The additional information about the Pre-Application. -
DisplayName: string
Title:
Planner or Specialist Name
Read Only:true
Maximum Length:240
The name of the planner. -
EmailAddress: string
Title:
Planner or Specialist Email
Read Only:true
Maximum Length:240
The email of the planner. -
EmailAddress1: string
Title:
Applicant Primary Email
Read Only:true
Maximum Length:320
The email of the applicant. -
EmailAddress2: string
Title:
Applicant Secondary Email
Read Only:true
Maximum Length:320
The additional email of the applicant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Preapplication or Consultation ID
Read Only:true
Maximum Length:50
The unique identifier of the Pre-Application. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the Pre-Application. -
MeetingAgendaTextDisplay: string
Title:
Meeting Agenda
Read Only:true
The text of the meeting agenda. -
MeetingAttendees: string
Title:
Invitees
Read Only:true
Maximum Length:4000
The list of additional attendees for the meeting. -
MeetingDurationHours: number
Title:
Meeting Duration in Hours
Read Only:true
The unique identifier of the duration of the meeting. -
MeetingEndDttm: string
(date-time)
Title:
Meeting End Time
Read Only:true
The unique identifier of the end date and time for the meeting. -
MeetingEndFormatted: string
Title:
End Date and Time in Agency Format
Read Only:true
The end date and time of the meeting shown in the agency date and time format. -
MeetingId: integer
(int64)
Title:
Meeting ID
Read Only:true
The unique identifier of the meeting. -
MeetingStartDttm: string
(date-time)
Title:
Meeting Start Time
Read Only:true
The unique identifier of the start date and time for the meeting. -
MeetingStartFormatted: string
Title:
Start Date and Time in Agency Format
Read Only:true
The start date and time of the meeting shown in the agency date and time format. -
MeetingSubject: string
Title:
Subject
Read Only:true
Maximum Length:4000
The subject of the meeting. -
MeetingVenue: string
Title:
Meeting Location
Read Only:true
Maximum Length:2000
The identifier of the location of the meeting. -
PersonName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The name of the applicant. -
PlannerUserId: string
Title:
Planner or Specialist User ID
Read Only:true
The user ID of the planner assigned to the application. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code of the Pre-Application. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
The province of the Pre-Application. -
RecordTypeCode: string
Title:
Record Type
Read Only:true
Maximum Length:20
The unique identifier of the Pre-Application. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The record ID of the parent application for which the meeting is scheduled. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state of the Pre-Application. -
Status: string
Title:
Meeting Status
Read Only:true
Maximum Length:10
The identifier of the status of the meeting. -
Subclassification: string
Title:
Subclassification
Read Only:true
Maximum Length:20
The identifier of the type of application based on classification. -
Tzname: string
Title:
Time Zone
Read Only:true
Maximum Length:64
The identifier of the time zone.
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.