TestEnv

This section contains source code documentation of TestEnv extension.

testenv

Extension for test automation exercises

class hydratk.extensions.testenv.testenv.Extension(core_instance=None)

Class Extension

_init_extension()

Method initializes extension

Parameters:none
Returns:void
_check_dependencies()

Method checks dependent modules

Parameters:none
Returns:bool
_uninstall()

Method returns additional uninstall data

Parameters:none
Returns:list (files), list (modules)
Return type:tuple
_register_actions()

Method registers command hooks

Parameters:none
Returns:void
_register_htk_actions()

Method registers command hooks

Parameters:none
Returns:void
_register_standalone_actions()

Method registers command hooks for standalone mode

Parameters:none
Returns:void
install_db_fc(ext_call=True)

Method handles command te-install

Parameters:ext_call (bool) – external method call
Returns:void
start_fc()

Method handles command te-run

Starts web server and installs database if not installed

Parameters:none
Returns:void

bootstrapper

Providing custom bootstrapper for testenv standalone app

hydratk.extensions.testenv.bootstrapper.run_app()

Methods runs testenv standalone application

Parameters:none
Returns:void

db_handler

Handles DB operations

class hydratk.extensions.testenv.db_handler.DbHandler

Class DbHandler

__init__()

Class constructor

Called when the object is initialized

Parameters:none
connect()

Method connects to database

Parameters:none
Returns:result
Return type:bool
disconnect()

Method disconnects from database

Parameters:none
Returns:result
Return type:bool
read_customer(id)

Method reads customer

Parameters:id (int) – customer id
Returns:crm_entities.Customer
Return type:obj
create_customer(name, segment, status='active', birth_no=None, reg_no=None, tax_no=None)

Method creates customer

Parameters:
  • name (str) – name
  • segment (int) – segment id, lov_segment.id
  • status (str) – status, lov_status.title, default active
  • birth_no (str) – birth number
  • reg_no (str) – registration number
  • tax_no (str) – tax identification number
Returns:

created customer id

Return type:

int

change_customer(id, name=None, status=None, segment=None, birth_no=None, reg_no=None, tax_no=None)

Method changes customer

Parameters:
  • id (int) – customer id
  • name (str) – name
  • status (str) – status, lov_status.title
  • segment (int) – segment id, lov_segment.id
  • birth_no (str) – birth number
  • reg_no (str) – registration number
  • tax_no (str) – tax identification number
Returns:

result

Return type:

bool

read_payer(id)

Method reads payer

Parameters:id (int) – payer id
Returns:crm_entities.Payer
Return type:obj
create_payer(name, billcycle, customer, status='active', bank_account=None)

Method creates payer

Parameters:
  • name (str) – name
  • billcycle (int) – billcycle, lov_billcycle.id
  • customer (int) – assigned customer id
  • status (str) – status, lov_status.title, default active
  • bank_account (str) – banking account
Returns:

created payer id

Return type:

int

change_payer(id, name=None, status=None, billcycle=None, bank_account=None, customer=None)

Method changes payer

Parameters:
  • id (int) – payer id
  • name (str) – name
  • status (str) – status, lov_status.title
  • billcycle (int) – billcycle id, lov_billcycle.id
  • bank_account (str) – banking account
  • customer (int) – assigned customer id
Returns:

result

Return type:

bool

read_subscriber(id)

Method reads subscriber

Parameters:id (int) – subscriber id
Returns:crm_entities.Subscriber
Return type:obj
create_subscriber(name, msisdn, market, tariff, customer, payer, status='active')

Method creates subscriber

Parameters:
  • name (str) – name
  • msisdn (str) – MSISDN
  • market (int) – market id, lov_market.id
  • tariff (int) – tariff id, lov_tariff.id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • status (str) – status, lov_status.title, default active
Returns:

created subscriber id

Return type:

int

change_subscriber(id, name=None, msisdn=None, status=None, market=None, tariff=None, customer=None, payer=None)

Method changes subscriber

Parameters:
  • id (int) – subscriber id
  • name (str) – name
  • msisdn (str) – MSISDN
  • status (str) – status, lov_status.title
  • market (int) – market id, lov_market.id
  • tariff (int) – tariff id, lov_tariff.id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
Returns:

bool

Return type:

result

read_contact(id)

Method reads contact

