Waiting for engine...
Skip to main content

Trading Partner Component object

The Trading Partner Component object allows users to retrieve, query, create, update, and delete Trading Partner components through the Boomi Enterprise Platform API.

note

Due to the large number of fields and options for this object, Boomi recommends that you use the Boomi Enterprise Platform and Partner API connectors to create Trading Partner components through the API. For detailed information about the fields, see the Trading Partner component information or the help provided for the Trading Partner component within the user interface.

Structure​

This structure example is for a Trading Partner classification="tradingpartner". For an operation on a My Company Trading Partner, set the classification to classification="mycompany" , replace any <AS2SendSettings> tags with corresponding <AS2ReceiveSettings> tags, and if the tag <PartnerDocumentTypes is not applicable, omit the tag.

The root element’s deleted attribute is unique to deleted Trading Partner components. When the attribute is present, its value is true.

The organizationId field value is the ID of an Organization component, which is reusable across multiple Trading Partners, API Services, and API Proxies. The Organization component structure is identical to that of the ContactInformation fields in the Trading Partner component.

The valid values for the CommunicationSetting field are component (Communication Channel component), custom (custom settings), and default (default settings for the My Company trading partner with which this trading partner is paired on a Start or Trading Partner shape). If the CommunicationSetting field value is component, the CommunicationChannel field value specifies the Communication Channel component ID. A CommunicationSetting field value of custom or default corresponds to a null CommunicationChannel field value.

The AS2 message option field maxDocumentCount is type int(eger), and the field’s range of valid values is 1–20. The value is meaningful only if the multipleAttachments field value is true.

note

Although the description field is in the object, operations does not support the field. It ignores the field if it is present in a QUERY, CREATE, or UPDATE request.

