Jump to

• Request
• Response

Create a set of Pre-application meeting setup attributes

post

/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  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.
• Classification: string
  Maximum Length: 3

  The identifier indicates that the setup being configured is for the Consultation or Pre-Application.
• IncludeAgenda: string
  Title: Include Agenda

  Maximum Length: 1

  Default Value: N

  Indicates if the meeting agenda should be shown in schedule meetings page.
• IncludeVenue: string
  Title: Include Location

  Maximum Length: 1

  Default Value: N

  Indicates if the meeting location should be shown in schedule meetings page.
• 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.
• MeetingAgenda: string
  Title: Meeting Agenda

  Maximum Length: 4000

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

  The identifier of the estimated duration of a meeting.
• MeetingVenue: string
  Title: Meeting Location

  Maximum Length: 2000

  The description of the meeting venue.
• PreappType: string
  Maximum Length: 30

  Default Value: DFLT

  The identifier of the application type.
• PreappWorkschedule: string
  Title: Pre-application Work Schedule

  Maximum Length: 30

  The identifier to indicate the work schedule that will be used by the agency for the meeting configuration.
• 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

  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: Planner meeting schedule

  Maximum Length: 1

  Default Value: Y

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

{
    "type":"object",
    "properties":{
        "PreappWorkschedule":{
            "title":"Pre-application 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"
            }
        },
        "IncludeAgenda":{
            "title":"Include Agenda",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting agenda should be shown in schedule meetings page.",
            "nullable":true,
            "default":"N"
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "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
            }
        },
        "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,
                "PAYLOADHINT":"Show"
            }
        },
        "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,
            "x-hints":{
                "precision":3
            }
        },
        "MeetingVenue":{
            "title":"Meeting Location",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the meeting venue.",
            "nullable":true
        },
        "PreappType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the application type.",
            "nullable":false,
            "default":"DFLT"
        },
        "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
        },
        "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"
        },
        "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"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The identifier indicates that the setup being configured is for the Consultation or Pre-Application.",
            "nullable":false
        },
        "IncludeVenue":{
            "title":"Include Location",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting location should be shown in schedule meetings page.",
            "nullable":true,
            "default":"N"
        },
        "MeetingAgenda":{
            "title":"Meeting Agenda",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the meeting agenda.",
            "nullable":true
        },
        "UseSchedulePlanner":{
            "title":"Planner meeting schedule",
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if planners work schedule is to be used for the configuration.",
            "nullable":false,
            "default":"Y"
        },
        "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
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : publicSectorPreappMeetingConfigs-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  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.
• Classification: string
  Maximum Length: 3

  The identifier indicates that the setup being configured is for the Consultation or Pre-Application.
• IncludeAgenda: string
  Title: Include Agenda

  Maximum Length: 1

  Default Value: N

  Indicates if the meeting agenda should be shown in schedule meetings page.
• IncludeVenue: string
  Title: Include Location

  Maximum Length: 1

  Default Value: N

  Indicates if the meeting location should be shown in 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.
• Meaning: string
  Read Only: true

  Maximum Length: 80

  The description of the classification.
• MeetingAgenda: string
  Title: Meeting Agenda

  Maximum Length: 4000

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

  The identifier of the estimated duration of a meeting.
• MeetingVenue: string
  Title: Meeting Location

  Maximum Length: 2000

  The description of the meeting venue.
• PreappType: string
  Maximum Length: 30

  Default Value: DFLT

  The identifier of the application type.
• PreappWorkschedule: string
  Title: Pre-application Work Schedule

  Maximum Length: 30

  The identifier to indicate the work schedule that will be used by the agency for the meeting configuration.
• 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

  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: Planner meeting schedule

  Maximum Length: 1

  Default Value: Y

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

{
    "type":"object",
    "properties":{
        "PreappWorkschedule":{
            "title":"Pre-application 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
        },
        "IncludeAgenda":{
            "title":"Include Agenda",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting agenda should be shown in schedule meetings page.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "AgencyId":{
            "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
        },
        "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,
                "PAYLOADHINT":"Show"
            },
            "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,
            "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
        },
        "PreappType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the application type.",
            "nullable":false,
            "default":"DFLT",
            "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
        },
        "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
        },
        "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
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The identifier indicates that the setup being configured is for the Consultation or Pre-Application.",
            "nullable":false,
            "x-queryable":true
        },
        "IncludeVenue":{
            "title":"Include Location",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting location should be shown in 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"
            }
        },
        "MeetingAgenda":{
            "title":"Meeting Agenda",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the meeting agenda.",
            "nullable":true,
            "x-queryable":true
        },
        "UseSchedulePlanner":{
            "title":"Planner meeting schedule",
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if planners work schedule is to be used for the configuration.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the classification.",
            "nullable":false,
            "readOnly":true,
            "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