Jump to

• Request
• Response

Create a set of Pre-application meeting setup attributes

post

/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingConfigs

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

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

Root Schema : publicSectorPreappMeetingConfigs-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The identifier of the public sector agency.
• ApplicantReschedule(optional): string
  Title: Applicant can reschedule and cancel

  Maximum Length: 1

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

  Maximum Length: 1

  The identifier to indicate if an applicant can schedule a meeting.
• Classification(optional): string
  Maximum Length: 3

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

  Maximum Length: 1

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

  Maximum Length: 1

  Indicates if the meeting location should be shown in schedule meetings page.
• links(optional): array Items
  Title: Items

  Link Relations
• Meaning(optional): string
  Maximum Length: 80

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

  Maximum Length: 4000

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

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

  Maximum Length: 2000

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

  The identifier of the application type.
• PreappWorkschedule(optional): 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(optional): 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(optional): 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(optional): string
  Title: Agency meeting schedule

  Maximum Length: 1

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

  Maximum Length: 1

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency."
        },
        "ApplicantReschedule":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if an applicant can reschedule  or cancel a meeting.",
            "title":"Applicant can reschedule and cancel"
        },
        "ApplicantSchedule":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if an applicant can schedule a meeting.",
            "title":"Applicant can request"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The identifier indicates that the setup being configured is for the Consultation or Pre-Application."
        },
        "IncludeAgenda":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting agenda should be shown in schedule meetings page.",
            "title":"Include Agenda"
        },
        "IncludeVenue":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting location should be shown in schedule meetings page.",
            "title":"Include Location"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the classification."
        },
        "MeetingAgenda":{
            "maxLength":4000,
            "type":"string",
            "description":"The description of the meeting agenda.",
            "title":"Meeting Agenda"
        },
        "MeetingDurationHours":{
            "type":"number",
            "description":"The identifier of the estimated duration of a meeting.",
            "title":"Meeting Duration in Hours"
        },
        "MeetingVenue":{
            "maxLength":2000,
            "type":"string",
            "description":"The description of the meeting venue.",
            "title":"Meeting Location"
        },
        "PreappType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the application type."
        },
        "PreappWorkschedule":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier to indicate the work schedule that will be used by the agency for the meeting configuration.",
            "title":"Pre-application Work Schedule"
        },
        "ScheduleUptoDays":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the number of days to display on the calendar for scheduling the meeting.",
            "title":"Schedule up to Number of Days"
        },
        "StartOfWindow":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier to indicate the number of days in advance after which the meeting can be configured.",
            "title":"Schedule After Number of Days"
        },
        "UseScheduleAgency":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if an agency work schedule is to be used for configuration.",
            "title":"Agency meeting schedule"
        },
        "UseSchedulePlanner":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if planners work schedule is to be used for the configuration.",
            "title":"Planner meeting schedule"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPreappMeetingConfigs-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The identifier of the public sector agency.
• ApplicantReschedule(optional): string
  Title: Applicant can reschedule and cancel

  Maximum Length: 1

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

  Maximum Length: 1

  The identifier to indicate if an applicant can schedule a meeting.
• Classification(optional): string
  Maximum Length: 3

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

  Maximum Length: 1

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

  Maximum Length: 1

  Indicates if the meeting location should be shown in schedule meetings page.
• links(optional): array Items
  Title: Items

  Link Relations
• Meaning(optional): string
  Maximum Length: 80

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

  Maximum Length: 4000

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

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

  Maximum Length: 2000

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

  The identifier of the application type.
• PreappWorkschedule(optional): 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(optional): 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(optional): 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(optional): string
  Title: Agency meeting schedule

  Maximum Length: 1

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

  Maximum Length: 1

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency."
        },
        "ApplicantReschedule":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if an applicant can reschedule  or cancel a meeting.",
            "title":"Applicant can reschedule and cancel"
        },
        "ApplicantSchedule":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if an applicant can schedule a meeting.",
            "title":"Applicant can request"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The identifier indicates that the setup being configured is for the Consultation or Pre-Application."
        },
        "IncludeAgenda":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting agenda should be shown in schedule meetings page.",
            "title":"Include Agenda"
        },
        "IncludeVenue":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the meeting location should be shown in schedule meetings page.",
            "title":"Include Location"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the classification."
        },
        "MeetingAgenda":{
            "maxLength":4000,
            "type":"string",
            "description":"The description of the meeting agenda.",
            "title":"Meeting Agenda"
        },
        "MeetingDurationHours":{
            "type":"number",
            "description":"The identifier of the estimated duration of a meeting.",
            "title":"Meeting Duration in Hours"
        },
        "MeetingVenue":{
            "maxLength":2000,
            "type":"string",
            "description":"The description of the meeting venue.",
            "title":"Meeting Location"
        },
        "PreappType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the application type."
        },
        "PreappWorkschedule":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier to indicate the work schedule that will be used by the agency for the meeting configuration.",
            "title":"Pre-application Work Schedule"
        },
        "ScheduleUptoDays":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the number of days to display on the calendar for scheduling the meeting.",
            "title":"Schedule up to Number of Days"
        },
        "StartOfWindow":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier to indicate the number of days in advance after which the meeting can be configured.",
            "title":"Schedule After Number of Days"
        },
        "UseScheduleAgency":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if an agency work schedule is to be used for configuration.",
            "title":"Agency meeting schedule"
        },
        "UseSchedulePlanner":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate if planners work schedule is to be used for the configuration.",
            "title":"Planner meeting schedule"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top