Get a department payment option
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsDepartments/{publicSectorPaymentOptionsDepartmentsUniqID}
Request
Path Parameters
-
publicSectorPaymentOptionsDepartmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, DepartmentId and PaymentMethodCode ---for the Department Payment Options resource and used to uniquely identify an instance of Department Payment Options. The client should not generate the hash key value. Instead, the client should query on the Department Payment Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Department Payment Options.
For example: publicSectorPaymentOptionsDepartments?q=AgencyId=<value1>;DepartmentId=<value2>;PaymentMethodCode=<value3>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorPaymentOptionsDepartments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
-
CashierSessionAtnRule: string
Title:
Cashier Session Number Rule
Maximum Length:20
The autonumbering rule used to generate cashier session numbers. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the department payment option. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the department payment option was created. -
DepartmentId: string
Maximum Length:
30
The unique identifier of the division within the agency devoted to a specific function. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the department payment option was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the department payment option. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
A number used to implement optimized locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PaymentAdapterId: string
Title:
Payment Adapter ID
Maximum Length:100
The unique identifier of the payment adapter associated with the department. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The method of payment. Possible values are Cash or Check. -
PaymentReferencePrefix: string
Title:
Payment Reference Prefix
Maximum Length:4
Prefix used by the Payment Engine during the creation of the payment reference value that is sent as pass through data to the payment processor, trust account, and cash drawer. -
ReceiptAtnRule: string
Title:
Cash Receipts Number Rule
Maximum Length:20
The autonumbering rule used to generate receipt numbers.
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.