Sample Requests

A word on Headers

SOAP 1.1 / 1.2 require the "Action" to be passed in as headers.

The Action is built of the namespace and the actual action.
The namespace should be

http://arch.stoneeagle.com/MenuIntegration/IMenuIntegration/

In the samples below, the header in the documentation should match the final path of the action.

In addition to standard headers such as

Content-Type

Which should have a value of text/xml;charset=UTF-8

Conent-Length

You will also need to pass the header SOAPAction with a value matching the operation from the WSDL which should be consistent with the names below for documented samples.

For example, the following "PingArch" action would require a header passed in as
SOAPAction: "http://arch.stoneeagle.com/MenuIntegration/IMenuIntegration/PingArch"

PingArch

This is a good request to start with as it has a very limited payload and can be used to confirm basic credentials are working.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:men="http://arch.stoneeagle.com/MenuIntegration/" xmlns:ns="http://arch.stoneeagle.com/MenuIntegration/2014/08/04">
   <soapenv:Header/>
   <soapenv:Body>
      <men:PingArch>
         <men:Credentials>
            <ns:DealerNumber>XYZ</ns:DealerNumber>
            <ns:EnvironmentName>ABC</ns:EnvironmentName>
            <!--Optional:-->
            <ns:ExternalUsername>someExternalUser</ns:ExternalUsername>
            <ns:Password>hunter123</ns:Password>
            <ns:Username>someUser</ns:Username>
         </men:Credentials>
      </men:PingArch>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <LOG_GUID xmlns="http://arch.stoneeagle.com/MenuIntegration/2014/08/04">0b423c17-36fd-4ee1-b1c4-bd1603a186d0</LOG_GUID>
      <EXECUTION_TIME xmlns="http://arch.stoneeagle.com/MenuIntegration/2014/08/04">9</EXECUTION_TIME>
   </s:Header>
   <s:Body>
      <PingArchResponse xmlns="http://arch.stoneeagle.com/MenuIntegration/">
         <PingArchResult>true</PingArchResult>
      </PingArchResponse>
   </s:Body>
</s:Envelope>

GetRates

Not shown here is using the "Vehicle" node to rate when a VIN does not decode. If rating traditional Auto where the VIN should fully decode, do not provide a vehicle node or it will likely cause issues

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:men="http://arch.stoneeagle.com/MenuIntegration/" xmlns:ns="http://arch.stoneeagle.com/MenuIntegration/2014/08/04">
   <soapenv:Header/>
   <soapenv:Body>
      <men:GetRates>
         <men:Credentials>
            <ns:DealerNumber>XYZ</ns:DealerNumber>
            <ns:EnvironmentName>ABC</ns:EnvironmentName>
            <!--Optional:-->
            <ns:ExternalUsername>someExternalUser</ns:ExternalUsername>
            <ns:Password>hunter123</ns:Password>
            <ns:Username>someUser</ns:Username>
         </men:Credentials>
         <men:RateRequest>
            <ns:FinanceAmount>24000</ns:FinanceAmount>
            <ns:FinanceLength>60</ns:FinanceLength>
            <ns:FinanceType>Purchase</ns:FinanceType>
            <ns:InServiceDate>2020-03-18</ns:InServiceDate>
            <ns:MSRP>2800</ns:MSRP>
            <ns:Odometer>3</ns:Odometer>
            <ns:ProductType>All</ns:ProductType>
            <ns:PurchasePrice>23000</ns:PurchasePrice>
            <ns:PurchaseType>New</ns:PurchaseType>
            <!--<ns:RateDate></ns:RateDate>-->
            <ns:VIN>1FTEW1e48lfa03364</ns:VIN>
            <ns:VehiclePurchaseDate>2020-03-18</ns:VehiclePurchaseDate>
         </men:RateRequest>
      </men:GetRates>
   </soapenv:Body>
