Get all transactions
get
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionLists
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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:- ActiveList: Finds all active transactions.
Finder Variables:- bParcelIdEntered; string; Identifier for the transaction belonging to the same parcel.
- AllListFinder: Finds all transactions in the system.
Finder Variables:- bParcelIdEntered; string; Identifier for the transaction belonging to the same parcel.
- PrimaryKey: Finds the transaction that matches the primary key criteria.
Finder Variables:- LnpRecordKey; integer; The unique identifier of the transaction.
- SimpleSearchAllFinder: Finds all active transactions.
Finder Variables:- bParcelIdEntered; string; Identifier for the transaction belonging to the same parcel.
- value; string; Finds transactions that match the primary search value.
- SimpleSearchFinder: Finds transactions that match the primary search criteria.
Finder Variables:- bParcelIdEntered; string; Identifier for the transaction belonging to the same parcel.
- value; string; Finds transactions that match the primary search value.
- ActiveList: Finds all active transactions.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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 about to expire date for the application.
- Address1; string; The first or main address.
- Address2; string; The second address, if present.
- Address3; string; The third address, if present.
- Address4; string; The fourth address, if present.
- Applicant; integer; The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
- City; string; The city in the parcel address.
- ClassDesc; string; The classification description of the transaction like permit, planning and zoning, or business license.
- Classification; string; The classification of the transaction like ORA_PMT, ORA_PZ, and ORA_LIC.
- CreatedByName; string; The person who created the application.
- CreationDate; string; The creation date of the application.
- Description; string; The transaction description.
- ExpirationDate; string; The date when the application expires.
- IssueDate; string; The date when the application was issued.
- LnpRecordId; string; The unique identifier for an application transaction. This identifier is automatically generated based on the rules configured for the record type.
- LnpRecordKey; integer; The unique identifier for a transaction. The transaction is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
- ParcelIdEntered; string; The parcel ID of the application.
- PersonName; string; The applicant's name in the application.
- PrimaryContact; string; The primary contact for the application.
- PrimaryFlag; string; The record is the primary application of the current application.
- PrimaryRecordId; string; The record identifier of the primary application.
- PrimaryRecordKey; integer; The record key of the primary application.
- ReceivedDate; string; The date on which the application was received by the agency.
- RecordNumber; string; The public unique identifier of the migrated record.
- RecordType; string; The user-friendly name for the record type.
- RecordTypeCode; string; The unique alphanumeric code or short name for the record type.
- RecordTypeId; string; The unique identifier for a record type.
- ReissueDate; string; The date on which the application was reissued.
- State; string; The state in the parcel address.
- Status; string; The status of the transaction.
- SubClassDesc; string; The subclassification description of the transaction like Pre-application, Consultation, or none.
- SubapplicationFlag; string; The record is the subapplication of the current application.
- Subclassification; string; The subclassification of the transaction like ORA_PREAPP, ORA_CON, and ORA_NA.
- SubmitDate; string; The date when the record was submitted.
- SystemStatus; string; The predefined system status to which the record status maps.
- VersionType; string; The version of the permit. Values are original, amendment, and renewal.
- VersionTypeDesc; string; The description for the version type.
-
totalResults: boolean
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
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : publicSectorTransactionLists
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorTransactionLists-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Read Only:
true
The about to expire date for the application. -
Address1: string
Read Only:
true
Maximum Length:240
The first or main address. -
Address2: string
Read Only:
true
Maximum Length:240
The second address, if present. -
Address3: string
Read Only:
true
Maximum Length:240
The third address, if present. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth address, if present. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit. -
City: string
Read Only:
true
Maximum Length:60
The city in the parcel address. -
ClassDesc: string
Read Only:
true
Maximum Length:80
The classification description of the transaction like permit, planning and zoning, or business license. -
Classification: string
Read Only:
true
Maximum Length:3
The classification of the transaction like ORA_PMT, ORA_PZ, and ORA_LIC. -
CreatedByName: string
Read Only:
true
Maximum Length:240
The person who created the application. -
CreationDate: string
(date-time)
Read Only:
true
The creation date of the application. -
Description: string
Read Only:
true
Maximum Length:1000
The transaction description. -
ExpirationDate: string
(date-time)
Read Only:
true
The date when the application expires. -
IssueDate: string
(date-time)
Read Only:
true
The date when the application was issued. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier for an application transaction. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier for a transaction. The transaction is for a permit, business license, professional license, or planning and zoning, and is determined by the classification. -
ParcelIdEntered: string
Read Only:
true
Maximum Length:30
The parcel ID of the application. -
PersonName: string
Read Only:
true
Maximum Length:450
The applicant's name in the application. -
PrimaryContact: string
Read Only:
true
Maximum Length:450
The primary contact for the application. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
The record is the primary application of the current application. -
PrimaryRecordId: string
Read Only:
true
Maximum Length:50
The record identifier of the primary application. -
PrimaryRecordKey: integer
(int64)
Read Only:
true
The record key of the primary application. -
ReceivedDate: string
(date-time)
Read Only:
true
The date on which the application was received by the agency. -
RecordNumber: string
Read Only:
true
Maximum Length:64
The public unique identifier of the migrated record. -
RecordType: string
Read Only:
true
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeCode: string
Read Only:
true
Maximum Length:20
The unique alphanumeric code or short name for the record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The unique identifier for a record type. -
ReissueDate: string
(date-time)
Read Only:
true
The date on which the application was reissued. -
State: string
Read Only:
true
Maximum Length:60
The state in the parcel address. -
Status: string
Read Only:
true
Maximum Length:15
The status of the transaction. -
SubapplicationFlag: string
Read Only:
true
Maximum Length:1
The record is the subapplication of the current application. -
SubClassDesc: string
Read Only:
true
Maximum Length:80
The subclassification description of the transaction like Pre-application, Consultation, or none. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification of the transaction like ORA_PREAPP, ORA_CON, and ORA_NA. -
SubmitDate: string
(date-time)
Read Only:
true
The date when the record was submitted. -
SystemStatus: string
Read Only:
true
Maximum Length:15
The predefined system status to which the record status maps. -
VersionType: string
Read Only:
true
Maximum Length:1
The version of the permit. Values are original, amendment, and renewal. -
VersionTypeDesc: string
Read Only:
true
Maximum Length:80
The description for the version type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.