Create a set of meetings
post
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingRosters
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency. -
Classification(required): string
Title:
Classification
Maximum Length:3
The classification of the type of application. -
ContextRecordKey(required): 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. -
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(required): 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(required): 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 : 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 : publicSectorMeetingRosters-MeetingParticipant-item-post-request
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. -
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.
Response
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 : 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: