Jump to

• Request
• Response

Update a department payment option

patch

/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>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CashierSessionAtnRule: string
  Title: Cashier Session Number Rule

  Maximum Length: 20

  The autonumbering rule used to generate cashier session numbers.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "PaymentAdapterId":{
            "title":"Payment Adapter ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the department.",
            "nullable":true
        },
        "ReceiptAtnRule":{
            "title":"Cash Receipts Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate receipt numbers.",
            "nullable":true
        },
        "PaymentReferencePrefix":{
            "title":"Payment Reference Prefix",
            "maxLength":"4",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "CashierSessionAtnRule":{
            "title":"Cashier Session Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate cashier session numbers.",
            "nullable":true
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : publicSectorPaymentOptionsDepartments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the department payment option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the department payment option was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptAtnRule":{
            "title":"Cash Receipts Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate receipt numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the department payment option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CashierSessionAtnRule":{
            "title":"Cashier Session Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate cashier session numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferencePrefix":{
            "title":"Payment Reference Prefix",
            "maxLength":"4",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":"30",
            "type":"string",
            "description":"The method of payment. Possible values are Cash or Check.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PaymentAdapterId":{
            "title":"Payment Adapter ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the department.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepartmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the division within the agency devoted to a specific function.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the department payment option was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top