Parameters:id (int) – contact id
Returns:crm_entities.Contact
Return type:obj
create_contact(name, phone=None, email=None)

Method creates contact

Parameters:
  • name (str) – name
  • phone (str) – phone number
  • email (str) – email
Returns:

created contact id

Return type:

int

change_contact(id, name=None, phone=None, email=None)

Method changes contact

Parameters:
  • id (int) – contact id
  • name (str) – name
  • phone (str) – phone number
  • email (str) – email
Returns:

result

Return type:

bool

assign_contact_role(id, role, customer=None, payer=None, subscriber=None)

Method assigns contact role

Parameters:
  • id (int) – contact id
  • role (str) – role title, lov_contact_role.title
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
Returns:

result

Return type:

bool

revoke_contact_role(id, role, customer=None, payer=None, subscriber=None)

Method revokes contact role

Parameters:
  • id (int) – contact id
  • role (str) – role title, lov_contact_role.title
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
Returns:

result

Return type:

bool

read_address(id)

Method reads address

Parameters:id (int) – address id
Returns:crm_entities.Address
Return type:obj
create_address(street, street_no, city, zip)

Method creates address

Parameters:
  • street (str) – street
  • street_no (str) – street number
  • city (str) – city
  • zip (int) – zip code
Returns:

created address id

Return type:

int

change_address(id, street=None, street_no=None, city=None, zip=None)

Method changes address

Parameters:
  • id (int) – address id
  • street (str) – street
  • street_no (str) – street number
  • city (str) – city
  • zip (int) – zip code
Returns:

result

Return type:

bool

assign_address_role(id, role, contact=None, customer=None, payer=None, subscriber=None)

Method assigns address role

Parameters:
  • id (int) – address id
  • role (str) – role title, lov_address_role.title
  • contact (int) – assigned contact id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
Returns:

result

Return type:

bool

revoke_address_role(id, role, contact=None, customer=None, payer=None, subscriber=None)

Method revokes address role

Parameters:
  • id (int) – address id
  • role (str) – role title, lov_address_role.title
  • contact (int) – assigned contact id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
Returns:

result

Return type:

bool

__weakref__

list of weak references to the object (if defined)

read_services(customer=None, payer=None, subscriber=None, service=None)

Method read services

Parameters:
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
  • service (int) – service id, lov_service.id, default empty, read all services for entity
Returns:

list of crm_entities.Service

Return type:

list

create_service(service, customer=None, payer=None, subscriber=None, status='active', params={})

Method creates service

Parameters:
  • service (int) – service id, lov_service.id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
  • status (str) – status, lov_status.title, default active
  • params (dict) – key (int), lov_service_param.id, value (str)
Returns:

result

Return type:

bool

change_service(service, customer=None, payer=None, subscriber=None, status=None, params={})

Method changes service

Parameters:
  • service (int) – service id, lov_service.id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
  • status (str) – status, lov_status.title, default active
  • params (dict) – key (int), lov_service_param.id, value (str)
Returns:

result

Return type:

bool

entities

CRM entity classes

class hydratk.extensions.testenv.entities.Customer(id, name, status, segment, birth_no=None, reg_no=None, tax_no=None)

Class Customer

__init__(id, name, status, segment, birth_no=None, reg_no=None, tax_no=None)

Class constructor

Customer entity

Parameters:
  • id (int) – customer id
  • name (str) – name
  • status (str) – status, active|deactive|suspend
  • segment (int) – segment id, 2|3|4|5 RES|VSE|SME|LE
  • birth_no (str) – birth number
  • reg_no (str) – registration number
  • tax_no (str) – tax identification number
__str__()

Method overrides __str__

toxml()

Method serializes customer to XML

tojson()

Method serializes customer to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.Payer(id, name, status, billcycle, customer, bank_account=None)

Class Payer

__init__(id, name, status, billcycle, customer, bank_account=None)

Class constructor

Payer entity

Parameters:
  • id (int) – payer id
  • name (str) – name
  • status (str) – status, active|deactive|suspend
  • billcycle (int) – billcycle id, 1|2|3|4 51|52|53|54
  • bank_account (str) – banking account
  • customer (id) – assigned customer id
__str__()

Method overrides __str__

toxml()

Method serializes payer to XML

tojson()

