WebServices3

Click here for a complete list of operations.

BusinessRules_Workflow_Run

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 /WebServices3.asmx HTTP/1.1
Host: demo.bvcommerce.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3/BusinessRules_Workflow_Run"

<?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>
    <BusinessRules_Workflow_Run xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <instance>
        <Steps>
          <WorkFlowStep>
            <WorkFlowBvin>string</WorkFlowBvin>
            <SortOrder>int</SortOrder>
            <ControlName>string</ControlName>
            <DisplayName>string</DisplayName>
            <StepName>string</StepName>
          </WorkFlowStep>
          <WorkFlowStep>
            <WorkFlowBvin>string</WorkFlowBvin>
            <SortOrder>int</SortOrder>
            <ControlName>string</ControlName>
            <DisplayName>string</DisplayName>
            <StepName>string</StepName>
          </WorkFlowStep>
        </Steps>
        <Name>string</Name>
        <SystemWorkFlow>boolean</SystemWorkFlow>
        <ContextType>Uknown or ProductWorkFlow or OrderWorkFlow or ShippingWorkFlow</ContextType>
      </instance>
      <c>
        <UserId>string</UserId>
        <Errors>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
        </Errors>
        <Inputs>
          <CustomProperty>
            <DeveloperId>string</DeveloperId>
            <Key>string</Key>
            <Value>string</Value>
          </CustomProperty>
          <CustomProperty>
            <DeveloperId>string</DeveloperId>
            <Key>string</Key>
            <Value>string</Value>
          </CustomProperty>
        </Inputs>
        <Outputs>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
        </Outputs>
      </c>
    </BusinessRules_Workflow_Run>
  </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>
    <BusinessRules_Workflow_RunResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <BusinessRules_Workflow_RunResult>boolean</BusinessRules_Workflow_RunResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
    </BusinessRules_Workflow_RunResponse>
  </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 /WebServices3.asmx HTTP/1.1
Host: demo.bvcommerce.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>
    <BusinessRules_Workflow_Run xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <instance>
        <Steps>
          <WorkFlowStep>
            <WorkFlowBvin>string</WorkFlowBvin>
            <SortOrder>int</SortOrder>
            <ControlName>string</ControlName>
            <DisplayName>string</DisplayName>
            <StepName>string</StepName>
          </WorkFlowStep>
          <WorkFlowStep>
            <WorkFlowBvin>string</WorkFlowBvin>
            <SortOrder>int</SortOrder>
            <ControlName>string</ControlName>
            <DisplayName>string</DisplayName>
            <StepName>string</StepName>
          </WorkFlowStep>
        </Steps>
        <Name>string</Name>
        <SystemWorkFlow>boolean</SystemWorkFlow>
        <ContextType>Uknown or ProductWorkFlow or OrderWorkFlow or ShippingWorkFlow</ContextType>
      </instance>
      <c>
        <UserId>string</UserId>
        <Errors>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
        </Errors>
        <Inputs>
          <CustomProperty>
            <DeveloperId>string</DeveloperId>
            <Key>string</Key>
            <Value>string</Value>
          </CustomProperty>
          <CustomProperty>
            <DeveloperId>string</DeveloperId>
            <Key>string</Key>
            <Value>string</Value>
          </CustomProperty>
        </Inputs>
        <Outputs>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
          <WorkflowMessage>
            <CustomerVisible>boolean</CustomerVisible>
            <Name>string</Name>
            <Description>string</Description>
          </WorkflowMessage>
        </Outputs>
      </c>
    </BusinessRules_Workflow_Run>
  </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>
    <BusinessRules_Workflow_RunResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <BusinessRules_Workflow_RunResult>boolean</BusinessRules_Workflow_RunResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
    </BusinessRules_Workflow_RunResponse>
  </soap12:Body>
</soap12:Envelope>