Jump to

• Request
• Response

Get a pre-application meeting attribute

get

/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingCommunications/{publicSectorPreappMeetingCommunicationsUniqID}

Request

Path Parameters

• publicSectorPreappMeetingCommunicationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Pre-application Meeting Communications resource and used to uniquely identify an instance of Pre-application Meeting Communications. The client should not generate the hash key value. Instead, the client should query on the Pre-application Meeting Communications collection resource in order to navigate to a specific instance of Pre-application Meeting Communications to get the hash key.

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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : publicSectorPreappMeetingCommunications-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The address of the Pre-Application.
• Address2: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  The additional address of the Pre-Application.
• Address3: string
  Title: Address Line 3

  Read Only: true

  Maximum Length: 240

  The additional address of the Pre-Application.
• Address4: string
  Title: Address Line 4

  Read Only: true

  Maximum Length: 240

  The additional address of the Pre-Application.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  The unique identifier of the public sector agency.
• Applicant: integer (int64)
  Title: Applicant ID

  Read Only: true

  The identifier of the applicant of the Pre-Application.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  The user ID of the applicant as set up in the system.
• ApplicationStatus: string
  Title: Preapplication or Consultation Status

  Read Only: true

  Maximum Length: 15

  The status of the application.
• AssignedDatetime: string (date-time)
  Read Only: true

  The identifier of the date and time when a planner was assigned to Pre-Application.
• AssigneeId: integer (int64)
  Title: Planner or Specialist ID

  Read Only: true

  The unique identifier of the assigned planner.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the Pre-Application.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The unique identifier of the type of application.
• ContextRecordType: string
  Title: Record Type ID

  Read Only: true

  Maximum Length: 30

  The unique identifier of the type of record.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country of the Pre-Application.
• County: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county of the Pre-Application.
• Description: string
  Title: Preapplication or Consultation Description

  Read Only: true

  Maximum Length: 1000

  The additional information about the Pre-Application.
• DisplayName: string
  Title: Planner or Specialist Name

  Read Only: true

  Maximum Length: 240

  The name of the planner.
• EmailAddress: string
  Title: Planner or Specialist Email

  Read Only: true

  Maximum Length: 240

  The email of the planner.
• EmailAddress1: string
  Title: Applicant Primary Email

  Read Only: true

  Maximum Length: 320

  The email of the applicant.
• EmailAddress2: string
  Title: Applicant Secondary Email

  Read Only: true

  Maximum Length: 320

  The additional email of the applicant.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Preapplication or Consultation ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the Pre-Application.
• LnpRecordKey: integer (int64)
  Title: Application ID

  Read Only: true

  The unique identifier of the Pre-Application.
• MeetingAgendaTextDisplay: string
  Title: Meeting Agenda

  Read Only: true

  The text of the meeting agenda.
• MeetingAttendees: string
  Title: Invitees

  Read Only: true

  Maximum Length: 4000

  The list of additional attendees for the meeting.
• MeetingDurationHours: number
  Title: Meeting Duration in Hours

  Read Only: true

  The unique identifier of the duration of the meeting.
• MeetingEndDttm: string (date-time)
  Title: Meeting End Time

  Read Only: true

  The unique identifier of the end date and time for the meeting.
• MeetingEndFormatted: string
  Title: End Date and Time in Agency Format

  Read Only: true

  The end date and time of the meeting shown in the agency date and time format.
• MeetingId: integer (int64)
  Title: Meeting ID

  Read Only: true

  The unique identifier of the meeting.
• MeetingStartDttm: string (date-time)
  Title: Meeting Start Time

  Read Only: true

  The unique identifier of the start date and time for the meeting.
• MeetingStartFormatted: string
  Title: Start Date and Time in Agency Format

  Read Only: true

  The start date and time of the meeting shown in the agency date and time format.
• MeetingSubject: string
  Title: Subject

  Read Only: true

  Maximum Length: 4000

  The subject of the meeting.