<TradingPartnerComponent xmlns:ns1="http://api.platform.boomi.com/" classification="" standard="" identifier="" componentName="" componentId="" organizationId="" folderName="" folderId="" deleted="" branchId="" branchName="">
   <ContactInfo>
      <contactName/>
      <address1/>
      <address2/>
      <city/>
      <state/>
      <postalcode/>
      <country/>
      <email/>
      <phone/>
      <fax/>
   </ContactInfo>
   <PartnerInfo>
   See specific structure examples for EDIFACT, HL7, RosettaNet, Tradacoms, EDI, and X12 standards. The related sample should be pasted here.
   </PartnerInfo>
   <PartnerCommunication>
      <AS2CommunicationOptions CommunicationSetting="">
         <SharedCommunicationChannel componentId="">         
         <AS2SendSettings useDefaultSettings="" authenticationType="">
            <url/>
            <sslCertificate componentId="" alias="">
               <certificate/>
            </sslCertificate>
            <clientSSLCertificate componentId="" alias="" passPhrase="">
               <certificate/>
            </clientSSLCertificate>
            <AuthSettings user="" password=""/> 
            <verifyHostname/>
         </AS2SendSettings>
         <AS2SendOptions>
            <AS2PartnerInfo>
               <as2Id/>
               <signingPublicCertificate componentId="" alias="">
                  <certificate/>
               </signingPublicCertificate>
               <encryptionPublicCertificate componentId="" alias="">
                  <certificate/>
               </encryptionPublicCertificate>
               <mdnSignaturePublicCertificate componentId="" alias="">
                  <certificate/>
               </mdnSignaturePublicCertificate>
               <clientSSLCertificate componentId="" alias="">
                  <certificate/>
               </clientSSLCertificate>
               <basicAuthEnabled/>
               <rejectDuplicateMessages/>
               <messagesToCheckForDuplicates/>
               <ListenAuthSettings user="" password=""/>
               <ListenAttachmentSettings multipleAttachments="" attachmentCache="">
                  <attachmentContentType></attachmentContentType>
               </ListenAttachmentSettings>
            </AS2PartnerInfo>
            <AS2MessageOptions encryptionAlgorithm="" dataContentType="" signingDigestAlg="" signed="" encrypted="" compressed="" multipleAttachments="" maxDocumentCount="">
               <subject/>
            </AS2MessageOptions>
            <AS2MDNOptions requestMDN="" synchronous="" signed="" useSSL="" mdnDigestAlg="" useExternalURL="">
               <externalURL></externalURL>
            </AS2MDNOptions>
         </AS2SendOptions>
         <AS2ReceiveOptions>
            <AS2MyCompanyInfo>
               <as2Id></as2Id>
               <enabledLegacySMIME></enabledLegacySMIME>
               <enabledFoldedHeaders></enabledFoldedHeaders>
            </AS2MyCompanyInfo>
         </AS2ReceiveOptions>
      </AS2CommunicationOptions>
      <DiskCommunicationOptions CommunicationSetting="">
        <SharedCommunicationChannel componentId="">         
        <DiskGetOptions useDefaultGetOptions="" deleteAfterRead="" maxFileCount="" filterMatchType="">
            <fileFilter/>
            <getDirectory/>
         </DiskGetOptions>
         <DiskSendOptions useDefaultSendOptions="" createDirectory="" writeOption="">
            <sendDirectory/>
         </DiskSendOptions> 
      </DiskCommunicationOptions>
      <FTPCommunicationOptions CommunicationSetting="">
         <SharedCommunicationChannel componentId="">         
         <FTPSettings useDefaultSettings="" connectionMode="">
            <host/>
            <port/>
            <user/>
            <password/>
            <FTPSSLOptions useClientAuthentication="" sslmode="">
               <clientSSLCertificate alias="" passPhrase="">
                  <certificate/>
               </clientSSLCertificate>
            </FTPSSLOptions>
         </FTPSettings>
         <FTPGetOptions useDefaultGetOptions="" ftpAction="" transferType="">
            <remoteDirectory></remoteDirectory>
            <fileToMove/>
            <maxFileCount/>
         </FTPGetOptions>
         <FTPSendOptions useDefaultSendOptions="" ftpAction="" transferType="">
            <remoteDirectory/>
            <moveToDirectory/>
         </FTPSendOptions>
      </FTPCommunicationOptions>

      <SFTPCommunicationOptions CommunicationSetting="">
         <SharedCommunicationChannel componentId="">         
         <SFTPSettings useDefaultSettings="">
            <host/>
            <port/>
            <user/>
            <password/>
            <SFTPSSHOptions sshkeyauth="">
               <sshkeypath/>
               <sshkeypassword/>
            </SFTPSSHOptions>
         </SFTPSettings>
         <SFTPGetOptions useDefaultGetOptions="" ftpAction="">
            <remoteDirectory/>
            <fileToMove/>
            <maxFileCount/>
         </SFTPGetOptions>
         <SFTPSendOptions useDefaultSendOptions="" ftpAction="">
            <remoteDirectory/>
            <moveToDirectory/>
         </SFTPSendOptions>
      </SFTPCommunicationOptions>
      <MLLPCommunicationOptions>
         <MLLPSendSettings>
            <host/>
            <port/>
            <sendTimeout/>
            <receiveTimeout/>
            <maxRetry/>
            <failOnTimeout/>
            <usePersistentConnections maxPoolSize="" expireTimeout=""/>
            <useTrustedSSLCertificate trustSSLServerCertificate=""/>
            <useClientSSLAuthorization clientSSLCertificate=""/>
         </MLLPSendSettings>
      </MLLPCommunicationOptions>
   </PartnerCommunication>
   <PartnerDocumentTypes>
   See specific structure examples for EDIFACT, HL7, RosettaNet, Tradacoms, and X12 document types. The related sample should be pasted here.
   </PartnerDocumentTypes>
</TradingPartnerComponent>

