1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Permits
  4. Records
  5. RecordAuthorizedAgents

Get all records of authorized agents

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/RecordAuthorizedAgent

Request

Path Parameters
  • The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
Query Parameters
  • 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>
  • 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:

    • LnpAuthorizedAgntPuidKey: Finds an authorized agent using the public unique identifier key criteria.
      Finder Variables:
      • LnpAuthorizedAgntPuid; string; The unique identifier of an authorized agent that is used during the CRM import process.
    • PrimaryKey: Finds a authorized agent using the primary key criteria.
      Finder Variables:
      • LnpAuthorizedAgntKey; integer; The unique identifier of a authorized agent.
  • 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:
    • Address1; string; The first address line of contact address.
    • Address2; string; The second address line of contact address.
    • Address3; string; The third address line of contact address.
    • Address4; string; The fourth address line of contact address.
    • AgentAddressId; integer; The reference key to the TCA location table.
    • AgentSource; string; The source of the agent.
    • ApplicantIsAuthAgentFlag; string; Indicates whether an applicant is the authorized agent.
    • AssociateDate; string; The date associated with the Contractor License.
    • AuthorizeStatus; string; The status of the agent associated with the contractor license.
    • BePersonId; string; The identifier of a responsible person for the business.
    • BePersonKey; integer; The unique identifier of a responsible person for the business.
    • BusinessEntityId; string; The meaningful identifier for the business location.
    • BusinessEntityKey; integer; The unique identifier for the business entity.
    • BusinessLocationId; string; The identifier for the business location.
    • BusinessLocationKey; integer; The unique identifier for the business location.
    • City; string; The name of city for the contact address.
    • ContactBizPartyId; integer; The party identifier associated with the applicant.
    • ContactBizProfileId; integer; The business profile identifier associated with the applicant.
    • ContactDmvLicExp; string; The responsible person???s driver???s license expiration date.
    • ContactDmvLicNum; string; The responsible person???s driver???s license number.
    • ContactDmvLicSt; string; The responsible person???s driver???s license issued state.
    • ContactId; integer; The contact identifier associated with the applicant.
    • ContactPartyId; integer; The party identifier associated with the applicant.
    • ContactProfileId; integer; The profile identifier associated with the applicant.
    • ContactType; string; The contact type of the person who is associated with the license.
    • Country; string; The name of the country for the contact address.
    • County; string; This field indicates the name of the county for the contact address.
    • CreationDate; string; The date and time of the creation of the row.
    • DateOfBirth; string; The responsible person???s date of birth.
    • DisassociateDate; string; The disassociated date from the contractor license.
    • EmailAddress; string; The email address of the person associated with the contractor license.
    • EmergContactPhone; string; The person???s emergency contact phone number.
    • EmergencyContactFlag; boolean; Indicates whether an emergency contact phone number exists.
    • JobTitle; string; The person???s job title associated with the contact.
    • LastUpdateDate; string; The user who last updated the record.
    • LnpAuthorizedAgntKey; integer; The system generated number used uniquely to identify the license.
    • LnpAuthorizedAgntPuid; string; The public unique identifier for authorized agent, which is an alternate key used by the CRM Import process.
    • LnpLicenseKey; integer; The agency staff that verified the responsible person.
    • LnpRecordId; string; The meaningful transaction identifier.
    • LnpRecordKey; integer; The unique identifier of the license.
    • ObjectVersionNumber; integer; The system attribute that captures the incremental version number for an object.
    • OrganizationName; string; The organization of a person associated with the contractor license.
    • PartyId; integer; The party identifier associated with the applicant.
    • PersonFirstName; string; The first name of a person associated with the contractor license.
    • PersonLastName; string; The last name of a person associated with the contractor license.
    • PersonLengthAtAddress; integer; The length of time the person has been at the address.
    • PersonMiddleName; string; The middle name of a person associated with the contractor license.
    • PersonName; string; The full concatenated name including first, middle, last, and suffix names.
    • PersonNameSuffix; string; The suffix associated with the person's name.
    • PersonPreNameAdjunct; string; The salutation for the responsible person.
    • PhoneAreaCode; string; The area code of the phone number associated with contact.
    • PhoneCountryCode; string; The phone country code associated with phone number.
    • PhoneExtension; string; The phone extension associated with the phone number.
    • PhoneNumber; string; The phone number of the authorized agent.
    • PhoneType; string; The type of phone for the responsible person.
    • PostalCode; string; The postal code of the contact address.
    • PostalPlus4Code; string; The extended postal code of the agent.
    • PrimaryFlag; boolean; The preferred contact for the contractor.
    • Province; string; The province name for the contact address.
    • RawPhoneNumber; string; The responsible person???s full phone number.
    • RecordNumber; string; The public unique identifier for the permit record that is used by the CRM Import process.
    • SourceAgentKey; integer; The system generated number used uniquely to identify the agent.
    • SourceKey; integer; The unique identifier of the source transaction.
    • State; string; The state name of the contact address.
    • Status; string; The status of the responsible person for the business.
    • SubjectId; string; The attribute used to identify where the data should be displayed.
    • VerificationDate; string; The date the responsible person was verified.
    • VerificationStatus; string; The verification status for the responsible person.
    • VerifiedBy; string; The agency staff that verified the responsible person.
  • 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 : publicSectorRecords-RecordAuthorizedAgent
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorRecords-RecordAuthorizedAgent-item-response
Type: object
Show Source
Back to Top