Method serializes payer to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.Subscriber(id, name, msisdn, status, market, tariff, customer, payer)

Class Subscriber

__init__(id, name, msisdn, status, market, tariff, customer, payer)

Class constructor

Subscriber entity

Parameters:
  • id (int) – subscriber id
  • name (str) – name
  • msisdn (str) – MSISDN
  • status (str) – status, active|deactive|suspend
  • market (int) – market id, 1|2|3 GSM|DSL|FIX
  • tariff (int) – tariff id, 433|459|434|460
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
__str__()

Method overrides __str__

toxml()

Method serializes subscriber to XML

tojson()

Method serializes subscriber to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.Contact(id, name, phone=None, email=None, roles=[])

Class Contact

__init__(id, name, phone=None, email=None, roles=[])

Class constructor

Contact entity

Parameters:
  • id (int) – contact id
  • name (str) – name
  • phone (str) – phone number
  • email (str) – email
  • roles (list) – contact roles
__str__()

Method overrides __str__

toxml()

Method serializes contact to XML

tojson()

Method serializes contact to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.ContactRole(id, title, customer=None, payer=None, subscriber=None)

Class ContactRole

__init__(id, title, customer=None, payer=None, subscriber=None)

Class constructor

Contact role entity

Parameters:
  • id (int) – contact id
  • title (str) – role title, contract|contact|invoicing
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
__str__()

Method overrides __str__

toxml()

Method serializes contact role to XML

tojson()

Method serializes contact role to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.Address(id, street, street_no, city, zip, roles={})

Class Address

__init__(id, street, street_no, city, zip, roles={})

Class constructor

Address role entity

Parameters:
  • id (int) – address id
  • street (str) – street
  • street_no (str) – street number
  • city (str) – city
  • zip (int) – zip code
  • roles (list) – address roles
__str__()

Method overrides __str__

toxml()

Method serializes address to XML

tojson()

Method serializes address to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.AddressRole(id, title, contact=None, customer=None, payer=None, subscriber=None)

Class AddressRole

__init__(id, title, contact=None, customer=None, payer=None, subscriber=None)

Class constructor

Address role entity

Parameters:
  • id (int) – address id
  • title (str) – role title, contract|contact|invoicing|delivery
  • contact (int) – assigned contact id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
__str__()

Method overrides __str__

toxml()

Method serializes address role to XML

tojson()

Method serializes address role to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.Service(id, name, status, params={})

Class Service

__init__(id, name, status, params={})

Class constructor

Service entity

Parameters:
  • id (int) – service id
  • name (str) – name
  • status (str) – status, active|deactive|suspend
  • params (dict) – parameters
__str__()

Method overrides __str__

toxml()

Method serializes service to XML

tojson()

Method serializes service to JSON

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.entities.ServiceOperation(service, customer=None, payer=None, subscriber=None, status=None, params={})

Class ServiceOperation

__init__(service, customer=None, payer=None, subscriber=None, status=None, params={})

Class constructor

Service operation entity

Parameters:
  • service (int) – service id
  • customer (int) – assigned customer id
  • payer (int) – assigned payer id
  • subscriber (int) – assigned subscriber id
  • status (str) – service status, active|deactive|suspend
  • params (dict) – service parameters
__str__()

Method overrides __str__

toxml()

Method serializes service operation to XML

tojson()

Method serializes service operation to JSON

__weakref__

list of weak references to the object (if defined)

rest_handler

Handles REST operations

class hydratk.extensions.testenv.rest_handler.RestHandler

Class RestHandler

__init__()

Class constructor

Called when the object is initialized

Parameters:none
_get_db()

Method connect to database

Parameters:none
Returns:DB client
Return type:DB_INT
read_customer(data)

Method handles GET customer

Parameters:(dict) - request input with customer id (data) –
Returns:HTTP 200 with customer detail in JSON, HTTP 404 when customer not found, HTTP 400 when param id is missing
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "status": "active",
  "segment": 2,
  "birth_no": "700101/0001",
  "reg_no": "123456",
  "tax_no": "CZ123456"
}
create_customer(data)

Method handles POST customer

Parameters:data (json) – customer detail
Returns:HTTP 200 with id of created customer, HTTP 400 when customer not created
Return type:http

Example:

{
  "name": "Charlie Bowman",
  "status": "active",
  "segment": 2,
  "birth_no": "700101/0001",
  "reg_no": "123456",
  "tax_no": "CZ123456"
}
change_customer(data)

Method handles PUT customer

Parameters:data (json) – customer detail
Returns:HTTP 200 when customer changed, HTTP 400 when customer not changed
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "status": "active",
  "segment": 2,
  "birth_no": "700101/0001",
  "reg_no": "123456",
  "tax_no": "CZ123456"
}
read_payer(data)

Method handles GET payer

Parameters:data (dict) – request input with payer id
Returns:HTTP 200 with payer detail in JSON, HTTP 404 when payer not found, HTTP 400 when param id is missing
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "status": "active",
  "billcycle": 1,
  "bank_account": "123456/0100",
  "customer": 1
}
create_payer(data)

Method handles POST payer

Parameters:data (json) – payer detail
Returns:HTTP 200 with id of created payer, HTTP 400 when payer not created
Return type:http

Example:

{
  "name": "Charlie Bowman",
  "status": "active",
  "billcycle": 1,
  "bank_account": "123456/0100",
  "customer": 1
}
change_payer(data)

Method handles PUT payer

Parameters:(json) - payer detail (data) –
Returns:HTTP 200 when payer changed, HTTP 400 when payer not changed
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "status": "active",
  "billcycle": 1,
  "bank_account": "123456/0100",
  "customer": 1
}
read_subscriber(data)

Method handles GET subscriber

Parameters:(dict) - request input with subscriber id (data) –
Returns:HTTP 200 with subscriber detail in JSON, HTTP 404 when subscriber not found, HTTP 400 when param id is missing
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "msisdn": "123456"
  "status": "active",
  "market": 1,
  "tariff": 433,
  "customer": 1,
  "payer": 2
}
create_subscriber(data)

Method handles POST subscriber

Parameters:(json) - subscriber detail (data) –
Returns:HTTP 200 with id of created subscriber, HTTP 400 when subscriber not created
Return type:http

Example:

{
  "name": "Charlie Bowman",
  "msisdn": "123456"
  "status": "active",
  "market": 1,
  "tariff": 433,
  "customer": 1,
  "payer": 2
}
change_subscriber(data)

Method handles PUT subscriber

Parameters:data (json) – payer detail
Returns:HTTP 200 when subscriber changed, HTTP 400 when subscriber not changed
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "msisdn": "123456"
  "status": "active",
  "market": 1,
  "tariff": 433,
  "customer": 1,
  "payer": 2
}
read_contact(data)

Method handles GET contact

Parameters:data (dict) – request input with contact id
Returns:HTTP 200 with contact detail in JSON, choice customer|payer|subscriber, HTTP 404 when contact not found, HTTP 400 when param id is missing
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "phone": "123456"
  "email": "aaa@xxx.com",
  "roles": {
    "role": [
      {
        "id": 1,
        "title": "contract",
        "customer": 1,
        "payer": 1,
        "subscriber": 1
      }
  ]}
}
create_contact(data)

Method handles POST contact

Parameters:data (json) – contact detail
Returns:HTTP 200 with id of created contact, HTTP 400 when contact not created
Return type:http

Example:

{
  "name": "Charlie Bowman",
  "phone": "123456"
  "email": "aaa@xxx.com"
}
change_contact(data)

Method handles PUT customer

Parameters:data (json) – contact detail
Returns:HTTP 200 when contact changed, HTTP 400 when contact not changed
Return type:http

Example:

{
  "id": 1,
  "name": "Charlie Bowman",
  "phone": "123456"
  "email": "aaa@xxx.com"
}
assign_contact_role(data)

Method handles POST contact/role

Parameters:data (json) – contact role detail, choice customer|payer|subscriber
Returns:HTTP 200 when contact role assigned, HTTP 400 when customer role not assigned
Return type:http

Example:

{
  "id": 1,
  "title": "contract",
  "customer": 1,
  "payer": 1,
  "subscriber": 1
}
revoke_contact_role(data)

Method handles PUT contact/role

Parameters:data (json) – contact role detail, choice customer|payer|subscriber
Returns:HTTP 200 when contact role revoked, HTTP 400 when customer role not revoked
Return type:http

Example:

{
  "id": 1,
  "title": "contract",
  "customer": 1,
  "payer": 1,
  "subscriber": 1
}
read_address(data)

Method handles GET address

Parameters:data (dict) – request input with address id
Returns:HTTP 200 with address detail in JSON, choice contact|customer|payer|subscriber, HTTP 404 when address not found, HTTP 400 when param id is missing
Return type:http

Example:

{
  "id": 1,
  "street": "Tomickova",
  "street_no": "2144/1"
  "city": "Praha",
  "zip": 14800
  "roles": {
    "role": [
      {
        "id": 1,
        "title": "contract",
        "contact": 1,
        "customer": 1,
        "payer": 1,
        "subscriber": 1
      }
  ]}
}
create_address(data)

Method handles POST address

Parameters:data (json) – address detail
Returns:HTTP 200 with id of created address, HTTP 400 when address not created
Return type:http

Example:

{
  "street": "Tomickova",
  "street_no": "2144/1"
  "city": "Praha",
  "zip": 14800
}
change_address(data)

Method handles PUT address

Parameters:data (json) – address detail
Returns:HTTP 200 when address changed, HTTP 400 when address not changed
Return type:http

Example:

{
  "id": 1,
  "street": "Tomickova",
  "street_no": "2144/1"
  "city": "Praha",
  "zip": 14800
}
assign_address_role(data)

Method handles POST address/role

Parameters:data (json) – address role detail
Returns:HTTP 200 when address role assigned, HTTP 400 when address role not assigned
Return type:http

Example:

{
   "id": 1,
   "title": "contract",
   "contact": 1,
   "customer": 1,
   "payer": 1,
   "subscriber": 1
 }
revoke_address_role(data)

Method handles PUT address/role

Parameters:data (json) – address role detail
Returns:HTTP 200 when address role revoked, HTTP 400 when address role not revoked
Return type:http

Example:

{
   "id": 1,
   "title": "contract",
   "contact": 1,
   "customer": 1,
   "payer": 1,
   "subscriber": 1
 }
read_services(data)

Method handles GET service

Parameters:data (dict) – request input entity and service id (all services if empty), choice customer|payer|subscriber,
Returns:HTTP 200 with list of services in JSON, HTTP 404 when service not found, HTTP 400 when no entity is provided
Return type:http

Example:

{
  "service":
  {
    "service":
    [
      {
        "id": 615,
        "name": "Telefonni cislo",
        "status": "active",
        "params":
        {
          "entry":
          [
            {
              "key": 121,
              "value": "12345"
            }
          ]
        }
      }
    ]
  }
}
create_service(data)

Method handles POST service

Parameters:data (json) – service operation, choice customer|payer|subscriber
Returns:HTTP 200 when service created, HTTP 400 when service not created
Return type:http

Example:

{
  "customer": 1,
  "payer": 1,
  "subscriber": 1,
  "service": 615,
  "status": "active",
  "params":
  {
    "entry":
    [
      {
        "key": 121,
        "value": "12345"
      }
    ]
  }
}
__weakref__

list of weak references to the object (if defined)

change_service(data)

Method handles PUT service

Parameters:data (json) – service operation, choice customer|payer|subscriber
Returns:HTTP 200 when service changed, HTTP 400 when service not changed
Return type:http

Example:

{
  "customer": 1,
  "payer": 1,
  "subscriber": 1,
  "service": 615,
  "status": "active",
  "params":
  {
    "entry":
    [
      {
        "key": 121,
        "value": "12345"
      }
    ]
  }
}

soap_handler

Handles SOAP operations

class hydratk.extensions.testenv.soap_handler.SoapHandler

Class SoapHandler

__init__()

Class constructor

Called when the object is initialized

Parameters:none
_get_db()

Method connect to database

Parameters:none
Returns:DB client
Return type:DB_INT
_fault(message)

Method creates SOAP fault

Parameters:message (str) – error message
Returns:SOAP fault
Return type:str
_response(method, content)

Method creates SOAP response

Parameters:
  • method (str) – method name
  • content (xml) – response body
Returns:

SOAP response

Return type:

str

dispatcher(headers, data)

Method dispatches request according to SOAPAction

Parameters:
  • headers (dict) – HTTP headers
  • data (str) – SOAP request
Returns:

SOAP response or fault

Return type:

str

read_customer(doc)

Method handles read_customer request

