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

Get all case contacts

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts

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:

    • CaseContactPUIDKey: Finds the case contact that matches the specified alternate key.
      Finder Variables:
      • CaseContactPuid; string; The public unique identifier of the migrated case contact record.
    • PrimaryKey: Finds the case contact that matches the specified search criteria.
      Finder Variables:
      • CaseContactKey; integer; The unique identifier of the case contact.
    • findByContactType: Finds the case contact that matches the specified contact type.
      Finder Variables:
      • caseKey; integer; The unique identifier of the case.
      • inputContactType; string; The type of the case contact.
    • findUnmappedOwner: Finds the case owner not associated with a claimant.
      Finder Variables:
      • caseKey; integer; The unique identifier of the case.
    • simpleSearchFinder: Finds the case contact that matches the specified search criteria.
      Finder Variables:
      • value; string; Finds the case contact that matches the specified value.
  • 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:
    • AccessApprovedBy; string; The username of the user who approved the case access request.
    • AccessApprovedByUser; string; The name of the user who approved the case access request.
    • AccessApprovedDate; string; The approved date for the case access request.
    • AccessComments; string; The access comments provided by the case contact.
    • AccessStatus; string; The access status of the case contact.
    • Address1; string; The first line for the address of the case contact.
    • Address2; string; The second line for the address of the case contact.
    • Address3; string; The third line for the address of the case contact.
    • Address4; string; The fourth line for the address of the case contact.
    • AgencyComments; string; The comments by the agency staff.
    • BusinessName; string; The business name of the case contact.
    • CaseContactKey; integer; The unique identifier of the case contact.
    • CaseContactPuid; string; The public unique identifier of the migrated case contact record.
    • CaseKey; integer; The unique identifier of the case.
    • CasePuid; string; The public unique identifier of the migrated case record.
    • City; string; The city of the case contact.
    • ClaimantContactType; string; The meaning of the contact type code.
    • ClaimantUserName; string; The username of the case claimant.
    • ContactAccessStatus; string; The meaning of the access status code.
    • ContactFullname; string; The full name of the responsible party.
    • ContactPartyId; integer; The party ID of the case contact.
    • ContactPartyPuid; string; The public unique identifier of the migrated contact party record.
    • ContactType; string; The type of contact for the case.
    • Country; string; The country of the case contact.
    • County; string; The county of the case contact.
    • CreatedBy; string; The name of the user who created the row.
    • CreationDate; string; The date and time when the row was created.
    • EmailAddress; string; The email address of the case contact.
    • LastUpdateDate; string; The date and time when the row was last updated.
    • LastUpdatedBy; string; The name of the user who last updated the row.
    • LastUpdatedByUser; string; The name of the user who last updated the row.
    • LegacyApproverName; string; The name of the legacy system approver for the migrated data.
    • 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.
    • PhoneAreaCode; string; The phone area code of the responsible party.
    • PhoneCountryCode; string; The phone country code of the responsible party.
    • PhoneExtension; string; The phone extension code of the responsible party.
    • PhoneNumber; string; The phone number of the case contact.
    • PostalCode; string; The postal code of the case contact.
    • PostalPlusCode; string; The postal plus code of the case contact.
    • PrimaryFlag; boolean; Indicates if the contact is the primary case contact.
    • Province; string; The province of case contact.
    • State; string; The state of the case contact.
    • Status; string; Indicates the status of the responsible party. Values can be Active or Inactive.
    • UserEmail; string; The email of the responsible party.
    • UserFirstName; string; The first name of the case claimant.
    • UserLastName; string; The last name of the case claimant.
    • UserPhoneAreaCode; string; The phone area code of the responsible party.
    • UserPhoneCountryCode; string; The phone country code of the responsible party.
    • UserPhoneExtension; string; The phone extension of the responsible party requesting access.
    • UserPhoneNumber; string; The phone number of the responsible party requesting access.
  • 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 : publicSectorCaseContacts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorCaseContacts-item-response
Type: object
Show Source
Back to Top