SecureConnect Web Service

SecureConnect

Click here for a complete list of operations.

UpdateAgentConfig

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 /SecureConnect.asmx HTTP/1.1
Host: scws4.halfpenny.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.halfpenny.com/secureconnectwebservice2/UpdateAgentConfig"

<?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>
    <UpdateAgentConfig xmlns="http://www.halfpenny.com/secureconnectwebservice2">
      <scData>
        <agentSiteCode>string</agentSiteCode>
        <appName>string</appName>
        <comment>string</comment>
        <destnationCode>string</destnationCode>
        <eMailed>string</eMailed>
        <fileBody>base64Binary</fileBody>
        <fileBytesSent>long</fileBytesSent>
        <fileChunkSize>int</fileChunkSize>
        <fileEnd>boolean</fileEnd>
        <fileName>string</fileName>
        <fileSizeMode>LARGE or LARGE_RESEND or NORMAL</fileSizeMode>
        <fileTotalSize>long</fileTotalSize>
        <fileHashValidated>boolean</fileHashValidated>
        <interimLogText>string</interimLogText>
        <lastProcessedTime>dateTime</lastProcessedTime>
        <lastRunTime>dateTime</lastRunTime>
        <password>string</password>
        <pos>int</pos>
        <receiveCount>int</receiveCount>
        <scActivateMode>ENABLE or NEW</scActivateMode>
        <scRunState>KILL or NO_UPDATE or NOTHING or RUN or RESTART</scRunState>
        <scStatus>string</scStatus>
        <sendCount>int</sendCount>
        <serverName>string</serverName>
        <sourceCode>string</sourceCode>
        <updateFileList>string</updateFileList>
        <autoUpdateFlag>string</autoUpdateFlag>
        <configSettings>string</configSettings>
        <versionNumber>string</versionNumber>
        <scAgentStatus>IDLE or ACTIVE</scAgentStatus>
        <scSessionStatus>COMPLETE or IN_SESSION</scSessionStatus>
        <sessionSendCount>int</sessionSendCount>
        <sessionReceiveCount>int</sessionReceiveCount>
        <sessionSent>int</sessionSent>
        <sessionReceived>int</sessionReceived>
        <settings>
          <strAppPath>string</strAppPath>
          <UseVerboseLogging>boolean</UseVerboseLogging>
          <Production>boolean</Production>
          <KeepFileHistory>boolean</KeepFileHistory>
          <intPurgeDays>int</intPurgeDays>
          <strLogPath>string</strLogPath>
          <strConn>string</strConn>
          <strErrConn>string</strErrConn>
          <strAppName>string</strAppName>
          <strHistoryQuePath>string</strHistoryQuePath>
          <strEXEName>string</strEXEName>
          <strAbortQuePath>string</strAbortQuePath>
          <strUserName>string</strUserName>
          <strPW>string</strPW>
          <strCryptKey>string</strCryptKey>
        </settings>
        <currentProcessId>int</currentProcessId>
        <currentITF3Master>string</currentITF3Master>
      </scData>
    </UpdateAgentConfig>
  </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>
    <UpdateAgentConfigResponse xmlns="http://www.halfpenny.com/secureconnectwebservice2">
      <UpdateAgentConfigResult>boolean</UpdateAgentConfigResult>
      <scData>
        <agentSiteCode>string</agentSiteCode>
        <appName>string</appName>
        <comment>string</comment>
        <destnationCode>string</destnationCode>
        <eMailed>string</eMailed>
        <fileBody>base64Binary</fileBody>
        <fileBytesSent>long</fileBytesSent>
        <fileChunkSize>int</fileChunkSize>
        <fileEnd>boolean</fileEnd>
        <fileName>string</fileName>
        <fileSizeMode>LARGE or LARGE_RESEND or NORMAL</fileSizeMode>
        <fileTotalSize>long</fileTotalSize>
        <fileHashValidated>boolean</fileHashValidated>
        <interimLogText>string</interimLogText>
        <lastProcessedTime>dateTime</lastProcessedTime>
        <lastRunTime>dateTime</lastRunTime>
        <password>string</password>
        <pos>int</pos>
        <receiveCount>int</receiveCount>
        <scActivateMode>ENABLE or NEW</scActivateMode>
        <scRunState>KILL or NO_UPDATE or NOTHING or RUN or RESTART</scRunState>
        <scStatus>string</scStatus>
        <sendCount>int</sendCount>
        <serverName>string</serverName>
        <sourceCode>string</sourceCode>
        <updateFileList>string</updateFileList>
        <autoUpdateFlag>string</autoUpdateFlag>
        <configSettings>string</configSettings>
        <versionNumber>string</versionNumber>
        <scAgentStatus>IDLE or ACTIVE</scAgentStatus>
        <scSessionStatus>COMPLETE or IN_SESSION</scSessionStatus>
        <sessionSendCount>int</sessionSendCount>
        <sessionReceiveCount>int</sessionReceiveCount>
        <sessionSent>int</sessionSent>
        <sessionReceived>int</sessionReceived>
        <settings>
          <strAppPath>string</strAppPath>
          <UseVerboseLogging>boolean</UseVerboseLogging>
          <Production>boolean</Production>
          <KeepFileHistory>boolean</KeepFileHistory>
          <intPurgeDays>int</intPurgeDays>
          <strLogPath>string</strLogPath>
          <strConn>string</strConn>
          <strErrConn>string</strErrConn>
          <strAppName>string</strAppName>
          <strHistoryQuePath>string</strHistoryQuePath>
          <strEXEName>string</strEXEName>
          <strAbortQuePath>string</strAbortQuePath>
          <strUserName>string</strUserName>
          <strPW>string</strPW>
          <strCryptKey>string</strCryptKey>
        </settings>
        <currentProcessId>int</currentProcessId>
        <currentITF3Master>string</currentITF3Master>
      </scData>
    </UpdateAgentConfigResponse>
  </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 /SecureConnect.asmx HTTP/1.1
Host: scws4.halfpenny.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>
    <UpdateAgentConfig xmlns="http://www.halfpenny.com/secureconnectwebservice2">
      <scData>
        <agentSiteCode>string</agentSiteCode>
        <appName>string</appName>
        <comment>string</comment>
        <destnationCode>string</destnationCode>
        <eMailed>string</eMailed>
        <fileBody>base64Binary</fileBody>
        <fileBytesSent>long</fileBytesSent>
        <fileChunkSize>int</fileChunkSize>
        <fileEnd>boolean</fileEnd>
        <fileName>string</fileName>
        <fileSizeMode>LARGE or LARGE_RESEND or NORMAL</fileSizeMode>
        <fileTotalSize>long</fileTotalSize>
        <fileHashValidated>boolean</fileHashValidated>
        <interimLogText>string</interimLogText>
        <lastProcessedTime>dateTime</lastProcessedTime>
        <lastRunTime>dateTime</lastRunTime>
        <password>string</password>
        <pos>int</pos>
        <receiveCount>int</receiveCount>
        <scActivateMode>ENABLE or NEW</scActivateMode>
        <scRunState>KILL or NO_UPDATE or NOTHING or RUN or RESTART</scRunState>
        <scStatus>string</scStatus>
        <sendCount>int</sendCount>
        <serverName>string</serverName>
        <sourceCode>string</sourceCode>
        <updateFileList>string</updateFileList>
        <autoUpdateFlag>string</autoUpdateFlag>
        <configSettings>string</configSettings>
        <versionNumber>string</versionNumber>
        <scAgentStatus>IDLE or ACTIVE</scAgentStatus>
        <scSessionStatus>COMPLETE or IN_SESSION</scSessionStatus>
        <sessionSendCount>int</sessionSendCount>
        <sessionReceiveCount>int</sessionReceiveCount>
        <sessionSent>int</sessionSent>
        <sessionReceived>int</sessionReceived>
        <settings>
          <strAppPath>string</strAppPath>
          <UseVerboseLogging>boolean</UseVerboseLogging>
          <Production>boolean</Production>
          <KeepFileHistory>boolean</KeepFileHistory>
          <intPurgeDays>int</intPurgeDays>
          <strLogPath>string</strLogPath>
          <strConn>string</strConn>
          <strErrConn>string</strErrConn>
          <strAppName>string</strAppName>
          <strHistoryQuePath>string</strHistoryQuePath>
          <strEXEName>string</strEXEName>
          <strAbortQuePath>string</strAbortQuePath>
          <strUserName>string</strUserName>
          <strPW>string</strPW>
          <strCryptKey>string</strCryptKey>
        </settings>
        <currentProcessId>int</currentProcessId>
        <currentITF3Master>string</currentITF3Master>
      </scData>
    </UpdateAgentConfig>
  </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>
    <UpdateAgentConfigResponse xmlns="http://www.halfpenny.com/secureconnectwebservice2">
      <UpdateAgentConfigResult>boolean</UpdateAgentConfigResult>
      <scData>
        <agentSiteCode>string</agentSiteCode>
        <appName>string</appName>
        <comment>string</comment>
        <destnationCode>string</destnationCode>
        <eMailed>string</eMailed>
        <fileBody>base64Binary</fileBody>
        <fileBytesSent>long</fileBytesSent>
        <fileChunkSize>int</fileChunkSize>
        <fileEnd>boolean</fileEnd>
        <fileName>string</fileName>
        <fileSizeMode>LARGE or LARGE_RESEND or NORMAL</fileSizeMode>
        <fileTotalSize>long</fileTotalSize>
        <fileHashValidated>boolean</fileHashValidated>
        <interimLogText>string</interimLogText>
        <lastProcessedTime>dateTime</lastProcessedTime>
        <lastRunTime>dateTime</lastRunTime>
        <password>string</password>
        <pos>int</pos>
        <receiveCount>int</receiveCount>
        <scActivateMode>ENABLE or NEW</scActivateMode>
        <scRunState>KILL or NO_UPDATE or NOTHING or RUN or RESTART</scRunState>
        <scStatus>string</scStatus>
        <sendCount>int</sendCount>
        <serverName>string</serverName>
        <sourceCode>string</sourceCode>
        <updateFileList>string</updateFileList>
        <autoUpdateFlag>string</autoUpdateFlag>
        <configSettings>string</configSettings>
        <versionNumber>string</versionNumber>
        <scAgentStatus>IDLE or ACTIVE</scAgentStatus>
        <scSessionStatus>COMPLETE or IN_SESSION</scSessionStatus>
        <sessionSendCount>int</sessionSendCount>
        <sessionReceiveCount>int</sessionReceiveCount>
        <sessionSent>int</sessionSent>
        <sessionReceived>int</sessionReceived>
        <settings>
          <strAppPath>string</strAppPath>
          <UseVerboseLogging>boolean</UseVerboseLogging>
          <Production>boolean</Production>
          <KeepFileHistory>boolean</KeepFileHistory>
          <intPurgeDays>int</intPurgeDays>
          <strLogPath>string</strLogPath>
          <strConn>string</strConn>
          <strErrConn>string</strErrConn>
          <strAppName>string</strAppName>
          <strHistoryQuePath>string</strHistoryQuePath>
          <strEXEName>string</strEXEName>
          <strAbortQuePath>string</strAbortQuePath>
          <strUserName>string</strUserName>
          <strPW>string</strPW>
          <strCryptKey>string</strCryptKey>
        </settings>
        <currentProcessId>int</currentProcessId>
        <currentITF3Master>string</currentITF3Master>
      </scData>
    </UpdateAgentConfigResponse>
  </soap12:Body>
</soap12:Envelope>