Parameters:doc (xml) – read_customer request with customer id
Returns:read_customer_response with customer detail, SOAP fault when customer not found
Return type:xml

Example:

<read_customer>
  <id>1</id>
</read_customer>

<read_customer_response>
  <customer>
    <id>1</id>
    <name>Charlie Bowman</name>
    <status>active</status>
    <segment>2</segment>
    <birth_no>700101/0001</birth_no>
    <reg_no>123456</reg_no>
    <tax_no>CZ123456</tax_no>
  </customer>
</read_customer_response>
create_customer(doc)

Method handles create_customer request

Parameters:doc (xml) – create_customer request
Returns:create_customer_response with id of created customer, SOAP fault when customer not created
Return type:xml

Example:

<create_customer>
  <name>Charlie Bowman</name>
  <status>active</status>
  <segment>2</segment>
  <birth_no>700101/0001</birth_no>
  <reg_no>123456</reg_no>
  <tax_no>CZ123456</tax_no>
</create_customer>

<create_customer_response>
  <id>1</id>
<create_customer_response>
change_customer(doc)

Method handles change_customer request

Parameters:doc (xml) – change_customer request
Returns:change_customer_response with result true when customer changed, SOAP fault when customer not changed
Return type:xml

Example:

<change_customer>
  <id>1</id>
  <name>Charlie Bowman</name>
  <status>active</status>
  <segment>2</segment>
  <birth_no>700101/0001</birth_no>
  <reg_no>123456</reg_no>
  <tax_no>CZ123456</tax_no>
</create_customer>

<change_customer_response>
  <result>true</true>
</change_customer_response>
read_payer(doc)

Method handles read_payer request

Parameters:doc (xml) – read_payer request with payer id
Returns:read_payer_response with payer detail, SOAP fault when payer not found
Return type:xml

Example:

<read_payer>
  <id>1</id>
</read_payer>

<read_payer_response>
  <payer>
    <id>1</id>
    <name>Charlie Bowman</name>
    <status>active</status>
    <billcycle>1</billcycle>
    <bank_account>12345/0100</bank_account>
    <customer>1</customer>
  </payer>
</read_payer_response>
create_payer(doc)

Method handles create_payer request

Parameters:doc (xml) – create_payer request
Returns:create_payer_response with id of created payer, SOAP fault when payer not created
Return type:xml

Example:

<create_payer>
  <name>Charlie Bowman</name>
  <status>active</status>
  <billcycle>1</billcycle>
  <bank_account>12345/0100</bank_account>
  <customer>1</customer>
</create_payer>

<create_payer_response>
  <id>1</id>
</create_payer_response>
change_payer(doc)

Method handles change_payer request

Parameters:doc (xml) – change_payer request
Returns:change_payer_response with result true when payer changed, SOAP fault when payer not changed
Return type:xml

Example:

<change_payer>
  <id>1</id>
  <name>Charlie Bowman</name>
  <status>active</status>
  <billcycle>1</billcycle>
  <bank_account>12345/0100</bank_account>
  <customer>1</customer>
</change_payer>

<change_payer_response>
  <result>true</result>
</change_payer_response>
read_subscriber(doc)

Method handles read_csubscriber request

Parameters:doc (xml) – read_subscriber request with subscriber id
Returns:read_subscriber_response with subscriber detail, SOAP fault when subscriber not found
Return type:xml

Example:

<read_subscriber>
  <id>1</id>
<read_subscriber>

<read_subscriber_response>
  <subscriber>
    <id>1</id>
    <name>Charlie Bowman</name>
    <msisdn>12345</msisdn>
    <status>active</status>
    <market>1</market>
    <tariff>433</tariff>
    <customer>1</customer>
    <payer>1</payer>
  </subscriber>
</read_subscriber_response>
create_subscriber(doc)

Method handles create_subscriber request

Parameters:doc (xml) – create_subscriber request
Returns:create_subscriber_response with id of created subscriber, SOAP fault when subscriber not created
Return type:xml

Example:

<create_subscriber>
  <name>Charlie Bowman</name>
  <msisdn>12345</msisdn>
  <status>active</status>
  <market>1</market>
  <tariff>433</tariff>
  <customer>1</customer>
  <payer>1</payer>
</create_subscriber>

<create_subscriber_response>
  <id>1</id>
