OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

AddRelationshipOrderDetails

Allows one to group a particular item into a inventory relationship group. Note: This can be done for either an order or online order. One should only pass one detail id, the other may stay as zero

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/AddRelationshipOrderDetails"

<?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>
    <AddRelationshipOrderDetails xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OrderDetailID>int</OrderDetailID>
      <OnlineOrderDetailID>int</OnlineOrderDetailID>
      <Relationships>
        <lstRelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
        </lstRelationshipInformationItems>
      </Relationships>
    </AddRelationshipOrderDetails>
  </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>
    <AddRelationshipOrderDetailsResponse xmlns="http://www.securefreedom.com/">
      <AddRelationshipOrderDetailsResult>
        <lstRelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
        </lstRelationshipInformationItems>
      </AddRelationshipOrderDetailsResult>
    </AddRelationshipOrderDetailsResponse>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.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>
    <AddRelationshipOrderDetails xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OrderDetailID>int</OrderDetailID>
      <OnlineOrderDetailID>int</OnlineOrderDetailID>
      <Relationships>
        <lstRelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
        </lstRelationshipInformationItems>
      </Relationships>
    </AddRelationshipOrderDetails>
  </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>
    <AddRelationshipOrderDetailsResponse xmlns="http://www.securefreedom.com/">
      <AddRelationshipOrderDetailsResult>
        <lstRelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
          <RelationshipInformationItems>
            <GroupID>string</GroupID>
            <Description>string</Description>
            <CartDescription>string</CartDescription>
            <Abbreviation>string</Abbreviation>
            <RelationshipTypeID>int</RelationshipTypeID>
            <RelationshipType>string</RelationshipType>
            <MinSelection>int</MinSelection>
            <MaxSelection>int</MaxSelection>
            <lstRelationshipInformationDetails xsi:nil="true" />
          </RelationshipInformationItems>
        </lstRelationshipInformationItems>
      </AddRelationshipOrderDetailsResult>
    </AddRelationshipOrderDetailsResponse>
  </soap12:Body>
</soap12:Envelope>