EDIFACT partner information​


      <EdifactPartnerInfo>
        <EdifactOptions filteracknowledgements="" acknowledgementoption="" envelopeoption="" rejectDuplicateUNB="" includeUNA="" outboundInterchangeValidation="" outboundValidationOption="">
           <elementDelimiter delimiterValue=""/>
           <segmentTerminator segmentTerminatorValue="" segmentTerminatorSpecial=""/>
           <compositeDelimiter delimiterValue="" delimiterSpecial=""/>
        </EdifactOptions>
        <EdifactControlInfo>
           <UNBControlInfo interchangeIdQual="" interchangeId="" interchangeAddress="" interchangeSubAddress="" syntaxId="" syntaxVersion="" priority="" referencePassword="" referencePasswordQualifier="" appReference="" ackRequest="" commAgreement="" testIndicator=""/>
           <UNGControlInfo useFunctionalGroups="" applicationIdQual="" applicationId=""/>
           <UNHControlInfo version="" release="" controllingAgency="" assocAssignedCode="" commonAccessRef=""/>
        </EdifactControlInfo>
     </EdifactPartnerInfo>

note

The valid outboundValidationOption field values are filterError and failAll. The default is filterError.

HL7 partner information​


       <HL7PartnerInfo>
         <HL7Options filteracknowledgements="" rejectDuplicates="" acceptackoption="" appackoption="" batchoption="" outboundInterchangeValidation="" outboundValidationOption="">
            <segmentTerminator segmentTerminatorValue=""/>
            <elementDelimiter delimiterValue="" delimiterSpecial=""/>
            <compositeDelimiter delimiterValue=""/>
            <subCompositeDelimiter delimiterValue="" delimiterSpecial=""/>
         </HL7Options>
         <HL7ControlInfo>
            <MSHControlInfo>
               <Application namespaceId="" universalId="" universalIdType=""/>
               <Facility namespaceId="" universalId="" universalIdType=""/>
               <NetworkAddress namespaceId="" universalId="" universalIdType=""/>
               <ProcessingId processingId="" processingMode=""/>
            </MSHControlInfo>
         </HL7ControlInfo>
      </HL7PartnerInfo>

note

The valid outboundValidationOption field values are filterError and failAll. The default is filterError.

Odette partner information​


<OdettePartnerInfo>
    <OdetteOptions filteracknowledgements="" acknowledgementoption="" envelopeoption="" rejectDuplicateUNB="" includeUNA="" outboundInterchangeValidation="" outboundValidationOption="">
       <elementDelimiter delimiterValue="" />
       <segmentTerminator segmentTerminatorValue="" />
       <compositeDelimiter delimiterValue="" />
    </OdetteOptions>
    <OdetteControlInfo>
       <OdetteUNBControlInfo interchangeIdQual="" syntaxId="" syntaxVersion="" priority="" referencePasswordQualifier="" ackRequest="" testIndicator="" />
       <OdetteUNHControlInfo version="" release="" controllingAgency="" />
    </OdetteControlInfo>
</OdettePartnerInfo>

RosettaNet partner information​


<RosettaNetPartnerInfo>
    <RosettaNetOptions version="" filterSignals="" rejectDuplicateTransactions="" outboundDocumentValidation=""/> 
    <RosettaNetControlInfo partnerId="" partnerIdType="" partnerLocation="" globalPartnerClassificationCode="" globalUsageCode="" supplyChainCode="">
       <encryptionPublicCertificate componentId="" alias="">
          <certificate/>
       </encryptionPublicCertificate>
       <signingPublicCertificate/></signingPublicCertificate>
    </RosettaNetControlInfo>
    <RosettaNetMessageOptions compressed="" signed="" signatureDigestAlgorithm="" encrypted="" encryptServiceHeader="" encryptionAlgorithm="" contentTransferEncoding="" attachmentCache=""/>
</RosettaNetPartnerInfo>

note

The valid contentTransferEncoding field values are binary and base64. The default is binary.

Tradacoms partner information​

 <TradacomsPartnerInfo>
    <TradacomsOptions useReconcilationMessage="" filterAcknowledgements="">
       <elementDelimiter delimiterValue=""/>
       <segmentTerminator segmentTerminatorValue=""/>
       <compositeDelimiter delimiterValue=""/>
    </TradacomsOptions>  
    <TradacomsControlInfo>
       <STXControlInfo interchangeId="" interchangeIdQualifier=""/>
    </TradacomsControlInfo>
</TradacomsPartnerInfo>

X12 partner information​


   <X12PartnerInfo>
      <X12PartnerInfo>
         <X12Options filteracknowledgements="" acknowledgementoption="" envelopeoption="" rejectDuplicateInterchange="" outboundInterchangeValidation="" outboundValidationOption="">
            <elementDelimiter delimiterValue="" delimiterSpecial=""/>
            <segmentTerminator segmentTerminatorValue="" segmentTerminatorSpecial=""/>
         </X12Options>
      <X12ControlInfo>
        <ISAControlInfo interchangeIdQualifier="" securityInformationQualifier="" authorizationInformationQualifier="" componentElementSeparator="" ackrequested="" version="" interchangeId="" securityInformation="" authorizationInformation="" standardIdentification="" testindicator=""/>
        <GSControlInfo respagencycode="" applicationcode="" gsVersion=""/>	
      </X12ControlInfo>
    </X12PartnerInfo>
note

The valid outboundValidationOption field values are filterError and failAll. The default is filterError.

EDI Custom partner information​

  <CustomPartnerInfo customStandardId="">
      <CustomOptions outboundMessageValidation="" rejectDuplicateMessage=""></CustomOptions>
      <CustomControlInfo messageId="" messageIdQual=""></CustomControlInfo>
  </CustomPartnerInfo>

EDIFACT partner document types​

<PartnerDocumentType typeId="" profileId="" expectAckForOutbound="" validateOutboundTransactionSets="" invalidDocumentRouting="" qualifierValidation=""/>
note

The valid invalidDocumentRouting field values are documentsPath and errorsPath. The default is errorsPath.

HL7 partner document types​

<PartnerDocumentType typeId="" profileId="" expectAckForOutbound="" validateOutboundTransactionSets="" qualifierValidaton=""/>

Odette partner document types​

<PartnerDocumentType typeId="" expectAckForOutbound="" validateOutboundTransactionSets="" invalidDocumentRouting="" qualifierValidation="" />

RosettaNet partner document types​

<PartnerDocumentType typeId="" profileId="" expectAckForOutbound="" validateOutboundTransactionSets=""/>

The typeId value corresponds to the docTypeSystemId attribute value in a RosettaNet document type XML schema. When you import a RosettaNet document type XML schema into an XML profile component in , the docTypeSystemId value appears in the Document Type System ID field on the profile’s Options tab.

Tradacoms partner document types​

<PartnerDocumentType typeId="" profileId=""/>

X12 partner document types​

<PartnerDocumentType typeId="" profileId="" use999Ack="" useTA1Ack="" expectAckForOutbound="" validateOutboundTransactionSets="" qualifierValidation=""/>

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedSupportedNot supportedSupported

Using the GET operation​

  • The ordinary GET operation returns a single Trading Partner Component object based on the supplied ID.
  • The bulk GET operation returns multiple Trading Partner Component objects based on the supplied IDs, to a maximum of 100.
  • A GET operation specifying the ID of a deleted Trading Partner component retrieves the component. In the component, the deleted field’s value is true.

Using the QUERY operation​

  • You can use the following fields as QUERY filters for the Trading Partner Component object:

    FieldAllowed values
    classificationtradingpartner or mycompany.
    nameAny string value.
    standardedifact, hl7, rosettanet, tradacoms, x12, odetteor custom.
    identifierAny string value.
    as2true
    disktrue
    ftptrue
    httptrue
    mllptrue
    sftptrue
    oftp2true
    note

    The name field in a QUERY filter represents the object’s componentName field.

  • Only the LIKE operator is allowed with a name filter. Likewise, you can only use the EQUALS operator with a classification, standard, identifier filter, or a communication method filter (as2, disk, ftp, http, mllp, sftp). Filtering on a communication method field requests Trading Partner components by defining the communication method.

  • If the QUERY request includes multiple filters, you can connect the filters with a logical AND operator. The QUERY request does not support the logical OR operator.

  • The QUERY results omit the folderName field.

