PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addResupplyNotificationOrders

This function adds a Sales Order and Purchase Order from a resupply notification and returns the POMajor.

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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/addResupplyNotificationOrders"

<?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>
    <addResupplyNotificationOrders xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Notification>
        <NotificationID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </NotificationID>
        <ShipToName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToName>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <ShipToAddress1>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToAddress1>
        <ShipToAddress2>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToAddress2>
        <ShipToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToCity>
        <ShipToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToState>
        <ShipToZipCode>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToZipCode>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Vendor>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Vendor>
        <ShipFromDealerStock>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ShipFromDealerStock>
        <Details>
          <ResupplyNotificationDetail>
            <Equipment xsi:nil="true" />
            <Item xsi:nil="true" />
            <UOM xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <UnitPrice xsi:nil="true" />
            <Description xsi:nil="true" />
          </ResupplyNotificationDetail>
          <ResupplyNotificationDetail>
            <Equipment xsi:nil="true" />
            <Item xsi:nil="true" />
            <UOM xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <UnitPrice xsi:nil="true" />
            <Description xsi:nil="true" />
          </ResupplyNotificationDetail>
        </Details>
      </Notification>
    </addResupplyNotificationOrders>
  </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>
    <addResupplyNotificationOrdersResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addResupplyNotificationOrdersResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addResupplyNotificationOrdersResult>
    </addResupplyNotificationOrdersResponse>
  </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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.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>
    <addResupplyNotificationOrders xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Notification>
        <NotificationID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </NotificationID>
        <ShipToName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToName>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <ShipToAddress1>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToAddress1>
        <ShipToAddress2>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToAddress2>
        <ShipToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToCity>
        <ShipToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToState>
        <ShipToZipCode>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToZipCode>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Vendor>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Vendor>
        <ShipFromDealerStock>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ShipFromDealerStock>
        <Details>
          <ResupplyNotificationDetail>
            <Equipment xsi:nil="true" />
            <Item xsi:nil="true" />
            <UOM xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <UnitPrice xsi:nil="true" />
            <Description xsi:nil="true" />
          </ResupplyNotificationDetail>
          <ResupplyNotificationDetail>
            <Equipment xsi:nil="true" />
            <Item xsi:nil="true" />
            <UOM xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <UnitPrice xsi:nil="true" />
            <Description xsi:nil="true" />
          </ResupplyNotificationDetail>
        </Details>
      </Notification>
    </addResupplyNotificationOrders>
  </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>
    <addResupplyNotificationOrdersResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addResupplyNotificationOrdersResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addResupplyNotificationOrdersResult>
    </addResupplyNotificationOrdersResponse>
  </soap12:Body>
</soap12:Envelope>