1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Communications
  4. Permit Expiry Communications

Get all permit expiry communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the permit expiry communication data that matches the specified record key.
      Finder Variables:
      • LnpRecordKey; integer; The unique identifier for the record key.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AboutToExpireDate; string; The date when the notification about an expiring license or permit is sent.
    • AddressKey; integer; The parcel address key.
    • AgencyId; integer; The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
    • ApplAteDate; string; The date to indicate when the application is about to expire.
    • ApplExpirationDate; string; The date when the application expires.
    • Applicant; integer; The party identifier of the permit applicant.
    • ApplicantAddress1; string; The first line of the permit applicant address.
    • ApplicantAddress2; string; The second line of the permit applicant address.
    • ApplicantBizProfileId; integer; The business profile used by the applicant.
    • ApplicantCity; string; The city in the permit applicant address.
    • ApplicantCountry; string; The country in the permit applicant address.
    • ApplicantCounty; string; The county in the permit applicant address.
    • ApplicantEmailAddress1; string; The first email address of the permit applicant.
    • ApplicantEmailAddress2; string; The second email address of the permit applicant.
    • ApplicantPhoneAreaCode; string; The area code in the phone number of the permit applicant.
    • ApplicantPhoneCountryCode; string; The country code in the phone number of the permit applicant.
    • ApplicantPhoneExtension; string; The phone number extension of the permit applicant.
    • ApplicantPostalCode; string; The postal code in the permit applicant address.
    • ApplicantProfileId; integer; The user profile of the applicant.
    • ApplicantProvince; string; The province in the permit applicant address.
    • ApplicantState; string; The state in the permit applicant address.
    • BalanceDue; number; The application balance due amount.
    • Classification; string; The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The user who last updated the record.
    • DelinquentDate; string; The date the license becomes delinquent.
    • DistrictName; string; The type of the current parcel.
    • ExpirationDate; string; The date the license or permit is no longer valid.
    • ExpirationGraceDate; string; The application expiry grace date.
    • ExtensionsCount; integer; The application expiry extension count.
    • GracePeriod; integer; The grace period for the application expiry.
    • GracePeriodUom; string; The grace period unit for the application expiry.
    • InsCommenceAteDate; string; The date when the notification about an expiring license or permit is sent.
    • InsCommenceExpDate; string; The date the license or permit is no longer valid.
    • InsCommenceGraceDate; string; The application expiry grace date.
    • InsCommencementDateOption; string; The inspection commencement date option.
    • InsCommencementDuration; integer; The inspection commencement duration.
    • InsCommencementDurationUom; string; The inspection commencement unit for duration.
    • IssueDate; string; The date the license or permit was issued. Used in the application information component of the Permit Designer.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The date when the record was created.
    • LnpRecordId; string; The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.
    • LnpRecordKey; integer; The unique identifier for the record.
    • OrganizationName; string; The business name of the applicant. For example, a contractor enters his or her contracting business name.
    • Owner; string; The primary or only owner of the parcel or property.
    • OwnerEmailId; string; The parcel owner email address.
    • ParcelAddress1; string; The first line of the parcel or property address.
    • ParcelAddress2; string; The second line of the parcel or property address.
    • ParcelCity; string; The city in the parcel or property address.
    • ParcelCountry; string; The country in the parcel or property address.
    • ParcelCounty; string; The county in the parcel or property address.
    • ParcelId; integer; The identifier of the record parcel.
    • ParcelPostalCode; string; The postal code in the parcel or property address.
    • ParcelProvince; string; The province in the parcel or property address.
    • ParcelState; string; The state in the parcel or property address.
    • ParcelType; string; The key of the record parcel.
    • PermitDescription; string; The description of the permit type.
    • PermitStatus; string; The status of the permit record.
    • PersonName; string; The permit applicant name.
    • PrimaryContactEmail; string; The application primary contact email.
    • PrimaryContactName; string; The application primary contact name.
    • PrimaryContactPhone; string; The application primary contact phone.
    • ProjectKey; integer; The project name information for a permit.
    • PropertyDescription; string; The property description.
    • RecordStatus; string; The status of the record.
    • RecordType; string; The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.
    • ReissueDate; string; The date the license or permit was reissued. Used in the application information component of the Permit Designer.
    • RenewalDate; string; The renewal date for the license or permit.
    • SecondaryOwner; string; The secondary owner of the parcel or property.
    • Subclassification; string; The record subclassification.
    • SubmitDate; string; The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.
    • SubmittedBy; string; The user who submitted the application.
    • Url; string; The browser link for the business license application.
    • UrlLabel; string; The label for the URL.
    • Username; string; The user ID of the permit applicant.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorPermitExpiryCommunications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorPermitExpiryCommunications-item-response
Type: object
Show Source
Back to Top