iSAMS Gift Registry API Web Service

iSAMS Gift Registry API

Click here for a complete list of operations.

RetrieveSet

Retrieves a set of gift registries using the supplied gift registry IDs.

Test

The test form is only available for methods with primitive types as parameters.

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 /global/api/GiftRegistry.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/RetrieveSet"

<?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>
    <RetrieveSet xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <registryIDs>
        <int>int</int>
        <int>int</int>
      </registryIDs>
    </RetrieveSet>
  </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>
    <RetrieveSetResponse xmlns="http://www.estaronline.com/api/">
      <RetrieveSetResult>
        <Data>
          <Registry>
            <ID>int</ID>
            <Guid>guid</Guid>
            <ExternalIdentifier>string</ExternalIdentifier>
            <Active>boolean</Active>
            <Website>int</Website>
            <DateCreated>dateTime</DateCreated>
            <CustomerID>int</CustomerID>
            <CustomerForeignIdentity>string</CustomerForeignIdentity>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Email>string</Email>
            <Phone>string</Phone>
            <Occasion>string</Occasion>
            <EventDate>dateTime</EventDate>
            <DeliveryDate>dateTime</DeliveryDate>
            <Title>string</Title>
            <Detail>string</Detail>
            <InvitationInserts>int</InvitationInserts>
            <ExchangeCards>boolean</ExchangeCards>
            <Store>string</Store>
            <CoRegistrant xsi:nil="true" />
            <Address xsi:nil="true" />
            <RegistryItems xsi:nil="true" />
            <Attributes xsi:nil="true" />
          </Registry>
          <Registry>
            <ID>int</ID>
            <Guid>guid</Guid>
            <ExternalIdentifier>string</ExternalIdentifier>
            <Active>boolean</Active>
            <Website>int</Website>
            <DateCreated>dateTime</DateCreated>
            <CustomerID>int</CustomerID>
            <CustomerForeignIdentity>string</CustomerForeignIdentity>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Email>string</Email>
            <Phone>string</Phone>
            <Occasion>string</Occasion>
            <EventDate>dateTime</EventDate>
            <DeliveryDate>dateTime</DeliveryDate>
            <Title>string</Title>
            <Detail>string</Detail>
            <InvitationInserts>int</InvitationInserts>
            <ExchangeCards>boolean</ExchangeCards>
            <Store>string</Store>
            <CoRegistrant xsi:nil="true" />
            <Address xsi:nil="true" />
            <RegistryItems xsi:nil="true" />
            <Attributes xsi:nil="true" />
          </Registry>
        </Data>
      </RetrieveSetResult>
    </RetrieveSetResponse>
  </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 /global/api/GiftRegistry.asmx HTTP/1.1
Host: demo.viare.io
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>
    <RetrieveSet xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <registryIDs>
        <int>int</int>
        <int>int</int>
      </registryIDs>
    </RetrieveSet>
  </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>
    <RetrieveSetResponse xmlns="http://www.estaronline.com/api/">
      <RetrieveSetResult>
        <Data>
          <Registry>
            <ID>int</ID>
            <Guid>guid</Guid>
            <ExternalIdentifier>string</ExternalIdentifier>
            <Active>boolean</Active>
            <Website>int</Website>
            <DateCreated>dateTime</DateCreated>
            <CustomerID>int</CustomerID>
            <CustomerForeignIdentity>string</CustomerForeignIdentity>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Email>string</Email>
            <Phone>string</Phone>
            <Occasion>string</Occasion>
            <EventDate>dateTime</EventDate>
            <DeliveryDate>dateTime</DeliveryDate>
            <Title>string</Title>
            <Detail>string</Detail>
            <InvitationInserts>int</InvitationInserts>
            <ExchangeCards>boolean</ExchangeCards>
            <Store>string</Store>
            <CoRegistrant xsi:nil="true" />
            <Address xsi:nil="true" />
            <RegistryItems xsi:nil="true" />
            <Attributes xsi:nil="true" />
          </Registry>
          <Registry>
            <ID>int</ID>
            <Guid>guid</Guid>
            <ExternalIdentifier>string</ExternalIdentifier>
            <Active>boolean</Active>
            <Website>int</Website>
            <DateCreated>dateTime</DateCreated>
            <CustomerID>int</CustomerID>
            <CustomerForeignIdentity>string</CustomerForeignIdentity>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Email>string</Email>
            <Phone>string</Phone>
            <Occasion>string</Occasion>
            <EventDate>dateTime</EventDate>
            <DeliveryDate>dateTime</DeliveryDate>
            <Title>string</Title>
            <Detail>string</Detail>
            <InvitationInserts>int</InvitationInserts>
            <ExchangeCards>boolean</ExchangeCards>
            <Store>string</Store>
            <CoRegistrant xsi:nil="true" />
            <Address xsi:nil="true" />
            <RegistryItems xsi:nil="true" />
            <Attributes xsi:nil="true" />
          </Registry>
        </Data>
      </RetrieveSetResult>
    </RetrieveSetResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /global/api/GiftRegistry.asmx/RetrieveSet?authenticationToken=string&registryIDs=string&registryIDs=string HTTP/1.1
Host: demo.viare.io

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

