PIpismo
Administrative divisions V2 (deprecated)

Update administrative division (deprecated)

DEPRECATED. Call Update holiday calendar instead.

Update an administrative division.

put/divisions-core/v2/administrative-division/{id}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/divisions-core/v2/administrative-division/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

Administrative division ID.

Request body

namestring

Administrative division name

type'City' | 'State' | 'Country'

Admin division type

parent_idinteger

Parent ID

external_idstring

Client-supplied external ID. It must comply with the rule ^[a-zA-Z0-9-]+$.

working_daysinteger[]

Week days that are working days where 0 = Sunday and 6 = Saturday. The default - [1,2,3,4,5] - corresponds to Monday through Friday.

metadataMetadata

A valid JSON schema as specified in https://json-schema.org/specification.html. Used to register the rules that are used to authorize the transaction.

This object uses parameters to specify business rules for holidays. For details, see Posting Transactions on Holidays.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example request

{
  "name": "Scotland",
  "type": "State",
  "external_id": "8675309",
  "working_days": [
    1,
    2,
    3,
    4,
    5
  ]
}

Response

Updated

idinteger

Admininistrative division ID

external_idstring

Client-supplied external ID. It must comply with the rule ^[a-zA-Z0-9-]+$.

namestring

Administrative division name

parent_idinteger

Parent ID

type'City' | 'State' | 'Country'

Admin division type

working_daysinteger[]

Week days that are working days where 0 = Sunday and 6 = Saturday. The default - [1,2,3,4,5] - corresponds to Monday through Friday.

metadataMetadata

A valid JSON schema as specified in https://json-schema.org/specification.html. Used to register the rules that are used to authorize the transaction.

This object uses parameters to specify business rules for holidays. For details, see Posting Transactions on Holidays.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example response

{
  "id": 84849,
  "external_id": "8675309",
  "name": "Scotland",
  "type": "State",
  "working_days": [
    1,
    2,
    3,
    4,
    5
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.