• MeetingVenue: string
  Title: Meeting Location

  Read Only: true

  Maximum Length: 2000

  The identifier of the location of the meeting.
• PersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The name of the applicant.
• PlannerUserId: string
  Title: Planner or Specialist User ID

  Read Only: true

  The user ID of the planner assigned to the application.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code of the Pre-Application.
• Province: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province of the Pre-Application.
• RecordTypeCode: string
  Title: Record Type

  Read Only: true

  Maximum Length: 20

  The unique identifier of the Pre-Application.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The record ID of the parent application for which the meeting is scheduled.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the Pre-Application.
• Status: string
  Title: Meeting Status

  Read Only: true

  Maximum Length: 10

  The identifier of the status of the meeting.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 20

  The identifier of the type of application based on classification.
• Tzname: string
  Title: Time Zone

  Read Only: true

  Maximum Length: 64

  The identifier of the time zone.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"20",
            "type":"string",
            "description":"The identifier of the type of application based on classification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "type":"string",
            "description":"The user ID of the applicant as set up in the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingAgendaTextDisplay":{
            "title":"Meeting Agenda",
            "type":"string",
            "description":"The text of the meeting agenda.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Preapplication or Consultation Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional information about the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "MeetingStartFormatted":{
            "title":"Start Date and Time in Agency Format",
            "type":"string",
            "description":"The start date and time of the meeting shown in the agency date and  time format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingVenue":{
            "title":"Meeting Location",
            "maxLength":"2000",
            "type":"string",
            "description":"The identifier of the location of the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Applicant Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingEndDttm":{
            "title":"Meeting End Time",
            "type":"string",
            "description":"The unique identifier of the end date and time for the meeting.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EmailAddress2":{
            "title":"Applicant Secondary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The additional email of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingStartDttm":{
            "title":"Meeting Start Time",
            "type":"string",
            "description":"The unique identifier of the start date and time for the meeting.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MeetingAttendees":{
            "title":"Invitees",
            "maxLength":"4000",
            "type":"string",
            "description":"The list of additional attendees for the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssigneeId":{
            "title":"Planner or Specialist ID",
            "type":"integer",
            "description":"The unique identifier of the assigned planner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Record Type",
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of the Pre-Application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The additional address of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The unique identifier of the type of application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The record ID of the parent application for which the meeting is scheduled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Planner or Specialist Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the planner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Status":{
            "title":"Meeting Status",
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the status of the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Preapplication or Consultation ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the Pre-Application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Applicant Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The additional address of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContextRecordType":{
            "title":"Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the type of record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The additional address of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingEndFormatted":{
            "title":"End Date and Time in Agency Format",
            "type":"string",
            "description":"The end date and time of the meeting shown in the agency date and time format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Application ID",
            "type":"integer",
            "description":"The unique identifier of the Pre-Application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Planner or Specialist Email",
            "maxLength":"240",
            "type":"string",
            "description":"The email of the planner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Tzname":{
            "title":"Time Zone",
            "maxLength":"64",
            "type":"string",
            "description":"The identifier of the time zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingSubject":{
            "title":"Subject",
            "maxLength":"4000",
            "type":"string",
            "description":"The subject of the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationStatus":{
            "title":"Preapplication or Consultation Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannerUserId":{
            "title":"Planner or Specialist User ID",
            "type":"string",
            "description":"The user ID of the planner assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingId":{
            "title":"Meeting ID",
            "type":"integer",
            "description":"The unique identifier of the meeting.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedDatetime":{
            "type":"string",
            "description":"The identifier of the date and time when a planner was assigned to Pre-Application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country of the Pre-Application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "title":"Applicant ID",
            "type":"integer",
            "description":"The identifier of the applicant of the Pre-Application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MeetingDurationHours":{
            "title":"Meeting Duration in Hours",
            "type":"number",
            "description":"The unique identifier of the duration of the meeting.",
            "nullable":false,
            "readOnly":true,
            "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