1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Code Enforcement
  4. List Case Access Requests

Get all case access requests

get

/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAccessRequests

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:

    • JobAttributeFilterFinder: Finds the case access request that matches the specified search criteria based on the job attributes of the logged in person.
      Finder Variables:
      • jobFunction; string; Finds the case access request that matches the specified job function of the user.
      • personLoggedIn; integer; Finds the case access request that matches the specified identifier of the logged in person.
    • MyAccessRequestsFinder: Finds the case access request that matches the specified search criteria.
      Finder Variables:
      • pReviewerId; integer; The unique identifier of the code technician.
      • searchValue; string; Finds the case access request that matches the specified search value.
    • PrimaryKey: Finds the case access request that matches the specified search criteria.
      Finder Variables:
      • CaseContactKey; integer; The unique identifier of the case contact.
    • simpleSearchFinder: Finds the case access request that matches the specified search criteria.
      Finder Variables:
      • searchValue; string; Finds the case access request that matches the specified search value.
    • simpleSearchJobAttributeFilterFinder: Finds the case access request that matches the specified search criteria and the job attributes of the logged in person.
      Finder Variables:
      • jobFunction; string; Finds the case access request that matches the specified search value and the job function.
      • personLoggedIn; integer; Finds the case access request that matches the specified search value and the identifier of the logged in person.
      • searchValue; string; Finds the case access request that matches the specified search value and the job attributes of the logged in person.
  • 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:
    • AccessComments; string; The access comments provided by the case contact.
    • AccessStatus; string; The access status of the case contact.
    • Address1; string; The second line for the address of the case contact.
    • Address2; string; The third line for the address of the case contact.
    • Address3; string; The fourth line for the address of the case contact.
    • Address4; string; The city of the case contact.
    • AgencyId; integer; The unique identifier of the agency of the case.
    • AssignedCodeOfficerName; string; The name of the code officer assigned to the case.
    • AssignedCodeTechnicianName; string; The name of the code technician assigned to the case.
    • AssignedId; string; The unique identifier of the code officer assigned to the case.
    • CaseContactKey; integer; The unique identifier of the case contact.
    • CaseId; string; The identifier of the case.
    • CaseKey; integer; The unique identifier of the case.
    • City; string; The state of the case contact.
    • ClaimantUserName; string; The username of the case claimant.
    • ContactPartyId; integer; The party identifier of the case contact.
    • ContactType; string; The type of contact for the case.
    • ContactTypeName; string; The contact type of the responsible party.
    • Country; string; The county of the case contact.
    • County; string; The postal code of the case contact.
    • CreationDate; string; The date and time when the row was last updated.
    • EmailAddress; string; The email address of the case contact.
    • IssueDescription; string; The description of the issue.
    • IssueSubtype; string; The name of the issue subtype associated with the case.
    • IssueSubtypeId; string; The unique identifier of the issue subtype of the case.
    • IssueType; string; The name of the issue type associated with the case.
    • IssueTypeId; string; The unique identifier of the issue type of the case.
    • LastUpdateDate; string; The date and time when the row was last updated.
    • OwnerMapped; boolean; Indicates if the owner of the case is associated to a claimant.
    • PersonFirstName; string; The first name of case contact.
    • PersonLastName; string; The last name of case contact.
    • PersonMiddleName; string; The middle name of case contact.
    • PersonNameSuffix; string; The suffix for the case contact.
    • PersonTitle; string; The title of the case contact name.
    • PhoneNumber; string; The phone number of the case contact.
    • PostalCode; string; The postal plus code of the case contact.
    • PostalPlusCode; string; The date and time when the row was created.
    • PropertyAddress1; string; The first line of the property address of the case.
    • PropertyAddress2; string; The second line of the property address of the case.
    • PropertyAddress3; string; The third line of the property address of the case.
    • PropertyAddress4; string; The fourth line of the property address of the case.
    • PropertyCity; string; The city of the property address of the case.
    • PropertyCountry; string; The country of the property address of the case.
    • PropertyCounty; string; The county of the property address of the case.
    • PropertyPostalCode; string; The postal code of the property address of the case.
    • PropertyPostalPlusCode; string; The postal plus code of the property address of the case.
    • PropertyProvince; string; The province of the property address of the case.
    • PropertyState; string; The state of the property address of the case.
    • Province; string; The country of the case contact.
    • ResponsiblePartyDisplayName; string; The first line for the address of the case contact.
    • ResponsiblePartyFirstName; string; The first name of the case owner.
    • ResponsiblePartyLastName; string; The last name of the case owner.
    • ReviewerId; integer; The unique identifier of the code technician assigned to the case.
    • State; string; The province of case contact.
    • Status; string; The status of the case.
    • UserDisplayName; string; The display name of the user requesting access to the case.
    • UserFirstName; string; The first name of the case claimant.
    • UserLastName; string; The last name of the case claimant.
  • 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 : publicSectorListCaseAccessRequests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorListCaseAccessRequests-item-response
Type: object
Show Source
Back to Top