</soapenv:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <LOG_GUID xmlns="http://arch.stoneeagle.com/MenuIntegration/2014/08/04">4910b542-1374-49f4-9ff1-3cb3dce69e00</LOG_GUID>
      <EXECUTION_TIME xmlns="http://arch.stoneeagle.com/MenuIntegration/2014/08/04">6731</EXECUTION_TIME>
   </s:Header>
   <s:Body>
      <GetRatesResponse xmlns="http://arch.stoneeagle.com/MenuIntegration/">
         <GetRatesResult xmlns:a="http://arch.stoneeagle.com/MenuIntegration/2014/08/04" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Plans>
              <a:Plan>
                  <a:ClassCode>4</a:ClassCode>
                  <a:ExpireTimeType>FromPurchase</a:ExpireTimeType>
                  <a:InsurerName>Trusty Carrier</a:InsurerName>
                  <a:PlanCode>GRTPLN-BRZ</a:PlanCode>
                  <a:PlanDescription>A great BRONZE plan for you!</a:PlanDescription>
                  <a:PlanId>5634</a:PlanId>
                  <a:PlanName>GreatPlanBronze</a:PlanName>
                  <a:PlanSalesType i:nil="true"/>
                  <a:ProductCode>GRTPRD</a:ProductCode>
                  <a:ProductDescription>A great product for you!</a:ProductDescription>
                  <a:ProductFiles/>
                  <a:ProductId>846</a:ProductId>
                  <a:ProductName>Great Product</a:ProductName>
                  <a:ProductSalesGroupOrder>11.0000</a:ProductSalesGroupOrder>
                  <a:ProductSalesType>Bundle</a:ProductSalesType>
                  <a:ProductSubType>Other</a:ProductSubType>
                  <a:ProductType>Ancillary</a:ProductType>
                  <a:ProgramDescription>A great Program for You!</a:ProgramDescription>
                  <a:ProgramId>62</a:ProgramId>
                  <a:ProgramName>GreatProgram</a:ProgramName>
                  <a:PurchaseType i:nil="true"/>
                  <a:RelatedRates/>
                  <a:SortOrder i:nil="true"/>
                  <a:Terms>
                     <a:Term>
                        <a:ActivationCost i:nil="true"/>
                        <a:BaseContractFound>false</a:BaseContractFound>
                        <a:CalculatedAdjustedCost>99.0000</a:CalculatedAdjustedCost>
                        <a:ClassCode>4</a:ClassCode>
                        <a:ClassDetails>
                           <a:ClassDetail>
                              <a:Description>FORD, F150</a:Description>
                              <a:Type>Make, Model</a:Type>
                           </a:ClassDetail>
                        </a:ClassDetails>
                        <a:DealerCost>99.9900</a:DealerCost>
                        <a:Deductibles/>
                        <a:DefaultDeductible i:nil="true"/>
                        <a:Description>84</a:Description>
                        <a:IsGiveaway>false</a:IsGiveaway>
                        <a:MaxMarkup i:nil="true"/>
                        <a:Miles i:nil="true"/>
                        <a:MinMarkup i:nil="true"/>
                        <a:Months>84</a:Months>
                        <a:RateCode i:nil="true"/>
                        <a:RateFields/>
                        <a:RateId>1404510</a:RateId>
                        <a:RateTermId>0</a:RateTermId>
                        <a:RelatedRateFound>false</a:RelatedRateFound>
                        <a:RenewableCost i:nil="true"/>
                        <a:Services/>
                        <a:SuggestedRetailPrice>99.0000</a:SuggestedRetailPrice>
                        <a:Surcharges>
                           <a:Surcharge>
                              <a:ActivationCost i:nil="true"/>
                              <a:CalculatedCost>20.0000</a:CalculatedCost>
                              <a:Code>TRBO</a:Code>
                              <a:DealerCost>20.0000</a:DealerCost>
                              <a:Description>Turbo</a:Description>
                              <a:Forced>true</a:Forced>
                              <a:IsVisible>true</a:IsVisible>
                              <a:MaxMarkup i:nil="true"/>
                              <a:MinMarkup i:nil="true"/>
                              <a:RenewableCost i:nil="true"/>
                              <a:SuggestedRetailPrice>20.0000</a:SuggestedRetailPrice>
                              <a:SurchargeId>2503</a:SurchargeId>
                           </a:Surcharge>
                           <a:Surcharge>
                              <a:ActivationCost i:nil="true"/>
                              <a:CalculatedCost>100.0000</a:CalculatedCost>
                              <a:Code>Commercial Use</a:Code>
                              <a:DealerCost>100.0000</a:DealerCost>
                              <a:Description>Commercial Use</a:Description>
                              <a:Forced>false</a:Forced>
                              <a:IsVisible>false</a:IsVisible>
                              <a:MaxMarkup i:nil="true"/>
                              <a:MinMarkup i:nil="true"/>
                              <a:RenewableCost i:nil="true"/>
                              <a:SuggestedRetailPrice>100</a:SuggestedRetailPrice>
                              <a:SurchargeId>1944</a:SurchargeId>
                           </a:Surcharge>
                        </a:Surcharges>
                     </a:Term>
                  </a:Terms>
               </a:Plan>
            </a:Plans>
            <a:Vehicle>
               <a:AssetType i:nil="true"/>
               <a:BasicWarranty xmlns:b="http://schemas.datacontract.org/2004/07/ARCHService.Api.DTOs">
                  <b:Miles>36000</b:Miles>
                  <b:Months>36</b:Months>
               </a:BasicWarranty>
               <a:BodyStyle>PICKUP</a:BodyStyle>
               <a:CubicCentimeterDisplacement i:nil="true"/>
               <a:CubicInchDisplacement>214</a:CubicInchDisplacement>
               <a:Cylinders>6</a:Cylinders>
               <a:DriveType>FourByFour</a:DriveType>
               <a:FuelDelivery>Turbo</a:FuelDelivery>
               <a:FuelType>Gasoline</a:FuelType>
               <a:GVWR>0</a:GVWR>
               <a:Horsepower>375</a:Horsepower>
               <a:Liters>3.5</a:Liters>
               <a:Make>FORD</a:Make>
               <a:Model>F150</a:Model>
               <a:NumberOfEngines i:nil="true"/>
               <a:Odometer>3</a:Odometer>
               <a:PowertrainWarranty xmlns:b="http://schemas.datacontract.org/2004/07/ARCHService.Api.DTOs">
                  <b:Miles>60000</b:Miles>
                  <b:Months>60</b:Months>
               </a:PowertrainWarranty>
               <a:RustWarranty xmlns:b="http://schemas.datacontract.org/2004/07/ARCHService.Api.DTOs">
                  <b:Miles>999999</b:Miles>
                  <b:Months>60</b:Months>
               </a:RustWarranty>
               <a:Segmentation i:nil="true"/>
               <a:Series>F150 SUPERCREW</a:Series>
               <a:TonRating>OneHalf</a:TonRating>
               <a:Trim i:nil="true"/>
               <a:VIN>1FTEW1e48lfa03364</a:VIN>
               <a:VehicleType>Truck</a:VehicleType>
               <a:Year>2020</a:Year>
            </a:Vehicle>
            <a:InServieDateInvalid>false</a:InServieDateInvalid>
            <a:InServiceDateMinYear>0</a:InServiceDateMinYear>
            <a:InServiceDateMaxYear>0</a:InServiceDateMaxYear>
         </GetRatesResult>
      </GetRatesResponse>
   </s:Body>
