Get a meeting
get
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}
Request
Path Parameters
-
MeetingId(required): integer(int64)
The unique identifier of the meeting.
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 : publicSectorMeetingRosters-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency. -
Classification: string
Title:
Classification
Maximum Length:3
The classification of the type of application. -
ContextRecordKey: integer
(int64)
Title:
Record Key
The identifier of the parent application for which the meeting is scheduled. -
ContextRecordType: string
Title:
Record Type
Maximum Length:30
Indicates the parent application for which the meeting is scheduled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeetingAgenda: string
Title:
Meeting Agenda
Maximum Length:4000
The identifier of the meeting agenda. -
MeetingAgendaPlain: string
(byte)
The identifier of the meeting agenda that is NOT in rich text format.
-
MeetingAgendaText: string
(byte)
The identifier of the meeting agenda that is in rich text format.
-
MeetingAttendees: string
Title:
Invitees
Maximum Length:4000
The email IDs of the meeting attendees. -
MeetingDurationHours: number
Title:
Meeting Duration in Hours
The identifier of the duration of the meeting. -
MeetingEndDttm: string
(date-time)
Title:
Meeting End Time
The identifier of the end date and time of the meeting. -
MeetingId: integer
(int64)
Title:
Meeting ID
The unique identifier of the meeting. -
MeetingParticipant: array
Meeting Participants
Title:
Meeting Participants
The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting. -
MeetingStartDttm: string
(date-time)
Title:
Meeting Start Time
The identifier of the start date and time of the meeting. -
MeetingSubject: string
Title:
Subject
Maximum Length:4000
The subject of the meeting. -
MeetingVenue: string
Title:
Meeting Location
Maximum Length:2000
The identifier of the venue of the meeting. -
RescheduleFlag: string
Maximum Length:
1
The identifier of the rescheduled meeting. -
SourceMeetingId: integer
(int64)
Identifies the source of the rescheduled meeting.
-
Status: string
Title:
Meeting Status
Maximum Length:10
The identifier of the status of the meeting. -
Subclassification: string
Title:
Subclassification
Maximum Length:20
The subclassification of the type of application. -
Tzname: string
Title:
Time Zone
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 : Meeting Participants
Type:
array
Title:
Meeting Participants
The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting.
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 : publicSectorMeetingRosters-MeetingParticipant-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency. -
IsOrganizer: string
Title:
Organizer
Maximum Length:1
Default Value:N
The identifier of the meeting organizer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeetingId: integer
(int64)
Title:
Meeting ID
The unique identifier of the meeting to which the participant is associated. -
ParticipantNum: integer
(int64)
Identifies the participant associated with the meeting.
-
PartyId: integer
(int64)
Title:
Registered Public User ID
The identifier of the registered user. -
PersonId: integer
(int64)
Title:
Worker ID
The identifier of the agency staff.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- MeetingParticipant
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters/{MeetingId}/child/MeetingParticipantParameters:
- MeetingId:
$request.path.MeetingId
The public sector meeting participants resource is used to view, add, and remove participants tagged to a meeting. - MeetingId: