ChicoCloudWS Web Service

ChicoCloudWS

Click here for a complete list of operations.

AddSegment

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 /ChicoCloudWS.asmx HTTP/1.1
Host: chicocloud.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.chicocloud.com/AddSegment"

<?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>
    <AddSegment xmlns="http://www.chicocloud.com/">
      <identity>
        <Community>string</Community>
        <UserName>string</UserName>
        <Password>string</Password>
        <Workstation>string</Workstation>
        <Key>string</Key>
      </identity>
      <flowInfo>
        <Name>string</Name>
        <Hash>string</Hash>
        <FlowType>string</FlowType>
        <ContractNumber>string</ContractNumber>
        <ContractInstanceId>int</ContractInstanceId>
        <ServiceItemNumber>int</ServiceItemNumber>
        <IsResponse>boolean</IsResponse>
        <FlowData>
          <Description>string</Description>
          <Community>string</Community>
          <ServiceName>string</ServiceName>
          <BufferLength>int</BufferLength>
          <Length>int</Length>
          <HashingAlgorithm>SHA1 or SHA256</HashingAlgorithm>
          <TotalNumberOfSegments>int</TotalNumberOfSegments>
          <Note1>string</Note1>
          <Note2>string</Note2>
          <Note3>string</Note3>
          <Note4>string</Note4>
          <Note5>string</Note5>
        </FlowData>
      </flowInfo>
      <segmentNumber>int</segmentNumber>
      <buffer>base64Binary</buffer>
    </AddSegment>
  </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>
    <AddSegmentResponse xmlns="http://www.chicocloud.com/">
      <AddSegmentResult>
        <FlowName>string</FlowName>
        <ContractInstanceId>int</ContractInstanceId>
        <Buffer>base64Binary</Buffer>
        <ServiceName>string</ServiceName>
        <Response>InvalidIdentity or PasswordExpired or NotAllowed_WS or NotAuthorized_Contract or Unknown_Contract or ServiceItemNotInContract or NotAllowed_ServiceItem or FlowTypeMismatch or DuplicateFlowName or InvalidContractInstance or DuplicateServiceItem or DuplicateResponse or Exception or InvalidKey or InvalidFlow or Ok or Error or FlowNotExists or InvalidSegment or SegmentNotAvailable or NotAllowed or DuplicateSegment or DuplicateLogicalFLow or Inactive_Contract or Inactive_Identity or InvalidContractInstanceItem or InvalidAssignedFlow or FlowNotExistsFromAddGetLogicalFlow or FlowAlreadyDownloaded or createdirectoryFailed or FlowIsReadOnly or FlowCompleted or ErrorCreateFile or ErrorReadFile or ErrorWriteFile or ErrorBackupCreateFile or ErrorBackupWriteFile</Response>
      </AddSegmentResult>
    </AddSegmentResponse>
  </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 /ChicoCloudWS.asmx HTTP/1.1
Host: chicocloud.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>
    <AddSegment xmlns="http://www.chicocloud.com/">
      <identity>
        <Community>string</Community>
        <UserName>string</UserName>
        <Password>string</Password>
        <Workstation>string</Workstation>
        <Key>string</Key>
      </identity>
      <flowInfo>
        <Name>string</Name>
        <Hash>string</Hash>
        <FlowType>string</FlowType>
        <ContractNumber>string</ContractNumber>
        <ContractInstanceId>int</ContractInstanceId>
        <ServiceItemNumber>int</ServiceItemNumber>
        <IsResponse>boolean</IsResponse>
        <FlowData>
          <Description>string</Description>
          <Community>string</Community>
          <ServiceName>string</ServiceName>
          <BufferLength>int</BufferLength>
          <Length>int</Length>
          <HashingAlgorithm>SHA1 or SHA256</HashingAlgorithm>
          <TotalNumberOfSegments>int</TotalNumberOfSegments>
          <Note1>string</Note1>
          <Note2>string</Note2>
          <Note3>string</Note3>
          <Note4>string</Note4>
          <Note5>string</Note5>
        </FlowData>
      </flowInfo>
      <segmentNumber>int</segmentNumber>
      <buffer>base64Binary</buffer>
    </AddSegment>
  </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>
    <AddSegmentResponse xmlns="http://www.chicocloud.com/">
      <AddSegmentResult>
        <FlowName>string</FlowName>
        <ContractInstanceId>int</ContractInstanceId>
        <Buffer>base64Binary</Buffer>
        <ServiceName>string</ServiceName>
        <Response>InvalidIdentity or PasswordExpired or NotAllowed_WS or NotAuthorized_Contract or Unknown_Contract or ServiceItemNotInContract or NotAllowed_ServiceItem or FlowTypeMismatch or DuplicateFlowName or InvalidContractInstance or DuplicateServiceItem or DuplicateResponse or Exception or InvalidKey or InvalidFlow or Ok or Error or FlowNotExists or InvalidSegment or SegmentNotAvailable or NotAllowed or DuplicateSegment or DuplicateLogicalFLow or Inactive_Contract or Inactive_Identity or InvalidContractInstanceItem or InvalidAssignedFlow or FlowNotExistsFromAddGetLogicalFlow or FlowAlreadyDownloaded or createdirectoryFailed or FlowIsReadOnly or FlowCompleted or ErrorCreateFile or ErrorReadFile or ErrorWriteFile or ErrorBackupCreateFile or ErrorBackupWriteFile</Response>
      </AddSegmentResult>
    </AddSegmentResponse>
  </soap12:Body>
</soap12:Envelope>