Update an item in the payment cart
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts/{publicSectorPaymentCartsUniqID}
Request
Path Parameters
-
publicSectorPaymentCartsUniqID(required): string
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>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Amount: number
Title:
Amount
The total fees for the permit. -
ApplicantName: string
Maximum Length:
450
The name of the permit applicant. -
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. -
CartStatus: string
Maximum Length:
10
The status of the payment cart item. -
CurrencyCode: string
Maximum Length:
3
The payment currency code. -
Originator: string
Maximum Length:
3
The user who submitted the permit.
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 : publicSectorPaymentCarts-AssociatedProject-item-patch-request
Type:
Show Source
object
Response
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 : publicSectorPaymentCarts-item-response
Type:
Show Source
object
-
AddedToCartOn: string
(date-time)
Read Only:
true
The date when the item was added to the payment cart. -
AgencyId: integer
(int32)
The identifier for the public sector agency.
-
Amount: number
Title:
Amount
The total fees for the permit. -
Applicant: integer
(int64)
The user who submitted the permit application.
-
ApplicantName: string
Maximum Length:
450
The name of the permit applicant. -
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. -
CartId: integer
(int64)
The unique identifier for the current payment cart.
-
CartItemType: 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: integer
(int64)
The identifier for user profile associated with the payment cart.
-
CartStatus: string
Maximum Length:
10
The status of the payment cart item. -
CurrencyCode: string
Maximum Length:
3
The payment currency code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Originator: string
Maximum Length:
3
The user who submitted the permit. -
RecordId: string
Title:
Record ID
Maximum Length:50
The record identifier for the permit. -
RecordKey: 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 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 : publicSectorPaymentCarts-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 for the record key, 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.
Links
- AssociatedProject
-
Parameters:
- publicSectorPaymentCartsUniqID:
$request.path.publicSectorPaymentCartsUniqID
The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart. - publicSectorPaymentCartsUniqID: