Developer Resources

The SvcDictSrch operation is designed to provide consumers with a service that can convey a Service Provider's elements XSD path, requirements, default values, open enumerated canonical values, help/knowledge content, and fault codes per operation.

<?xml version="1.0" encoding="UTF-8"?>
      <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <SOAP-ENV:Header>
              <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                  <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
                      <wsse:Username>Redacted</wsse:Username>
                      <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Redacted</wsse:Password>
                      <wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2022-08-05T13:09:49Z</wsu:Created>
                  </wsse:UsernameToken>
              </wsse:Security>
          </SOAP-ENV:Header>
          <SOAP-ENV:Body>
              <SvcDictSrch xmlns="http://jackhenry.com/jxchange/TPG/2008">
                  <SrchMsgRqHdr>
                      <jXchangeHdr>
                          <JxVer />
                          <AuditUsrId></AuditUsrId>
                          <AuditWsId></AuditWsId>
                          <AuthenUsrId />
                          <ConsumerName />
                          <ConsumerProd />
                          <Ver_1 />
                          <jXLogTrackingId></jXLogTrackingId>
                          <Ver_2 />
                          <InstRtId>011001276</InstRtId>
                          <InstEnv>TEST</InstEnv>
                          <Ver_3 />
                          <BusCorrelId />
                          <Ver_4 />
                          <WorkflowCorrelId />
                          <Ver_5 />
                          <ValidConsmName>Redacted</ValidConsmName>
                          <ValidConsmProd>Redacted</ValidConsmProd>
                          <Ver_6 />
                      </jXchangeHdr>
                      <MaxRec>500</MaxRec>
                      <Cursor />
                      <Ver_1 />
                      <Ver_2 />
                      <Ver_3 />
                  </SrchMsgRqHdr>
                  <SvcDictName>InstDefFldSrch</SvcDictName>
                  <SvcDictType>Rs</SvcDictType>
                  <ElemName />
                  <SvcDictFilterArray>
                      <SvcDictFilterInfo>
                          <SvcDictFilterCode />
                          <SvcDictFilterVal />
                          <Ver_1 />
                      </SvcDictFilterInfo>
                  </SvcDictFilterArray>
                  <IncXtendElemArray>
                      <IncXtendElemInfo>
                          <XtendElem>x_SvcPrvdFldInfo</XtendElem>
                          <Ver_1 />
                      </IncXtendElemInfo>
                      <IncXtendElemInfo>
                          <XtendElem />
                          <Ver_1 />
                      </IncXtendElemInfo>
                  </IncXtendElemArray>
                  <Ver_1 />
              </SvcDictSrch>
          </SOAP-ENV:Body>
      </SOAP-ENV:Envelope>

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SOAP-ENV:Header>
    <wsse:Security
      xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
      xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
      <wsse:UsernameToken
        xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:Username>{Insert}</wsse:Username>
        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
        <wsu:Created
          xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2018-05-15T12:35:21Z
        </wsu:Created>
      </wsse:UsernameToken>
    </wsse:Security>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <SvcDictSrch
      xmlns="http://jackhenry.com/jxchange/TPG/2008">
      <SrchMsgRqHdr>
        <jXchangeHdr>
          <JxVer/>
          <AuditUsrId></AuditUsrId>
          <AuditWsId></AuditWsId>
          <AuthenUsrId/>
          <ConsumerName/>
          <ConsumerProd/>
          <Ver_1/>
          <jXLogTrackingId>{Insert}</jXLogTrackingId>
          <Ver_2/>
          <InstRtId>{Insert}</InstRtId>
          <InstEnv>{Insert}</InstEnv>
          <Ver_3/>
          <BusCorrelId/>
          <Ver_4/>
          <WorkflowCorrelId/>
          <Ver_5/>
          <ValidConsmName>{Insert}</ValidConsmName>
          <ValidConsmProd>{Insert}</ValidConsmProd>
          <Ver_6/>
        </jXchangeHdr>
        <MaxRec>500</MaxRec>
        <Cursor/>
        <Ver_1/>
        <Ver_2/>
        <Ver_3/>
      </SrchMsgRqHdr>
      <SvcDictName>AcctAdd</SvcDictName>
      <SvcDictType>Rq</SvcDictType>
      <ElemName/>
      <SvcDictFilterArray>
        <SvcDictFilterInfo>
          <SvcDictFilterCode>actype</SvcDictFilterCode>
          <SvcDictFilterVal>D</SvcDictFilterVal>
          <Ver_1/>
        </SvcDictFilterInfo>
        <SvcDictFilterInfo>
          <SvcDictFilterCode>ProdCode</SvcDictFilterCode>
          <SvcDictFilterVal>BA</SvcDictFilterVal>
          <Ver_1/>
        </SvcDictFilterInfo>
        <SvcDictFilterInfo>
          <SvcDictFilterCode>BrCode</SvcDictFilterCode>
          <SvcDictFilterVal>3</SvcDictFilterVal>
          <Ver_1/>
        </SvcDictFilterInfo>
      </SvcDictFilterArray>
      <IncXtendElemArray>
        <IncXtendElemInfo>
          <XtendElem/>
          <Ver_1/>
        </IncXtendElemInfo>
      </IncXtendElemArray>
      <Ver_1/>
    </SvcDictSrch>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <s:Header>
    <o:Security s:mustUnderstand="1"
      xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <u:Timestamp u:Id="_0">
        <u:Created>2018-06-12T12:44:54.332Z</u:Created>
        <u:Expires>2018-06-12T12:49:54.332Z</u:Expires>
      </u:Timestamp>
    </o:Security>
  </s:Header>
  <s:Body>
    <SvcDictSrchResponse xmlns="http://jackhenry.com/jxchange/TPG/2008"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <SrchMsgRsHdr>
        <jXchangeHdr>
          <JxVer>R2017.4</JxVer>
          <AuditUsrId>PA</AuditUsrId>
          <AuditWsId>IDG</AuditWsId>
          <AuthenUsrId/>
          <ConsumerName/>
          <ConsumerProd/>
          <Ver_1/>
          <jXLogTrackingId>122222222</jXLogTrackingId>
          <Ver_2/>
          <InstRtId>011001276</InstRtId>
          <InstEnv>TEST</InstEnv>
          <Ver_3/>
          <BusCorrelId>bec9da45-5e2f-4200-8048-c23f36c6fd7e</BusCorrelId>
          <Ver_4/>
          <WorkflowCorrelId/>
          <Ver_5/>
          <ValidConsmName></ValidConsmName>
          <ValidConsmProd></ValidConsmProd>
        </jXchangeHdr>
        <SentRec>2</SentRec>
        <MoreRec>false</MoreRec>
        <TotRec>2</TotRec>
        <Ver_1/>
      </SrchMsgRsHdr>
      <SvcDictName>AcctMod</SvcDictName>
      <SvcDictType>Rq</SvcDictType>
      <SvcDictInfoArray>
        <SvcDictInfoRec>
          <ElemName>AcctStat</ElemName>
          <ElemPath>DepMod.DepInfoRec.AcctStat</ElemPath>
          <ElemReq>false</ElemReq>
          <ElemCanocType>NA</ElemCanocType>
          <ElemCanocArray>
            <ElemCanocRec>
              <ElemCanocVal>0</ElemCanocVal>
              <ElemCanocValDesc>Escheat</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>1</ElemCanocVal>
              <ElemCanocValDesc>Active</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>2</ElemCanocVal>
              <ElemCanocValDesc>Closed</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>3</ElemCanocVal>
              <ElemCanocValDesc>Dormant</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>4</ElemCanocVal>
              <ElemCanocValDesc>New today</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>5</ElemCanocVal>
              <ElemCanocValDesc>Pending Close</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>6</ElemCanocVal>
              <ElemCanocValDesc>Restricted</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>7</ElemCanocVal>
              <ElemCanocValDesc>No post</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>8</ElemCanocVal>
              <ElemCanocValDesc>Charged off</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>9</ElemCanocVal>
              <ElemCanocValDesc>No Credits</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
          </ElemCanocArray>
          <Ver_1/>
        </SvcDictInfoRec>
        <SvcDictInfoRec>
          <ElemName>AcctStat</ElemName>
          <ElemPath>SafeDepMod.SafeDepInfoRec.AcctStat</ElemPath>
          <ElemReq>false</ElemReq>
          <ElemCanocType>NA</ElemCanocType>
          <ElemCanocArray>
            <ElemCanocRec>
              <ElemCanocVal>D</ElemCanocVal>
              <ElemCanocValDesc>Drill</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>N</ElemCanocVal>
              <ElemCanocValDesc>Not available</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>O</ElemCanocVal>
              <ElemCanocValDesc>Occupied</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
            <ElemCanocRec>
              <ElemCanocVal>U</ElemCanocVal>
              <ElemCanocValDesc>Unoccupied</ElemCanocValDesc>
              <Ver_1/>
            </ElemCanocRec>
          </ElemCanocArray>
          <Ver_1/>
        </SvcDictInfoRec>
      </SvcDictInfoArray>
      <Ver_1/>
    </SvcDictSrchResponse>
  </s:Body>
</s:Envelope>

Q: For the SvcDictSrch operation, is there a way to pass multiple filter values for the same filter code in the SvcDictFilterArray? I am using this operation with a request for the AcctAdd SvcDictName along with ProdCode ElemName. I would like to pass D, S & T values for AcctType filter code in the same request.

A: Unfortunately there is no way to pass multiple <AcctType> filter codes in the same request, it would need to be multiple calls. Parameter files are different across those account types so there's no way to present them all together in the same response.