Get all payment cart items
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems
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:- 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 match the specific search criteria.
Finder Variables:- value; string; Finds the cart items that match the specific value.
- PrimaryKey: Finds a payment cart item using the primary keys.
-
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:- Address1; string; The first line of the address in the application.
- Address2; string; The second line of the address in the application, if present.
- Address3; string; The third line of the address in the application, if present.
- Address4; string; The fourth line of the address in the application, if present.
- AgencyId; integer; The unique identifier for the public sector agency.
- Amount; string; The total fee amount for the cart item.
- Applicant; integer; The user identification number of the applicant who submitted the application.
- ApplicantName; string; The name of the applicant who submitted the application.
- BusDbaBusinessName; string; Business name registered as a doing business as, or DBA name, with an agency.
- CartAmount; number; The initial amount due when an item is added to the payment cart.
- CartId; integer; The unique identifier for the current payment cart.
- CartItemType; string; The record type of the cart item, such as a permit, business license, professional license, or planning and zoning.
- CartOwner; integer; The identifier for the user profile associated with the payment cart.
- CartStatus; string; The status of the item in the payment cart.
- City; string; The city in the application address.
- Country; string; The country in the application address.
- County; string; The county in the application address.
- CurrencyCode; string; The currency code of the payment.
- Description; string; The details related to the cart item.
- Originator; string; The user who submitted the record.
- PaymentInProcess; number; The amount stuck in the payment in processing status.
- PhoneNumber; string; The phone number of the applicant who submitted the application.
- PostalCode; string; The postal code in the application address.
- PostalPlus4Code; string; The extended postal code in the application address.
- PrimaryContact; string; The name of the primary contact as mentioned in the application.
- ProjectKey; integer; The unique identifier for the project associated with the application.
- Province; string; The province in the application address.
- RecordId; string; The unique identifier for the record.
- RecordKey; integer; The unique identifier of the record, such as the key for a permit.
- RecordType; string; The record type of the application.
- RecordTypeId; string; The unique identifier for the record type of the application.
- State; string; The state in the application address.
- TotalDueCount; number; The total count of the fee items associated with the application that are due.
-
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:
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.
Root Schema : publicSectorPaymentCartItems
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 : publicSectorPaymentCartItems-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
Maximum Length:240
The first line of the address in the application. -
Address2: string
Read Only:
true
Maximum Length:240
The second line of the address in the application, if present. -
Address3: string
Read Only:
true
Maximum Length:240
The third line of the address in the application, if present. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth line of the address in the application, if present. -
AgencyId: integer
(int32)
Read Only:
true
The unique identifier for the public sector agency. -
Amount: string
Read Only:
true
The total fee amount for the cart item. -
Applicant: integer
(int64)
Read Only:
true
The user identification number of the applicant who submitted the application. -
ApplicantName: string
Read Only:
true
Maximum Length:450
The name of the applicant who submitted the application. -
AssociatedProject: array
Associated Projects
Title:
Associated Projects
The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart. -
BusDbaBusinessName: string
Read Only:
true
Maximum Length:100
Business name registered as a doing business as, or DBA name, with an agency. -
CartAmount: number
Read Only:
true
The initial amount due when an item is added to the payment cart. -
CartId: integer
(int64)
Read Only:
true
The unique identifier for the current payment cart. -
CartItemType: string
Read Only:
true
Maximum Length:3
The record type of the cart item, such as a permit, business license, professional license, or planning and zoning. -
CartOwner: integer
(int64)
Read Only:
true
The identifier for the user profile associated with the payment cart. -
CartStatus: string
Read Only:
true
Maximum Length:10
The status of the item in the payment cart. -
City: string
Read Only:
true
Maximum Length:60
The city in the application address. -
Country: string
Read Only:
true
Maximum Length:60
The country in the application address. -
County: string
Read Only:
true
Maximum Length:60
The county in the application address. -
CurrencyCode: string
Read Only:
true
Maximum Length:3
The currency code of the payment. -
Description: string
Read Only:
true
Maximum Length:1000
The details related to the cart item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Originator: string
Read Only:
true
Maximum Length:3
The user who submitted the record. -
PaymentInProcess: number
Read Only:
true
The amount stuck in the payment in processing status. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The phone number of the applicant who submitted the application. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code in the application address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:20
The extended postal code in the application address. -
PrimaryContact: string
Read Only:
true
Maximum Length:450
The name of the primary contact as mentioned in the application. -
ProjectKey: integer
(int64)
Read Only:
true
The unique identifier for the project associated with the application. -
Province: string
Read Only:
true
Maximum Length:60
The province in the application address. -
RecordId: string
Read Only:
true
Maximum Length:50
The unique identifier for the record. -
RecordKey: integer
(int64)
Read Only:
true
The unique identifier of the record, such as the key for a permit. -
RecordType: string
Read Only:
true
Maximum Length:100
The record type of the application. -
RecordTypeId: string
Read Only:
true
Maximum Length:100
The unique identifier for the record type of the application. -
State: string
Read Only:
true
Maximum Length:60
The state in the application address. -
TotalDueCount: number
Read Only:
true
The total count of the fee items associated with the application that are due.
Nested Schema : Associated Projects
Type:
array
Title:
Associated Projects
The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPaymentCartItems-AssociatedProject-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectCode: string
Read Only:
true
Maximum Length:30
The unique identifier for a project. -
ProjectName: string
Read Only:
true
Maximum Length:50
The user-friendly name for a project. -
RecordKey: integer
(int64)
Read Only:
true
The unique identifier of the record, such as the key for a permit.
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.