write-voip-api-to-envia about nmsprime HOT 6 CLOSED

I think we should use SimpleXML (http://php.net/manual/en/book.simplexml.php) to create and read the XML needed used for communication with Envia.
It is much easier to handle than DOM and also able to handle attributes. Also there are some user written extensions to savely convert arrays to xml and back. This is not trivial because of the attributes and because there can be sibling tags.

There is no real marshalling in PHP (as it is e.g. in Java)…

from nmsprime.

It would be helpful if Envia could give us schema or DTD files for the API. With these files we could:

1. Validate our generated XML (before sending and in unit tests).
2. Get a clearer idea of the possible return data than from the example XML (and avoid surprises).

⇒ We should ask for this (I think they validate the input before processing it)!

from nmsprime.

There are several errors within the envia documentation: read with care!

Examples:

• https://www.enviatel.de/portal/api/rest/doc/v1/misc/get_free_numbers.html
  • Einschränkung nach einer bestimmten Rufnummer oder einem konkreten Rufnummernanfang, nur in Verbindung mit einer Ortsnetzkennzahl möglich
    Wertebereich:

    \A[-_.a-zA-Z0-9]{8,15}\z

  • looks like copy-and-paste, this is not a RegEx for a phonenumber (or beginning of a phonenumber)…
• https://www.enviatel.de/portal/api/rest/doc/v1.html
  • POST /api/rest/v1/contract/terminate: Diese Methode führt eine Bestellung eines Produktes durch.
  • in reality this seems to delete the contract
• https://www.enviatel.de/portal/api/rest/doc/v1/contract/create.html
  • in the example they use reseller_k123456 in the returned XML
  • At the bottom man can read in “contract_create[customer_identifier][customerreference]”: Durch envia TEL vergebene eindeutige Kundenreferenz
    Wertebereich:

    \A[A-Z0-9]{3,7}[0-9]{0,3}[_-][-_A-Za-z0-9]{1,50}\z

  • the returned reference is invalid using this RegEx
• Also the information seems not to be complete :-/

We badly need more documentation or at least the data definition files (as described above)…

from nmsprime.

We will need some extra database fields: Here we can collect them.

\A[-_\/.A-Za-z0-9]{1,60}\z

\A[A-Z0-9]{3,7}[0-9]{0,3}[_-][-_A-Za-z0-9]{1,50}\z

by @xee8ai

from nmsprime.

List of carrier codes:
http://www.bundesnetzagentur.de/DE/Sachgebiete/Telekommunikation/Unternehmen_Institutionen/Nummerierung/TechnischeNummern/Portierungskennungen/VerzeichnisPortKenn_Basepage.html

from nmsprime.

Progress report

After the merge into dev: time to reflect the current status…

General ToDo (Overview)

• write importer for configuration (to have an easy way to initialize a fresh system) ⇒ we should use parse_ini_file with models as sections and entries as key: value; this would also allow a partial update – we only touch models with a section in the uploaded file ⇒ initializing the possible list values for several phonebookentry related fields will make heavy use of this feature, later changes are easy to do write in plain SQL (to be as flexible as possible)
• test voipaccount termination ⇒ possible if one is created at Envia
• ask Envia for possible orderstatus/orderstatus_id – maybe we have to update activation date if preferred date is not possible
• implement configurable tariff, variation, trcclass
• for more details read https://devel.roetzer-engineering.com/confluence/display/LAR/2016-04-13+Envia+API+going+production+discussion

Order API

Selfcare API

ATM selfcare API is not activated

by @xee8ai

from nmsprime.