Get all payment cart items
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:- RowFinder: Finds the cart items that matches the specific search criteria. Finder Variables:
- bValue; string; Finds the cart items that matches the specific bValue.
- PrimaryKey: Finds a payment cart item using the primary keys. Finder Variables:
- CartId; integer; The unique identifier of the current payment cart item.
- RowFinder: Finds the cart items that matches the specific search criteria. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPaymentCartItems
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates 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(optional):
array Items
Title:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPaymentCartItems-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240The first line of the address in the application. -
Address2(optional):
string
Maximum Length:
240The second line of the address in the application, if present. -
Address3(optional):
string
Maximum Length:
240The third line of the address in the application, if present. -
Address4(optional):
string
Maximum Length:
240The fourth line of the address in the application, if present. -
AgencyId(optional):
integer(int32)
The unique identifier for the public sector agency.
-
Amount(optional):
number
The total fee amount for the cart item.
-
Applicant(optional):
integer(int64)
The user identification number of the applicant who submitted the application.
-
ApplicantName(optional):
string
Maximum Length:
450The name of the applicant who submitted the application. -
AssociatedProject(optional):
array Associated Projects
Title:
Associated ProjectsThe associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart. -
CartAmount(optional):
number
The initial amount due when an item is added to the payment cart.
-
CartId(optional):
integer(int64)
The unique identifier for the current payment cart.
-
CartItemType(optional):
string
Maximum Length:
3The record type of the cart item, such as a permit, business license, professional license, or planning and zoning. -
CartOwner(optional):
integer(int64)
The identifier for the user profile associated with the payment cart.
-
CartStatus(optional):
string
Maximum Length:
10The status of the item in the payment cart. -
City(optional):
string
Maximum Length:
60The city in the application address. -
Country(optional):
string
Maximum Length:
60The country in the application address. -
County(optional):
string
Maximum Length:
60The county in the application address. -
CurrencyCode(optional):
string
Maximum Length:
3The currency code of the payment. -
Description(optional):
string
Maximum Length:
1000The details related to the cart item. -
links(optional):
array Items
Title:
ItemsLink Relations -
Originator(optional):
string
Maximum Length:
3The user who submitted the record. -
PaymentInProcess(optional):
number
The amount stuck in the payment in processing status.
-
PhoneNumber(optional):
string
Maximum Length:
40The phone number of the applicant who submitted the application. -
PostalCode(optional):
string
Maximum Length:
60The postal code in the application address. -
PostalPlus4Code(optional):
string
Maximum Length:
20The extended postal code in the application address. -
ProjectKey(optional):
integer(int64)
The unique identifier for the project associated with the application.
-
Province(optional):
string
Maximum Length:
60The province in the application address. -
RecordId(optional):
string
Maximum Length:
50The unique identifier for the record. -
RecordKey(optional):
integer(int64)
The unique identifier of the record, such as the key for a permit.
-
RecordType(optional):
string
Maximum Length:
100The record type of the application. -
RecordTypeId(optional):
string
Maximum Length:
100The unique identifier for the record type of the application. -
State(optional):
string
Maximum Length:
60The state in the application address. -
TotalDueCount(optional):
number
The total count of the fee items associated with the application that are due.
Nested Schema : Associated Projects
Type:
arrayTitle:
Associated ProjectsThe associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.
Show Source
Nested Schema : publicSectorPaymentCartItems-AssociatedProject-item
Type:
Show Source
object-
links(optional):
array Items
Title:
ItemsLink Relations -
ProjectCode(optional):
string
Maximum Length:
30The unique identifier for a project. -
ProjectName(optional):
string
Maximum Length:
50The user-friendly name for a project. -
RecordKey(optional):
integer(int64)
The unique identifier of the record, such as the key for a permit.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.