api_auth

<back to all web services

AppDefinitionRequest

AppDefinitionRequest Parameters:
NameParameterData TypeRequiredDescription
LicenseKeyquerystringNo
AppDefinition Parameters:
NameParameterData TypeRequiredDescription
RootFolderformstringNo
EntryPointformstringNo
ModulesformClientDependency[]No
ClientDependency Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TypeformstringNo
PlatformDependentformboolNo
LocationformstringNo
VersionRegKeyformVersionKeyNo
DependenciesformClientDependency[]No
VersionKey Parameters:
NameParameterData TypeRequiredDescription
NodeformstringNo
PathformstringNo
KeyformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/AppDefinitionRequest HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AppDefinitionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <LicenseKey>String</LicenseKey>
</AppDefinitionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AppDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <entry_point>String</entry_point>
  <modules>
    <ClientDependency>
      <dependencies>
        <ClientDependency>
          <dependencies>
            <ClientDependency>
              <dependencies i:nil="true" />
              <location>String</location>
              <name>String</name>
              <platform_dependent>false</platform_dependent>
              <type>String</type>
              <version_reg_key>
                <key>String</key>
                <node>String</node>
                <path>String</path>
              </version_reg_key>
            </ClientDependency>
          </dependencies>
          <location>String</location>
          <name>String</name>
          <platform_dependent>false</platform_dependent>
          <type>String</type>
          <version_reg_key>
            <key>String</key>
            <node>String</node>
            <path>String</path>
          </version_reg_key>
        </ClientDependency>
      </dependencies>
      <location>String</location>
      <name>String</name>
      <platform_dependent>false</platform_dependent>
      <type>String</type>
      <version_reg_key>
        <key>String</key>
        <node>String</node>
        <path>String</path>
      </version_reg_key>
    </ClientDependency>
  </modules>
  <root>String</root>
</AppDefinition>