</s:Envelope>

InsertContract

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:men="http://arch.stoneeagle.com/MenuIntegration/" xmlns:ns="http://arch.stoneeagle.com/MenuIntegration/2014/08/04" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <soapenv:Header/>
  <soapenv:Body>
    <men:InsertContract>
      <men:Credentials>
        <ns:DealerNumber>XYZ</ns:DealerNumber>
        <ns:EnvironmentName>ABC</ns:EnvironmentName>
        <ns:Password>hunter123</ns:Password>
        <ns:Username>someUser</ns:Username>
      </men:Credentials>
      <men:Contract>
        <ns:CalculatedDealerCostInArch>false</ns:CalculatedDealerCostInArch>
        <ns:Customer>
          <ns:BusinessName xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
          <ns:EmailAddress xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
          <ns:FirstName>TEST</ns:FirstName>
          <ns:LastName>TEST</ns:LastName>
          <ns:PhysicalAddress>
            <ns:AddressLine1>123 Any St</ns:AddressLine1>
            <ns:AddressLine2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
            <ns:City>Richardson</ns:City>
            <ns:PhoneNumber>5555555555</ns:PhoneNumber>
            <ns:Region>TX</ns:Region>
            <ns:ZipCode>75081</ns:ZipCode>
          </ns:PhysicalAddress>
        </ns:Customer>
        <ns:DealerCost>2095.00</ns:DealerCost>
        <ns:DeductibleAmount>100</ns:DeductibleAmount>
        <ns:DeductibleCode>100DED</ns:DeductibleCode>
        <ns:Fields>
          <!--<arr:KeyValueOfstringstring><arr:Key></arr:Key><arr:Value></arr:Value></arr:KeyValueOfstringstring>-->
        </ns:Fields>
        <ns:FinanceAmount>48498.66</ns:FinanceAmount>
        <ns:FinanceLength>1</ns:FinanceLength>
        <ns:FinanceType>Cash</ns:FinanceType>
        <ns:InServiceDate>2015-05-01T00:00:00-05:00</ns:InServiceDate>
        <ns:MSRP>52450</ns:MSRP>
        <ns:Odometer>53879</ns:Odometer>
        <ns:PurchasePrice>3995</ns:PurchasePrice>
        <ns:PurchaseType>Used</ns:PurchaseType>
        <ns:RateDate>2020-05-01T13:21:19-05:00</ns:RateDate>
        <ns:RateId>61895</ns:RateId>
        <ns:ReducingDeductibleAmount xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
        <ns:SurchargeCodes>
          <!--<arr:string></arr:string>-->
        </ns:SurchargeCodes>
        <ns:VIN>JTHBK1GGXE2104891</ns:VIN>
        <ns:VehiclePurchaseDate>2020-04-30T00:00:00-05:00</ns:VehiclePurchaseDate>
        <ns:VehiclePurchasePrice>50549.99</ns:VehiclePurchasePrice>
      </men:Contract>
    </men:InsertContract>
  </soapenv:Body>
</soapenv:Envelope>

05 Samples

Sample Requests#

A word on Headers#

PingArch#

Request#

Response#

GetRates#

Request#

Response#

InsertContract#

Sample Requests

A word on Headers

PingArch

Request

Response

GetRates

Request

Response

InsertContract