Technical documentation

{{indexmenu_n>3}}
===== Exchange xml test =====
It's possible to test the Restful API interface to the netYCE system by use of the Exchange XML test form. The XML message can be entered in the form and click send.
{{ menu:operate:apis:xmltest.png?nolink |}}

When the message is correct the output will be shown.

{{ menu:operate:apis:xmltestoutput.png?nolink |}}


==== XML format ====

This section will describe the details of the XML content and how to handle communication with the Restful API.

<file xml example.xml>
<task response="">	
	<head
		task_name="service_type"
		task_type="xml-request"
		userid="user-id"
		passwd="secret-hash"
	/>
	<request	
		service_class="ML2_BKf_core"
		service_type="nw_client"
		service_task="Create"
                client_type="RN"
        >
        <custom name="client_code" type="name" value="rn12345" />
        <custom name="client_name" type="name" value="My very new customer" />
        <custom name="site_code" type="name" value="nw1234" />
        <custom name="site_type" type="name" value="BK" />
        <custom name="mpls_vrf_id" type="vrf_id" value="123" />
        <custom name="mpls_vrf_name" type="name" value="cust123" />
        <custom name="mpls_vrf_as" type="name" value="68001" />
        <custom name="mpls_vrf_rd" type="name" value="loopback:moo" />
        <custom name="mpls_vrf_rt" type="name" value="network" />
        <custom name="ip_plan" type="number" value="3" />
        <custom name="supernet" type="net" value="10.14.64.0" />
 	</request>
</task>
</file>