<create_subscriber_response>
change_subscriber(doc)

Method handles change_subscriber request

Parameters:doc (xml) – change_subscriber request
Returns:change_subscriber_response with result true when subscriber changed, SOAP fault when subscriber not changed
Return type:xml

Example:

<change_subscriber>
  <id>1</id>
  <name>Charlie Bowman</name>
  <msisdn>12345</msisdn>
  <status>active</status>
  <market>1</market>
  <tariff>433</tariff>
  <customer>1</customer>
  <payer>1</payer>
</change_subscriber>

<change_subscriber_response>
  <result>true</result>
<change_subscriber_response>
read_contact(doc)

Method handles read_contact request

Parameters:doc (int) – read_contact request with contact id
Returns:read_contact_response with contact detail, choice customer|payer|subscriber, SOAP fault when contact not found
Return type:xml

Example:

<read_contact>
  <id>1</id>
</read_contact>

<read_contact_response>
  <contact>
    <id>1</id>
    <name>Charlie Bowman</name>
    <phone>12345</phone>
    <email>xxx@xxx.com</email>
    <roles>
      <role>
        <id>1</id>
        <title>contract</title>
        <customer>1</customer>
        <payer>1</payer>
        <subscribe>1</subscriber>
      </role>
    </roles>
  </contact>
</read_contact_response>
create_contact(doc)

Method handles create_contact request

Parameters:doc (xml) – create_contact request
Returns:create_contact_response with id of created contact, SOAP fault when contact not created
Return type:xml

Example:

<create_contact>
  <name>Charlie Bowman</name>
  <phone>12345</phone>
  <email>xxx@xxx.com</email>
</create_contact>

<create_contact_response>
  <id>1</id>
</create_contact_response>
change_contact(doc)

Method handles change_contact request

Parameters:doc (xml) – change_contact request
Returns:change_contact_response with result true when contact changed, SOAP fault when contact not changed
Return type:xml

Example:

<change_contact>
  <id>1</id>
  <name>Charlie Bowman</name>
  <phone>12345</phone>
  <email>xxx@xxx.com</email>
</change_contact>

<change_contact_response>
  <result>true</true>
</change_contact_response>
assign_contact_role(doc)

Method handles assign_contact_role request

Parameters:doc (xml) – assign_contact_role request, choice customer|payer|subscriber
Returns:assign_contact_role_response with result true when contact role assigned, SOAP fault when contact role not assigned
Return type:xml

Example:

<assign_contact_role>
  <id>1</id>
  <title>contract</title>
  <customer>1</customer>
  <payer>1</payer>
  <subscriber>1</subscriber>
</assign_contact_role>

<assign_contact_role_response>
  <result>true</true>
</assign_contact_role_response>
revoke_contact_role(doc)

Method handles revoke_contact_role request

Parameters:doc (xml) – revoke_contact_role request, choice customer|payer|subscriber
Returns:revoke_contact_role_response with result true when contact role revoked, SOAP fault when contact role not revoked
Return type:xml

Example:

<revoke_contact_role>
  <id>1</id>
  <title>contract</title>
  <customer>1</customer>
  <payer>1</payer>
  <subscriber>1</subscriber>
</revoke_contact_role>

<revoke_contact_role_response>
  <result>true</true>
</revoke_contact_role_response>
read_address(doc)

Method handles read_address request

Parameters:(xml) - read_address request with address id (doc) –
Returns:read_address_response with address detail, choice contact|customer|payer|subscriber, SOAP fault when address not found
Return type:xml

Example:

<read_address>
  <id>1</id>
</read_address>

<read_address_response>
  <address>
    <id>1</id>
    <street>Tomickova</street>
    <street_no>2144/1</street_no>
    <city>Praha</city>
    <zip>14800</zip>
    <roles>
      <role>
        <id>1</id>
        <title>contract</title>
        <contact>1</contact>
        <customer>1</customer>
        <payer>1</payer>
        <subscriber>1</subscriber>
      </role>
    </roles>
  </address>
</read_address_response>
create_address(doc)

Method handles create_address request

Parameters:doc (xml) – create_address request
Returns:create_address_response with id of created address, SOAP fault when address not created
Return type:xml

Example:

<create_address>
  <street>Tomickova</street>
  <street_no>2144/1</street_no>
  <city>Praha</city>
  <zip>14800</zip>
