Get a payment cart item
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}
Request
Path Parameters
-
publicSectorPaymentCartsUniqID: integer
This is the hash key of the attributes which make up the composite key--- CartOwner, CartId and AgencyId ---for the Payment Carts resource and used to uniquely identify an instance of Payment Carts. The client should not generate the hash key value. Instead, the client should query on the Payment Carts collection resource with a filter on the primary key values in order to navigate to a specific instance of Payment Carts.
For example: publicSectorPaymentCarts?q=CartOwner=<value1>;CartId=<value2>;AgencyId=<value3>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPaymentCarts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier for the public sector agency.
-
Amount(optional):
number
Title:
Amount
The total fees for the permit. -
Applicant(optional):
integer(int64)
The user who submitted the permit application.
-
ApplicantName(optional):
string
Maximum Length:
450
The name of the permit applicant. -
AssociatedProject(optional):
array Associated Projects
Title:
Associated Projects
The payment carts resource is used by public users to manage fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed. -
CartId(optional):
integer(int64)
The unique identifier for the current payment cart.
-
CartItemType(optional):
string
Maximum Length:
3
The record type of the cart item, such as a permit, business license, professional license, or planning and zoning record. -
CartOwner(optional):
integer(int64)
The identifier for user profile associated with the payment cart.
-
CartStatus(optional):
string
Maximum Length:
10
The status of the payment cart item. -
CreatedBy(optional):
string
Maximum Length:
64
The user who added the item to the payment cart. -
CreationDate(optional):
string(date-time)
The date when the item was added to the payment cart.
-
CurrencyCode(optional):
string
Maximum Length:
3
The payment currency code. -
LastUpdateDate(optional):
string(date-time)
The date when the payment cart item was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the payment cart item. -
links(optional):
array Items
Title:
Items
Link Relations -
Originator(optional):
string
Maximum Length:
3
The user who submitted the permit. -
RecordId(optional):
string
Title:
Record ID
Maximum Length:50
The record identifier for the permit. -
RecordKey(optional):
integer(int64)
The unique identifier for the record key, such as the key for a permit.
Nested Schema : Associated Projects
Type:
array
Title:
Associated Projects
The payment carts resource is used by public users to manage fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed.
Show Source
Nested Schema : publicSectorPaymentCarts-AssociatedProject-item
Type:
Show Source
object
-
links(optional):
array Items
Title:
Items
Link Relations -
ProjectCode(optional):
string
Maximum Length:
30
The unique identifier for a project. -
ProjectName(optional):
string
Maximum Length:
50
The user-friendly name for a project. -
RecordKey(optional):
integer(int64)
The unique identifier for the record key, such as the key for a permit.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.