1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. LOV
  4. List of Values
  5. Application Contact Types

Get all application contact details

get

/fscmRestApi/resources/11.13.18.05/publicSectorApplicationContactTypes

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 application contact type that matches the specified search criteria.
      Finder Variables:
      • ContactKey; integer; The unique identifier for the contact key.
      • ContactTypeName; string; The unique identifier for the contact type name.
      • 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:
    • 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.
    • ApplicationAccess; string; Indicates the application access for the contact person.
    • Classification; string; The record classification. The classifications can be permit, business license, or planning and zoning.
    • ContactAddress1; string; The first address line for the contact person.
    • ContactAddress2; string; The second address line for the contact person.
    • ContactAltPhone; string; The alternate phone number with country code for the contact person.
    • ContactAltPhoneAreaCode; string; The alternate phone area code for the contact person.
    • ContactAltPhoneCountryCode; string; The alternate phone country code for the contact person.
    • ContactAltPhoneNumber; string; The alternate phone number for the contact person.
    • ContactBizPartyId; integer; The contact list business party ID.
    • ContactBusinessName; string; The contact business name.
    • ContactCity; string; The city for the contact person's address.
    • ContactCountry; string; The country for the contact person.
    • ContactCounty; string; The county for the contact person's address.
    • ContactEmailAddress; string; The email address information for the contact person.
    • ContactFirstName; string; The contact first name.
    • ContactId; integer; The unique identifier of the contact.
    • ContactKey; integer; The unique identifier for the contact.
    • ContactLastName; string; The contact last name.
    • ContactMiddleName; string; The contact middle name.
    • ContactPartyId; integer; The contact list party ID.
    • ContactPhoneAreaCode; string; The phone area code for the contact person.
    • ContactPhoneCountryCode; string; The phone country code for the contact person.
    • ContactPhoneExtension; string; The phone extension for the contact person.
    • ContactPhoneNum; string; The phone number for the contact person.
    • ContactPhoneNumber; string; The phone number with country code for the contact person.
    • ContactPostalCode; string; The postal code for the contact person's address.
    • ContactState; string; The state for the contact person's address.
    • ContactTypeName; string; The contact type name.
    • ContactUserId; string; The contact user ID.
    • ContactUserName; string; The contact user name.
    • 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.
    • PrimaryFlag; string; Indicates the primary contact in the contact details.
    • RecordType; string; The record type. Agencies define the types of permits that they administer, for example, Residential Addition.
    • RecordTypeId; string; The unique identifier for the record type.
    • Subclassification; string; The subclassification of the type of application.
  • 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 : publicSectorApplicationContactTypes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorApplicationContactTypes-item-response
Type: object
Show Source
Back to Top