</create_address>

<create_address_response>
  <id>1</id>
</create_address_response>
change_address(doc)

Method handles change_address request

Parameters:doc (xml) – change_address request
Returns:change_address_response with result true when address changed, SOAP fault when address not changed
Return type:xml

Example:

<change_address>
  <id>1</id>
  <street>Tomickova</street>
  <street_no>2144/1</street_no>
  <city>Praha</city>
  <zip>14800</zip>
</change_address>

<change_address_response>
  <result>true</true>
</change_address_response>
assign_address_role(doc)

Method handles assign_address_role request

Parameters:doc (xml) – assign_address_role request, choice contact|customer|payer|subscriber
Returns:assign_address_role_response with result true when address role assigned, SOAP fault when address role not assigned
Return type:xml

Example:

<assign_address_role>
  <id>1</id>
  <title>contract</title>
  <contact>1</contact>
  <customer>1</customer>
  <payer>1</payer>
  <subscriber>1</subscriber>
</revoke_address_role>

<assign_address_role_response>
  <result>true</true>
</assign_address_role_response>
__weakref__

list of weak references to the object (if defined)

revoke_address_role(doc)

Method handles revoke_address_role request

Parameters:doc (xml) – revoke_address_role request, choice contact|customer|payer|subscriber
Returns:revoke_address_role_response with result true when address role revoked, SOAP fault when address role not revoked
Return type:xml

Example:

<revoke_address_role>
  <id>1</id>
  <title>contract</title>
  <contact>1</contact>
  <customer>1</customer>
  <payer>1</payer>
  <subscriber>1</subscriber>
</revoke_address_role>

<revoke_address_role_response>
  <result>true</true>
</revoke_address_role_response>
read_services(doc)

Method handles read_services request

Parameters:doc (xml) – read_services request, choice customer|payer|subscriber, all services are read if service empty
Returns:read_services_response with list of services, SOAP fault when service not found
Return type:xml

Example:

<read_services>
  <customer>1</customer>
  <payer>1</payer>
  <subscriber>1</subscriber>
  <service>615</service>
</read_services>

<read_services_response>
  <services>
    <service>
      <id>id</id>
      <name>Telefonni cislo</name>
      <status>active</active>
      <params>
        <entry>
          <key>121</key>
          <value>12345</value>
        </entry>
       </params>
    </service>
  </services>
</read_services_response>
create_service(doc)

Method handles create_service request

Parameters:doc (xml) – create_service request, choice customer|payer|subscriber
Returns:create_service_response with result true, SOAP fault when service not created
Return type:xml

Example:

<create_service>
  <service>615</service>
  <customer>1</customer>
  <payer>1</payer>
  <subscriber>1</subscriber>
  <status>active</active>
  <params>
    <entry>
      <key>121</key>
      <value>12345</value>
    </entry>
  </params>
</create_service>

<create_service_response>
  <result>true</result>
</create_service_response>
change_service(doc)

Method handles change_service request

Parameters:doc (xml) – change_service request, choice customer|payer|subscriber
Returns:change_service_response with result true, SOAP fault when service not changed
Return type:xml

Example:

<change_service>
  <service>615</service>
  <customer>1</customer>
  <payer>1</payer>
  <subscriber>1</subscriber>
  <status>active</active>
  <params>
    <entry>
      <key>121</key>
      <value>12345</value>
    </entry>
  </params>
</change_service>

<change_service_response>
  <result>true</result>
</change_service_response>

web_server

Web server

class hydratk.extensions.testenv.web_server.Server

Class Server

__init__()

Class constructor

Called when the object is initialized

Parameters:none
_start()

Method starts web server

Parameters:none
Returns:void
__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.Customer

Handles requests on /rs/customer

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.Payer

Handles requests on /rs/payer

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.Subscriber

Handles requests on /rs/subscriber

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.Contact

Handles requests on /rs/contact

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.ContactRole

Handles requests on /rs/contact/role

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.Address

Handles requests on /rs/address

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.AddressRole

Handles requests on /rs/address/role

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.Service

Handles requests on /rs/service

__weakref__

list of weak references to the object (if defined)

class hydratk.extensions.testenv.web_server.SoapService

Handles requests on /ws/crm

__weakref__

list of weak references to the object (if defined)