MyCalyxDeployService Web Service

MyCalyxDeployService

Click here for a complete list of operations.

InstallPoint

Service to install MyCalyx client

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Service/MyCalyxDeployService.asmx HTTP/1.1
Host: www.mycalyx.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/InstallPoint"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InstallPoint xmlns="http://tempuri.org/">
      <oMyCalyxServerRequest>
        <RequestedKey>string</RequestedKey>
        <RequestedKeypair>string</RequestedKeypair>
      </oMyCalyxServerRequest>
      <oMyCalyxPointClientRequest>
        <_MFACode>string</_MFACode>
        <PointGUID>string</PointGUID>
        <UserRequestId>string</UserRequestId>
        <MachineGuid>string</MachineGuid>
        <ClientPointVersion>string</ClientPointVersion>
        <ClientPointBuild>int</ClientPointBuild>
        <PointStarterVersion>string</PointStarterVersion>
        <MediaType>CD or Online</MediaType>
        <SourceType>FromEmail or FromPointStarter</SourceType>
      </oMyCalyxPointClientRequest>
    </InstallPoint>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InstallPointResponse xmlns="http://tempuri.org/">
      <InstallPointResult>
        <IsMFA>boolean</IsMFA>
        <InstallDetails>
          <_MFASettings>
            <IsMFA>boolean</IsMFA>
          </_MFASettings>
          <UserName>string</UserName>
          <CompanyName>string</CompanyName>
          <AccountID>string</AccountID>
          <PointEulaURL>string</PointEulaURL>
          <Packages>
            <Package xsi:nil="true" />
            <Package xsi:nil="true" />
          </Packages>
          <PointAdministrator>Install or DoNotInstall</PointAdministrator>
          <MFASettings>
            <IsMFA>boolean</IsMFA>
          </MFASettings>
        </InstallDetails>
        <Settings>
          <TemplateDirectory>string</TemplateDirectory>
          <LocalFolderDirectories>
            <string>string</string>
            <string>string</string>
          </LocalFolderDirectories>
          <PointCentralServer>
            <Key>string</Key>
            <URL>string</URL>
          </PointCentralServer>
          <SharedFolderLocation>string</SharedFolderLocation>
          <AppDirPath>string</AppDirPath>
          <IsOverrideLocalFolders>boolean</IsOverrideLocalFolders>
        </Settings>
        <Status>
          <TransactionId>int</TransactionId>
          <Code>int</Code>
          <Message>string</Message>
          <Action>None or Run or Install or Uninstall or UpdateSettings or DontRun</Action>
        </Status>
        <SystemAdministrator>
          <Password>string</Password>
          <UserName>string</UserName>
        </SystemAdministrator>
        <AccountUserId>int</AccountUserId>
        <PreInstallMessage>string</PreInstallMessage>
      </InstallPointResult>
    </InstallPointResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Service/MyCalyxDeployService.asmx HTTP/1.1
Host: www.mycalyx.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <InstallPoint xmlns="http://tempuri.org/">
      <oMyCalyxServerRequest>
        <RequestedKey>string</RequestedKey>
        <RequestedKeypair>string</RequestedKeypair>
      </oMyCalyxServerRequest>
      <oMyCalyxPointClientRequest>
        <_MFACode>string</_MFACode>
        <PointGUID>string</PointGUID>
        <UserRequestId>string</UserRequestId>
        <MachineGuid>string</MachineGuid>
        <ClientPointVersion>string</ClientPointVersion>
        <ClientPointBuild>int</ClientPointBuild>
        <PointStarterVersion>string</PointStarterVersion>
        <MediaType>CD or Online</MediaType>
        <SourceType>FromEmail or FromPointStarter</SourceType>
      </oMyCalyxPointClientRequest>
    </InstallPoint>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <InstallPointResponse xmlns="http://tempuri.org/">
      <InstallPointResult>
        <IsMFA>boolean</IsMFA>
        <InstallDetails>
          <_MFASettings>
            <IsMFA>boolean</IsMFA>
          </_MFASettings>
          <UserName>string</UserName>
          <CompanyName>string</CompanyName>
          <AccountID>string</AccountID>
          <PointEulaURL>string</PointEulaURL>
          <Packages>
            <Package xsi:nil="true" />
            <Package xsi:nil="true" />
          </Packages>
          <PointAdministrator>Install or DoNotInstall</PointAdministrator>
          <MFASettings>
            <IsMFA>boolean</IsMFA>
          </MFASettings>
        </InstallDetails>
        <Settings>
          <TemplateDirectory>string</TemplateDirectory>
          <LocalFolderDirectories>
            <string>string</string>
            <string>string</string>
          </LocalFolderDirectories>
          <PointCentralServer>
            <Key>string</Key>
            <URL>string</URL>
          </PointCentralServer>
          <SharedFolderLocation>string</SharedFolderLocation>
          <AppDirPath>string</AppDirPath>
          <IsOverrideLocalFolders>boolean</IsOverrideLocalFolders>
        </Settings>
        <Status>
          <TransactionId>int</TransactionId>
          <Code>int</Code>
          <Message>string</Message>
          <Action>None or Run or Install or Uninstall or UpdateSettings or DontRun</Action>
        </Status>
        <SystemAdministrator>
          <Password>string</Password>
          <UserName>string</UserName>
        </SystemAdministrator>
        <AccountUserId>int</AccountUserId>
        <PreInstallMessage>string</PreInstallMessage>
      </InstallPointResult>
    </InstallPointResponse>
  </soap12:Body>
</soap12:Envelope>