Jump to

• Request
• Response

Get a meeting template

get

/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups/{publicSectorMeetingSetupsUniqID}

Request

Path Parameters

• publicSectorMeetingSetupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and MeetTemplateId ---for the Meeting Templates resource and used to uniquely identify an instance of Meeting Templates. The client should not generate the hash key value. Instead, the client should query on the Meeting Templates collection resource with a filter on the primary key values in order to navigate to a specific instance of Meeting Templates.
  
  For example: publicSectorMeetingSetups?q=AgencyId=<value1>;MeetTemplateId=<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 Top

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.

Body ()

Root Schema : publicSectorMeetingSetups-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Activity ID

  Default Value: 1

  The identifier of the public sector agency.
• ApplicantReschedule: string
  Title: Applicant can reschedule and cancel

  Maximum Length: 1

  Default Value: N

  The identifier to indicate if an applicant can reschedule or cancel a meeting.
• ApplicantSchedule: string
  Title: Applicant can request

  Maximum Length: 1

  Default Value: N

  The identifier to indicate if an applicant can schedule a meeting.
• Description: string
  Title: Description

  Maximum Length: 500

  The description of the meeting template.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  The identifier to indicate if the meeting template is enabled for assignment on the record type page.
• IncludeAgenda: string
  Title: Include Agenda

  Maximum Length: 1

  Default Value: N

  Indicates if the meeting agenda should be shown in the Schedule Meetings page.
• IncludeSubject: string
  Title: Include Subject

  Maximum Length: 1

  Default Value: N

  Indicates if the meeting subject should be shown in the Schedule Meetings page.
• IncludeVenue: string
  Title: Include Location

  Maximum Length: 1

  Default Value: N

  Indicates if the meeting location should be shown in the Schedule Meetings page.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaxMeetingConcurrency: integer (int32)
  Title: Maximum Concurrent Meetings

  Default Value: 1

  The identifier of the maximum number of meetings that can be conducted in parallel for a given period within the agency.
• MeetingAgendaPlainText: string (byte)
  The non rich text version of the meeting agenda.
• MeetingAgendaText: string (byte)
  Title: Meeting Agenda

  The rich text enabled description of the meeting agenda.
• MeetingDurationHours: number
  Title: Meeting Duration in Hours

  The identifier of the estimated duration of a meeting.
• MeetingSubject: string
  Title: Subject

  Maximum Length: 4000

  The text of the meeting subject to be shown in the Schedule Meetings page.
• MeetingVenue: string
  Title: Meeting Location

  Maximum Length: 2000

  The description of the meeting venue.
• MeetingWorkschedule: string
  Title: Work Schedule

  Maximum Length: 30

  The identifier to indicate the work schedule that will be used by the agency for the meeting configuration.
• MeetTemplateId: string
  Title: Template ID

  Maximum Length: 30

  The unique identifier of the meeting template.
• Name: string
  Title: Template

  Maximum Length: 50

  The name of the template.
• ScheduleUptoDays: integer (int32)
  Title: Schedule up to Number of Days

  The identifier of the number of days to display on the calendar for scheduling the meeting.
• StartOfWindow: integer (int32)
  Title: Schedule After Number of Days

  Default Value: 0

  The identifier to indicate the number of days in advance after which the meeting can be configured.
• UseScheduleAgency: string
  Title: Agency meeting schedule

  Maximum Length: 1

  The identifier to indicate if an agency work schedule is to be used for configuration.
• UseSchedulePlanner: string
  Title: Staff meeting schedule

  Maximum Length: 1

  The identifier to indicate if planners work schedule is to be used for the configuration.

{
    "type":"object",
    "properties":{
        "IncludeAgenda":{
            "title":"Include Agenda",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the meeting agenda should be shown in the Schedule Meetings page.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The description of the meeting template.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ScheduleUptoDays":{
            "title":"Schedule up to Number of Days",
            "type":"integer",
            "description":"The identifier of the number of days to display on the calendar for scheduling the meeting.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "MeetingWorkschedule":{
            "title":"Work Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier to indicate the work schedule that will be used by the agency for the meeting configuration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaxMeetingConcurrency":{
            "title":"Maximum Concurrent Meetings",
            "type":"integer",
            "description":"The identifier of the maximum number of meetings that can be conducted in parallel for a given period within the agency.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "StartOfWindow":{
            "title":"Schedule After Number of Days",
            "type":"integer",
            "description":"The identifier to indicate the number of days in advance after which the meeting can be configured.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "MeetingVenue":{
            "title":"Meeting Location",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the meeting venue.",
            "nullable":true,
            "x-queryable":true
        },
        "UseScheduleAgency":{
            "title":"Agency meeting schedule",
            "maxLength":"1",
            "type":"string",
            "description":"The identifier to indicate if an agency work schedule is to be used for configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Template",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the template.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicantReschedule":{
            "title":"Applicant can reschedule and cancel",
            "maxLength":"1",
            "type":"string",
            "description":"The identifier to indicate if an applicant can reschedule  or cancel a meeting.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "MeetingSubject":{
            "title":"Subject",
            "maxLength":"4000",
            "type":"string",
            "description":"The text of the meeting subject to be shown in the Schedule Meetings page.",
            "nullable":true,
            "x-queryable":true
        },
        "MeetTemplateId":{
            "title":"Template ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the meeting template.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicantSchedule":{
            "title":"Applicant can request",
            "maxLength":"1",
            "type":"string",
            "description":"The identifier to indicate if an applicant can schedule a meeting.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "MeetingAgendaText":{
            "title":"Meeting Agenda",
            "type":"string",
            "description":"The rich text enabled description of the meeting agenda.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MeetingAgendaPlainText":{
            "type":"string",
            "description":"The non rich text version of the meeting agenda.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "IncludeVenue":{
            "title":"Include Location",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the meeting location should be shown in the Schedule Meetings page.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IncludeSubject":{
            "title":"Include Subject",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the meeting subject should be shown in the Schedule Meetings page.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"The identifier to indicate if the meeting template is enabled for assignment on the record type page.",
            "nullable":false,
            "x-queryable":true
        },
        "UseSchedulePlanner":{
            "title":"Staff meeting schedule",
            "maxLength":"1",
            "type":"string",
            "description":"The identifier to indicate if planners work schedule is to be used for the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "MeetingDurationHours":{
            "title":"Meeting Duration in Hours",
            "type":"number",
            "description":"The identifier of the estimated duration of a meeting.",
            "nullable":false,
            "x-hints":{
                "precision":"2",
                "scale":"1"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top