Response Samples

This packet retrieves information of an additional service plan-item.

<packet version="1.6.3.1">

<plan-item>

   <get>

      <filter>

         <name>plan-item</name>

      </filter>

   </get>

</plan-item>

</packet>

Positive response from the server looks as follows:

<packet version="1.6.3.1">

<plan-item>

   <get>

      <result>

         <status>ok</status>

         <name>plan-item</name>

         <uuid>5f3ddf7f-5cca-02ab-7a61-fd8eb662a9eb</uuid>

         <class>Plan_Item_Custom</class>

         <visible>true</visible>

         <applicable-to>

            <subscription>true</subscription>

            <site>true</site>

            <email>true</email>

         </applicable-to>

         <label>Additional Service</label>

         <tooltip>Additional service description.</tooltip>

         <url>http://domain.com</url>

         <internal>true</internal>

         <url-components>

            <dom-id>true</dom-id>

            <dom-name>true</dom-name>

            <ftp-user>true</ftp-user>

            <ftp-pass>true</ftp-pass>

            <cl-id>false</cl-id>

            <cname>false</cname>

            <pname>false</pname>

            <email>false</email>

         </url-components>

         <image-http-path>filename.png</image-http-path>

      </result>

   </get>

</plan-item>

</packet>

Negative response from the server looks as follows:

<packet version="1.6.3.1">

<plan-item>

   <get>

      <result>

          <status>error</status>

          <errcode>1013</errcode>

          <errtext>Object not found.</errtext>

      </result>

   </get>

</plan-item>

</packet>