Jump to

• Request
• Response

Update a payment adapter configuration

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs/{publicSectorAdapterConfigsUniqID}

Request

Path Parameters

• publicSectorAdapterConfigsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AdapterId, ConfigurationId and AgencyId ---for the Adapter Configs resource and used to uniquely identify an instance of Adapter Configs. The client should not generate the hash key value. Instead, the client should query on the Adapter Configs collection resource with a filter on the primary key values in order to navigate to a specific instance of Adapter Configs.
  
  For example: publicSectorAdapterConfigs?q=AdapterId=<value1>;ConfigurationId=<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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency receiving incoming customer payments.
• ConfigurationName: string
  Title: Configuration Name

  Maximum Length: 100

  The name of the payment adapter configuration.
• ConfigurationValue: string
  Title: Configuration Value

  Maximum Length: 300

  The individual payment processing option within the payment adapter configuration.

{
    "type":"object",
    "properties":{
        "ConfigurationValue":{
            "title":"Configuration Value",
            "maxLength":"300",
            "type":"string",
            "description":"The individual payment processing option within the payment adapter configuration.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency receiving incoming customer payments.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "ConfigurationName":{
            "title":"Configuration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the payment adapter configuration.",
            "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 : publicSectorAdapterConfigs-item-response

Type: object

Show Source

• AdapterId: string
  Title: Payment Adapter ID

  Maximum Length: 100

  The unique identifier of the payment adapter.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency receiving incoming customer payments.
• ConfigurationId: string
  Title: Configuration ID

  Maximum Length: 15

  The unique identifier of the payment adapter configuration.
• ConfigurationName: string
  Title: Configuration Name

  Maximum Length: 100

  The name of the payment adapter configuration.
• ConfigurationValue: string
  Title: Configuration Value

  Maximum Length: 300

  The individual payment processing option within the payment adapter configuration.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AdapterId":{
            "title":"Payment Adapter ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the payment adapter.",
            "nullable":false,
            "x-queryable":true
        },
        "ConfigurationValue":{
            "title":"Configuration Value",
            "maxLength":"300",
            "type":"string",
            "description":"The individual payment processing option within the payment adapter configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency receiving incoming customer payments.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ConfigurationName":{
            "title":"Configuration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the payment adapter configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfigurationId":{
            "title":"Configuration ID",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier of the payment adapter configuration.",
            "nullable":false,
            "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