<?xml version="1.0" encoding="utf-8"?>
<GiftRegistryApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Registry>
      <ID>int</ID>
      <Guid>guid</Guid>
      <ExternalIdentifier>string</ExternalIdentifier>
      <Active>boolean</Active>
      <Website>int</Website>
      <DateCreated>dateTime</DateCreated>
      <CustomerID>int</CustomerID>
      <CustomerForeignIdentity>string</CustomerForeignIdentity>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Email>string</Email>
      <Phone>string</Phone>
      <Occasion>string</Occasion>
      <EventDate>dateTime</EventDate>
      <DeliveryDate>dateTime</DeliveryDate>
      <Title>string</Title>
      <Detail>string</Detail>
      <InvitationInserts>int</InvitationInserts>
      <ExchangeCards>boolean</ExchangeCards>
      <Store>string</Store>
      <CoRegistrant>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Email>string</Email>
      </CoRegistrant>
      <Address>
        <Company>string</Company>
        <StreetAddress>string</StreetAddress>
        <StreetAddress2>string</StreetAddress2>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <Country>string</Country>
        <ContactPhoneNumber>string</ContactPhoneNumber>
      </Address>
      <RegistryItems>
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RegistryItems>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
    </Registry>
    <Registry>
      <ID>int</ID>
      <Guid>guid</Guid>
      <ExternalIdentifier>string</ExternalIdentifier>
      <Active>boolean</Active>
      <Website>int</Website>
      <DateCreated>dateTime</DateCreated>
      <CustomerID>int</CustomerID>
      <CustomerForeignIdentity>string</CustomerForeignIdentity>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Email>string</Email>
      <Phone>string</Phone>
      <Occasion>string</Occasion>
      <EventDate>dateTime</EventDate>
      <DeliveryDate>dateTime</DeliveryDate>
      <Title>string</Title>
      <Detail>string</Detail>
      <InvitationInserts>int</InvitationInserts>
      <ExchangeCards>boolean</ExchangeCards>
      <Store>string</Store>
      <CoRegistrant>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Email>string</Email>
      </CoRegistrant>
      <Address>
        <Company>string</Company>
        <StreetAddress>string</StreetAddress>
        <StreetAddress2>string</StreetAddress2>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <Country>string</Country>
        <ContactPhoneNumber>string</ContactPhoneNumber>
      </Address>
      <RegistryItems>
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RegistryItems>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
    </Registry>
  </Data>
</GiftRegistryApiResponse>

HTTP POST

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

POST /global/api/GiftRegistry.asmx/RetrieveSet HTTP/1.1
Host: demo.viare.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authenticationToken=string&registryIDs=string&registryIDs=string

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

<?xml version="1.0" encoding="utf-8"?>
<GiftRegistryApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Registry>
      <ID>int</ID>
      <Guid>guid</Guid>
      <ExternalIdentifier>string</ExternalIdentifier>
      <Active>boolean</Active>
      <Website>int</Website>
      <DateCreated>dateTime</DateCreated>
      <CustomerID>int</CustomerID>
      <CustomerForeignIdentity>string</CustomerForeignIdentity>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Email>string</Email>
      <Phone>string</Phone>
      <Occasion>string</Occasion>
      <EventDate>dateTime</EventDate>
      <DeliveryDate>dateTime</DeliveryDate>
      <Title>string</Title>
      <Detail>string</Detail>
      <InvitationInserts>int</InvitationInserts>
      <ExchangeCards>boolean</ExchangeCards>
      <Store>string</Store>
      <CoRegistrant>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Email>string</Email>
      </CoRegistrant>
      <Address>
        <Company>string</Company>
        <StreetAddress>string</StreetAddress>
        <StreetAddress2>string</StreetAddress2>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <Country>string</Country>
        <ContactPhoneNumber>string</ContactPhoneNumber>
      </Address>
      <RegistryItems>
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RegistryItems>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
    </Registry>
    <Registry>
      <ID>int</ID>
      <Guid>guid</Guid>
      <ExternalIdentifier>string</ExternalIdentifier>
      <Active>boolean</Active>
      <Website>int</Website>
      <DateCreated>dateTime</DateCreated>
      <CustomerID>int</CustomerID>
      <CustomerForeignIdentity>string</CustomerForeignIdentity>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Email>string</Email>
      <Phone>string</Phone>
      <Occasion>string</Occasion>
      <EventDate>dateTime</EventDate>
      <DeliveryDate>dateTime</DeliveryDate>
      <Title>string</Title>
      <Detail>string</Detail>
      <InvitationInserts>int</InvitationInserts>
      <ExchangeCards>boolean</ExchangeCards>
      <Store>string</Store>
      <CoRegistrant>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Email>string</Email>
      </CoRegistrant>
      <Address>
        <Company>string</Company>
        <StreetAddress>string</StreetAddress>
        <StreetAddress2>string</StreetAddress2>
        <Suburb>string</Suburb>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
        <Country>string</Country>
        <ContactPhoneNumber>string</ContactPhoneNumber>
      </Address>
      <RegistryItems>
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RegistryItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RegistryItems>
      <Attributes>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Attributes>
    </Registry>
  </Data>
</GiftRegistryApiResponse>