Sobre arquivos XML de entrada para APIs

As APIs recuperam dados usando arquivos XML de entrada que definem quais registros precisam ser selecionados ou usados. Ao estender o banco de dados para incluir campos adicionais, também é necessário estender o XML de entrada para preencher esses campos.

CUIDADO:
Não transmita um elemento em branco (um elemento contendo todos os atributos com valores em branco) para uma API. Além disso, não transmita os atributos que possuem espaços iniciais ou finais. O resultado de qualquer situação não é previsível.

O exemplo a seguir mostra uma modificação de XML de entrada.

Exemplo de modificação de XML de entrada

O exemplo a seguir modifica o arquivo XML de entrada para a API YFS_createOrder():

<Orders AuthenticationKey="">
   <Order EnterpriseCode="DEFAULT" OrderNo="DB04"
OrderName="DB04" OrderDate="20010803" OrderType="Phone" PriorityCode="1"
PriorityNumber="1" ReqDeliveryDate="20010810" ReqCancelDate="" 
ReqShipDate="20010810" SCAC="FEDEX" CarrierServiceCode="Express Saver Pak" 
CarrierAccountNo="112255" NotifyAfterShipmentFlag="N" 
NotificationType="FAX" NotificationReference="" ShipCompleteFlag="N"
EnteredBy="Iain " ChargeActualFreightFlag="Y" AORFlag="Y" 
SearchCriteria1="Search" SearchCriteria2="Search Again" >
      <OrderLines>
         <OrderLine PrimeLineNo="1" SubLineNo="1"
OrderedQty="1" ReqDeliveryDate="20010810" ReqCancelDate="20010810"
ReqShipDate="20010810" SCAC="FEDEX" CarrierServiceCode="Express
Saver Pak" PickableFlag="Y" HoldFlag="N" CustomerPONo="11" >
            <Extn ExtnAcmeLineType="Type1"/>
            <Item ItemID="ITEM1" ProductClass="A" ItemWeight="1" 
ItemDesc="paintball gun" ItemShortDesc="pball gun"
UnitOfMeasure="EACH" CustomerItem="Spectra Flex" CustomerItemDesc="GEGRG"
SupplierItem="Spectra Flex @ supplier" SupplierItemDesc="Spectra
Flex Desc @ supplier" UnitCost="15.99"  CountryOfOrigin="CA"/>
            <PersonInfoShipTo Title="Mr" FirstName="Quigley"
MiddleName="Al" LastName="Johns" Company="Company" JobTitle="Project
Clert" AddressLine1="Address Line 1 -3 Main Street" AddressLine2="ShipTo
Address line 2" AddressLine3="ShipTo Address line 3" AddressLine4="ShipTo
Address line 4" AddressLine5="ShipTo Address line 5" AddressLine6="ShipTo
Address line 6" City="Acton" State="MA" ZipCode="01720" Country="US"
DayPhone="978-635-9242" EveningPhone="978-635-9252" MobilePhone="978-888-8888"
Beeper="" OtherPhone="other555-5555" DayFaxNo="" EveningFaxNo=""
EMailID="jquigley@maine.com" AlternateEmailID="hfournier@ontario.com"
ShipToID=""/>
         </OrderLine>
         <NumberOfOrderLines/>
      </OrderLines>
      <PersonInfoShipTo Title="MR" FirstName="s"
MiddleName="X" LastName="T" Suffix="T" Department="T" Company="SD"
JobTitle="SS" AddressLine1="SS" AddressLine2="SS" AddressLine3="SS"
AddressLine4="SS" AddressLine5="SS" AddressLine6="SS" City="REDWOOD"
State="CA" ZipCode="01852" Country="USA" DayPhone="3456789234" 
EveningPhone="3456789234" MobilePhone=""  EveningFaxNo="SS" />
       <PersonInfoBillTo Title="mj" FirstName="m"
MiddleName="JJ" LastName="KK" Suffix="lll" Department="l" Company="kj"
JobTitle="k" AddressLine1="HJHKK" AddressLine2="HJKHK" AddressLine3="HKHJ" 
AddressLine4="" AddressLine5="" AddressLine6="" City="UUU" State="IUI" 
ZipCode="78787" Country="USA"  />
  </Order>
  <NumberOfOrders/> 
</Orders>
Importante: Para que os scripts de configuração de fábrica operem corretamente, ao incluir uma coluna em uma tabela de banco de dados, certifique-se de que a coluna não seja nula e que tenha um valor padrão. Se precisar tornar a coluna anulável, o valor padrão não deverá estar presente.

Além disso, quando estiver especificando Nome XML e Grupo XML, mantenha em mente que os valores devem ser sequências de Modelo de Objeto de Documento (DOM) válidas. (Os valores não devem conter espaços ou caracteres especiais que não são suportados pela especificação DOM.)

O arquivo XML de exemplo a seguir inclui uma coluna na tabela YFS_ORDER_LINE:

<?xml version="1.0" encoding="UTF-8" ?> 
<DBSchema>
 <Entities>
  <Entity TableName="YFS_ORDER_LINE">
   <Attributes> 
    <Attribute ColumnName="EXTN_ACME_LINE_TYPE" DecimalDigits="" 
Default Value="' '" Size="10" Type="CHAR" XMLGroup="Extn" 
XMLName="ExtnAcmeLineType"/> 
   </Attributes> 
  </Entity> 
 </Entities> 
</DBSchema>