Countries (country)

Function: country

Result: the list of elements

Countries

Access level: admin

• id — Id

• locale_name — Name

• iso2 — ISO2

• phonecode — Phone code

• status — Status

Country

Function: country.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid — unique identifier (id element of country function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • elid — unique identifier (id element of country function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name — Name. Enter a country name

• iso2 — ISO2. Enter a two- or five-letter code for the country or region

• phonecode — Phone code. Enter a country code

• phoneformat — Phone number format . Phone number format is specified with a mask without phone code. '9' in the mask means a digit from the range 0-9. In square brackets you can specify the number of unnecessary characters. For example, mask 99-99-99 means that a phone number can contain 5 or 6 digits, code not included

• doctype — Document types . Types of documents available to a company from this country

Name

Function: country.state

Result: the list of elements

States/Provinces

Access level: admin

• id — Id

• locale_name — Name

• iso — ISO code

Delete

Function: country.state.delete

Delete

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.state function.

Result: successful operation or error message

Edit state/province

Function: country.state.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid — parent list unique identifier (id element of country function).
  • elid — unique identifier (id element of country.state function)
• Result: object parameters list

Create an object:

Parameters:

• sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of country function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of country function).
  • elid — unique identifier (id element of country.state function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name — Name. State/province name

• iso — ISO code . Enter the ISO code of the region

Suspend

Function: country.suspend

Suspend

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country function.

Result: successful operation or error message

Delete

Function: country.delete

Delete

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country function.

Result: successful operation or error message

Name

Function: country.profileparam

Result: the list of elements

Payer and company information

Access level: admin

• id — Id

• locale_name — Name

• profiletype — Payer status

• page — Block

• locale_hint — Description

• orderpriority — Sorting (count forward)

• props — Properties

Move one line up

Function: country.profileparam.up

Move one line up

Access level: admin

Resume

Function: country.profileparam.resume

Resume

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.profileparam function.

Result: successful operation or error message

Move one line down

Function: country.profileparam.down

Move one line down

Access level: admin

Delete

Function: country.profileparam.delete

Delete

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.profileparam function.

Result: successful operation or error message

Reset parameters of payers and companies

Function: country.profileparam.restoredefault

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid — parent list unique identifier (id element of country function).
  • elid — unique identifier (id element of country.profileparam function)
• Result: object parameters list

Create an object:

Parameters:

• sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of country function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of country function).
  • elid — unique identifier (id element of country.profileparam function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Suspend

Function: country.profileparam.suspend

Suspend

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.profileparam function.

Result: successful operation or error message

Parameter

Function: country.profileparam.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid — parent list unique identifier (id element of country function).
  • elid — unique identifier (id element of country.profileparam function)
• Result: object parameters list

Create an object:

Parameters:

• sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of country function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok — the parameter must not be empty, generally "ok".
  • plid — parent list unique identifier (id element of country function).
  • elid — unique identifier (id element of country.profileparam function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name — Name. Parameter name

• hint — Hint .

• intname — Internal name. Enter a unique eternal name for this parameter.

• page — Block. Select a block to place this field

• inputtype — Input field type. Select types of data that can be entered into the field

• required — . (Optional parameter. To enable the option click "on".) Empty values for this parameter are forbidden

• manual_validate_not_required — . (Optional parameter. To enable the option click "on".) Select the check box to cancel manual verification of payer profile

• profiletype — Payer status . This parameters will be available for the selected types of payers

• orderpriority — Sorting (count forward). You can set priority for this field

• readonly_client — . (Optional parameter. To enable the option click "on".) Select the check box if you want to forbid your client to modify the value after he has made a payment

• requiredonpay — During payment . Here you can choose how a field will be displayed on the Add payer form. If this policy is not set, the field will be displayed depending on BILLmanager settings

• inputtype — Input field type. Select types of data that can be entered into the field

• zoom — . (Optional parameter. To enable the option click "on".) Selecting this check box will enable you to enter multiple values space separated. The selected validator will be applied to each value

• inputrows — Number of input strings. Enter the number of input strings in the text field

• required — . (Optional parameter. To enable the option click "on".) Empty values for this parameter are forbidden

• validator — Check function. This fucntion will prevent users from entering invalid data

• select_ip — IP type . Type of IP address

• num_range — . (Optional parameter. To enable the option click "on".) Range of values

• r_start_int — Start of the range. Start value of the range

• r_end_int — End of the range. End of the range

• r_start_float — Start of the range. Start value of the range

• r_end_float — End of the range. End of the range

Resume

Function: country.resume

Resume

Access level: admin

Parameters:

• elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country function.

Result: successful operation or error message