For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

Using the CREATE operation​

  • TheCREATE operation creates a Trading Partner Component object with a specified component name.

  • The request body requires the standard, classification, and componentName fields. If you omit the folderName field, you must use the folderId field — and vice versa. If you omit the componentID field and the IDs of any certificates you want to create, their values are assigned when you create the components. If you leave off the folderID field when creating a component, it assigns a value.

  • Includes the organizationId field only if the trading partner is to reference an Organization component, in which case the field value is the ID of the Organization component. A request specifying the organizationId field populates the ContactInformation fields with the data from the referenced Organization component.

Using the UPDATE operation​

  • The UPDATE operation overwrites the Trading Partner Component object with the specified component ID except as described in the following:

    • If those fields are empty, an UPDATE operation specifying the organizationId field populates the ContactInformation fields with the data from the referenced Organization component. However, if those fields have values, they are not overwritten.

  • An UPDATE operation specifying the ID of a deleted Trading Partner component restores the component to a non-deleted state, assuming the request is otherwise valid.

Using the DELETE operation​

  • The DELETE operation deletes the Trading Partner Component object with a specific component ID.

  • A DELETE operation specifying the ID of a deleted Trading Partner component returns a false response.

SOAP implementation​

  • GET operation

    In this example, it retrieves the Trading Partner component with the ID 12345678-9abc-def0-1234-56789abcdef0.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:get>
             <api:objectType>TradingPartnerComponent</api:objectType>
             <api:objectId>12345678-9abc-def0-1234-56789abcdef0</api:objectId>
          </api:get>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:TradingPartnerComponent" folderId="120088" folderName="Home:TPs" componentId="12345678-9abc-def0-1234-56789abcdef0" componentName="Best Wholesaling" identifier="Best" standard="x12" classification="tradingpartner" branchId="QjoyMDI1OTk" branchName="branch-1">
                <bns:ContactInfo>
                   <bns:contactName>Tom Miller</bns:contactName>
                   <bns:address1>127 Comstock Ave.</bns:address1>
                   <bns:address2/>
                   <bns:city>Philadelphia</bns:city>
                   <bns:state>PA</bns:state>
                   <bns:postalcode>19100</bns:postalcode>
                   <bns:country>United States</bns:country>
                   <bns:email>tom@bestwholesaling.com</bns:email>
                   <bns:phone>311 555-1926</bns:phone>
                   <bns:fax/>
                </bns:ContactInfo>
                <bns:PartnerInfo>
                <bns:PartnerInfo>
                   <bns:X12PartnerInfo>
                      <bns:X12Options envelopeoption="groupall" acknowledgementoption="donotackitem" filteracknowledgements="false" rejectDuplicateInterchange="false" outboundInterchangeValidation="true" outboundValidationOption="filterError">
                         <bns:elementDelimiter delimiterValue="stardelimited"/>
                         <bns:segmentTerminator segmentTerminatorValue="newline"/>
                      </bns:X12Options>
                      <bns:X12ControlInfo>
                         <bns:ISAControlInfo testindicator="P" ackrequested="false" authorizationInformationQualifier="X12AUTHQUAL_00" securityInformationQualifier="X12SECQUAL_00" interchangeIdQualifier="X12IDQUAL_01"/>
                         <bns:GSControlInfo respagencycode="T"/>
                      </bns:X12ControlInfo>
          </bns:X12PartnerInfo>
                </bns:PartnerInfo>
                <bns:PartnerCommunication>
                   <bns:FTPCommunicationOptions CommunicationSetting="custom">
                      <bns:SharedCommunicationChannel/> 
                      <bns:FTPSettings connectionMode="active" useDefaultSettings="false">
                         <bns:host>ftp.bestwholesaling.com</bns:host>
                         <bns:port>1010</bns:port>
                         <bns:user>tom.miller</bns:user>
                         <bns:FTPSSLOptions sslmode="none" useClientAuthentication="false"/>
                      </bns:FTPSettings>
                      <bns:FTPGetOptions transferType="ascii" ftpAction="actionget" useDefaultGetOptions="false">
                         <bns:remoteDirectory>/usr/local/bestwholesaling/outbox</bns:remoteDirectory>
                         <bns:fileToMove>*.xml</bns:fileToMove>
                         <bns:maxFileCount>200</bns:maxFileCount>
                      </bns:FTPGetOptions>
                      <bns:FTPSendOptions transferType="ascii" ftpAction="actionputappend" useDefaultSendOptions="false">
                         <bns:remoteDirectory>/home/tommiller/new</bns:remoteDirectory>
                         <bns:moveToDirectory>/home/tommiller/inbox</bns:moveToDirectory>
                      </bns:FTPSendOptions>
                   </bns:FTPCommunicationOptions>
                </bns:PartnerCommunication>
                <bns:PartnerDocumentTypes>
                  <bns:PartnerDocumentType typeId="101" profileId="23456789-abcd-ef01-2345-6789abcdef01" use999Ack="false" useTA1Ack="false" expectAckForOutbound="false" validateOutboundTransactionSets="false" qualifierValidation="true"/>
                  <bns:PartnerDocumentType typeId="810" profileId="3456789a-bcde-4012-3456-789abcdef012" use999Ack="false" useTA1Ack="false" expectAckForOutbound="false" validateOutboundTransactionSets="false" qualifierValidation="true"/>
                </bns:PartnerDocumentTypes>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The QUERY operation returns each Trading Partner component that meets the specified filtering criteria. The operation does not return full component representations; it returns, for each result the:

    • Component’s folder ID
    • ID
    • Name
    • Standard
    • Identifier
    • Classification
    • Communication methods

    The following example query returns the authenticating account’s X12 Trading Partner components.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:query>
             <api:objectType>TradingPartnerComponent</api:objectType>
             <api:queryConfig>
                 <api:QueryFilter>
                    <api:expression operator="EQUALS" property="standard"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                          <api:argument>x12</api:argument>
                    </api:expression>
                 </api:QueryFilter>
             </api:queryConfig>
          </api:query>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:results numberOfResults="2">
                  <bns:result xsi:type="bns:TradingPartnerComponent" classification="tradingpartner" standard="x12" identifier="BEST-WH" componentName="Best Wholesaling" componentId="12345678-9abc-def0-1234-56789abcdef0" folderId="11356" branchId="QjoyMDI1OTk" branchName="branch-1">
                     <bns:PartnerCommunicationTypes>ftp</bns:PartnerCommunicationTypes>
                  </bns:result>
                  <bns:result xsi:type="bns:TradingPartnerComponent" classification="mycompany" standard="x12" identifier="MY-X12" componentName="MyCompanyx12" componentId="fedcba09-8765-4321-fedc-ba0987654321" folderId="13340" branchId="QjoyMDI1OTk" branchName="branch-1">
                     <bns:PartnerCommunicationTypes>ftp</bns:PartnerCommunicationTypes>
                  </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    The following example adds an X12 Trading Partner component with the FTP communication method.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:create>
             <object xsi:type="api:TradingPartnerComponent" componentName="Best Wholesaling" classification="tradingpartner" standard="x12" branchId="QjoyMDI1OTk" branchName="branch-1">
                <api:ContactInfo>
                   <api:contactName>Tom Miller</api:contactName>
                   <api:address1>127 Comstock Ave.</api:address1>
                   <api:address2/>
                   <api:city>Philadelphia</api:city>
                   <api:state>PA</api:state>
                   <api:postalcode>19100</api:postalcode>
                   <api:country>US</api:country>
                   <api:email>tom@bestwholesaling.biz</api:email>
                   <api:phone>311 555-3579</api:phone>
                   <api:fax>311 555-9753</api:fax>
                </api:ContactInfo>
                <api:PartnerInfo>
                   <api:X12PartnerInfo>
                      <api:X12Options envelopeoption="groupall" acknowledgementoption="donotackitem" filteracknowledgements="false" rejectDuplicateInterchange="false" outboundInterchangeValidation="true" outboundValidationOption="filterError">
                         <api:elementDelimiter delimiterValue="stardelimited"/>
                         <api:segmentTerminator segmentTerminatorValue="newline"/>
                      </api:X12Options>
                      <api:X12ControlInfo>
                         <api:ISAControlInfo testindicator="P" ackrequested="false" authorizationInformationQualifier="X12AUTHQUAL_00" securityInformationQualifier="X12SECQUAL_00" interchangeIdQualifier="X12IDQUAL_01"/>
                         <api:GSControlInfo respagencycode="T"/>
                      </api:X12ControlInfo>
                   </api:X12PartnerInfo>
                </api:PartnerInfo>
                <api:PartnerCommunication>
                   <api:FTPCommunicationOptions CommunicationSetting="custom">
                      <api:SharedCommunicationChannel/>  
                      <api:FTPSettings connectionMode="active" useDefaultSettings="false">
                         <api:host>ftp.bestwholesaling.com</api:host>
                         <api:port>1010</api:port>
                         <api:user>tom.miller</api:user>
                         <api:FTPSSLOptions sslmode="none" useClientAuthentication="false"/>
                      </api:FTPSettings>
                      <api:FTPGetOptions transferType="ascii" ftpAction="actionget" useDefaultGetOptions="false">
                         <api:remoteDirectory>/usr/local/bestwholesaling/outbox</api:remoteDirectory>
                         <api:fileToMove>*.xml</api:fileToMove>
                         <api:maxFileCount>200</api:maxFileCount>
                      </api:FTPGetOptions>
                      <api:FTPSendOptions transferType="ascii" ftpAction="actionputappend" useDefaultSendOptions="false">
                         <api:remoteDirectory>/home/tommiller/new</api:remoteDirectory>
                         <api:moveToDirectory>/home/tommiller/inbox</api:moveToDirectory>
                      </api:FTPSendOptions>
                   </api:FTPCommunicationOptions>
                </api:PartnerCommunication>
                <api:PartnerDocumentTypes>
                  <api:PartnerDocumentType typeId="101" profileId="23456789-abcd-ef01-2345-6789abcdef01" use999Ack="false" useTA1Ack="false" expectAckForOutbound="false" validateOutboundTransactionSets="false" qualifierValidation="true"/>
                  <api:PartnerDocumentType typeId="810" profileId="3456789a-bcde-4012-3456-789abcdef012" use999Ack="false" useTA1Ack="false" expectAckForOutbound="false" validateOutboundTransactionSets="false" qualifierValidation="true"/>
                </api:PartnerDocumentTypes>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    The response contains the XML representation of the created Trading Partner component, including the:

    • Assigned folder ID
    • Component ID
    • Certificate IDs (the latter only if certificates are created)

  • UPDATE operation

    Important

    You must use the componentId field.

    The following example overwrites the Trading Partner component shown in the previous GET and CREATE examples. As a result, it updates the:

    • Name
    • Email address
    • Phone number
    • Fax number of the trading partner’s contact person
    • FTP user option
    • Send option

    Request:


    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:update>
             <object xsi:type="api:TradingPartnerComponent" folderId="11356" folderName="Home:TPs" componentId="12345678-9abc-def0-1234-56789abcdef0" componentName="Best Wholesaling" classification="tradingpartner" standard="x12" branchId="QjoyMDI1OTk" branchName="branch-1">
                <api:ContactInfo>
                   <api:contactName>Rachel Lewis</api:contactName>
                   <api:address1>127 Comstock Ave.</api:address1>
                   <api:address2/>
                   <api:city>Philadelphia</api:city>
                   <api:state>PA</api:state>
                   <api:postalcode>19100</api:postalcode>
                   <api:country>US</api:country>
                   <api:email>rachel@bestwholesaling.biz</api:email>
                   <api:phone>311 555-2468</api:phone>
                   <api:fax>311 555-8642</api:fax>
                </api:ContactInfo>
                <api:PartnerInfo>
                   <api:X12PartnerInfo>
                      <api:X12Options envelopeoption="groupall" acknowledgementoption="donotackitem" filteracknowledgements="false" rejectDuplicateInterchange="false" outboundInterchangeValidation="true" outboundValidationOption="filterError">
                         <api:elementDelimiter delimiterValue="stardelimited"/>
                         <api:segmentTerminator segmentTerminatorValue="newline"/>
                      </api:X12Options>
                      <api:X12ControlInfo>
                         <api:ISAControlInfo testindicator="P" ackrequested="false" authorizationInformationQualifier="X12AUTHQUAL_00" securityInformationQualifier="X12SECQUAL_00" interchangeIdQualifier="X12IDQUAL_01"/>
                         <api:GSControlInfo respagencycode="T"/>
                      </api:X12ControlInfo>
                   </api:X12PartnerInfo>
                </api:PartnerInfo>
                <api:PartnerCommunication>
                   <api:FTPCommunicationOptions CommunicationSetting="custom">
                      <api:SharedCommunicationChannel/>     
                      <api:FTPSettings connectionMode="active" useDefaultSettings="false">
                         <api:host>ftp.bestwholesaling.com</api:host>
                         <api:port>1010</api:port>
                         <api:user>rachel.lewis</api:user>
                         <api:FTPSSLOptions sslmode="none" useClientAuthentication="false"/>
                      </api:FTPSettings>
                      <api:FTPGetOptions transferType="ascii" ftpAction="actionget" useDefaultGetOptions="false">
                         <api:remoteDirectory>/usr/local/bestwholesaling/outbox</api:remoteDirectory>
                         <api:fileToMove>*.xml</api:fileToMove>
                         <api:maxFileCount>200</api:maxFileCount>
                      </api:FTPGetOptions>
                      <api:FTPSendOptions transferType="ascii" ftpAction="actionputappend" useDefaultSendOptions="false">
                         <api:remoteDirectory>/home/rachellewis/new</api:remoteDirectory>
                         <api:moveToDirectory>/home/rachellewis/inbox</api:moveToDirectory>
                      </api:FTPSendOptions>
                   </api:FTPCommunicationOptions>
                </api:PartnerCommunication>
                <api:PartnerDocumentTypes>
                  <api:PartnerDocumentType typeId="101" profileId="23456789-abcd-ef01-2345-6789abcdef01" use999Ack="false" useTA1Ack="false" expectAckForOutbound="false" validateOutboundTransactionSets="false" qualifierValidation="true"/>
                  <api:PartnerDocumentType typeId="810" profileId="3456789a-bcde-4012-3456-789abcdef012" use999Ack="false" useTA1Ack="false" expectAckForOutbound="false" validateOutboundTransactionSets="false" qualifierValidation="true"/>
                </api:PartnerDocumentTypes>
             </object>
          </api:update>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    The response contains the XML representation of the updated Trading Partner component.

  • DELETE operation

    In this example, it deletes the Trading Partner component with the ID 12345678-9abc-def0-1234-56789abcdef0.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:delete>
             <objectType>TradingPartnerComponent</objectType>
             <objectId>12345678-9abc-def0-1234-56789abcdef0</objectId>
          </api:delete>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:deleteResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <successful>true</successful>
          </bns:deleteResponse>
       </S:Body>
    </S:Envelope>

On this Page