HCL Commerce Enterprise

URL ContractExport

Este URL exporta un contrato a un archivo XML.

El archivo se genera debajo del directorio WC_instance_name/xml/trading.

Estructura de URL

http:// host_name/path/
El nombre completo de Transaction server y la vía de acceso de configuración.

Valores de parámetros

contractId
Se necesita: ID del contrato que desea exportar, tal como se ha encontrado en la tabla de base de datos CONTRACT.
fileName
Se necesita: Nombre que desea que tenga el archivo XML del contrato. Si no especifica el nombre de vía de acceso completa para el archivo XML, el archivo XML se grabará en el directorio WC_eardir/xml/trading/xml.
langId
Se necesita: Utilice este parámetro para especificar el idioma de las descripciones en el contrato que desea exportar. Las descripciones en idiomas que no sean el idioma especificado por este parámetro no se exportarán al archivo XML generado.
xsdName
Se necesita: El nombre del archivo XSD que se utilizará para el elemento raíz.
xmlFileEncoding
Utilice este parámetro para especificar la codificación del archivo XML generado. Si no especifica esta opción, el archivo XML generado se codificará utilizando la codificación UTF-8. Para obtener una lista de todas las codificaciones internacionales soportadas que pueden especificarse con este parámetro, consulte el tema relacionado que aparece más abajo.
all
Especifica si se han de incluir o no todos los números de referencia y las indicaciones de fecha y hora al exportar el contrato. Los valores válidos para este parámetro son true y false. Utilice true para incluir todos los números de referencia y las indicaciones de fecha y hora. Utilice false para omitir todos los números de referencia y las indicaciones de fecha y hora.

Si este parámetro no se especifica, se presupone el valor true.

URL
Se necesita: la URL al que se debe llamar cuando el mandato se completa satisfactoriamente.

Ejemplo

El ejemplo siguiente exporta el ID de contrato 260369 a un archivo XML codificado en UTF-8 denominado contract260369.xml del directorio predeterminado:


https://myhostname/webapp/wcs/stores/servlet/ContractExport?
contractId=260369&fileName=contract260369.xml&langId=-1&xsdName=Package.xsd
&URL=StoreCatalogDisplay?storeId=512&catalogId=512

Comportamiento

Este URL crea un archivo XML a partir de la información en la base de datos de HCL Commerce para el número de contrato especificado.

Condiciones de excepción

  • Se generará _ERR_CONTRACT_OBJECT_NOT_FOUND si no se encuentra un contrato con el ID de contrato especificado en la base de datos de HCL Commerce.
  • Se generará una excepción _ERR_UNSUPPORTED_ENCODING si el valor especificado para el parámetro xmlFileEncoding no está soportado.
  • Se generará una excepción _ERR_WRONG_CONTRACT_STATE si el estado del contrato es DeploymentInProgress o DeploymentFailed.