Request Packet

A request XL setting up connection to Customer and Business Manager (CBM) service contains the set-ppb-connection operation node:

<packet>
  <server>
    <set-ppb-connection>
      ...
    </set-ppb-connection>
  </server>
</packet>

 

The set-ppb-connection node is presented by complex type SetPPBConnectionType (server_input.xsd) and structured as follows:

SetPPBConnectionType

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.

  • The connection node is required. It holds the connection properties. Data type: none.
  • The ppb-url node is required. It specifies the URL of the API connection to CBM service. Data type: string.
  • The remote-access-hash node is required. It specifies CBM remote access hash. Data type: string.
  • The integration-api-version node is required. It specifies CBM remote access hash. Data type: string. Allowed values: 0 (when we connect Plesk 9.5 and previous versions to Plesk Billing 6), 1 (when we connect Plesk 10 to Business Manager).

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.