Sample Soap File
...
************************************************************************
* This setup is for accessing the DEV INFO/MAN System.
*
* XMLTAGS and ENDXMLTAGS are required definitions. XMLTAGS starts the
* XML tag name definitions and ENDXMLTAGS ends the XML tag name table.
* DO NOT change the ZMF variables in this table as they are used to
* define the actual data to the specified tag name. Tag names are a
* maximum of 120 characters without spaces. ZMF variables in the soap
* and xml will be replaced by the actual data before submitting the
* soap and xml.
* XMLERRMSG0*9 are the field/value to look for a failure of some kind.
* XMLERRMSG0*9 can also be a tag name to look for failure/error data
* i.e. <Error>error data</Error>.
* NEQERRTAG0*9 are the tagname containing a value with some data and
* if not equal to one of the listed vaules it is an error. This type
* is in the format ZMFvariable <tagname> value;value;value. Where value
* is a value at the tagname to check against. Values are separated by a
* ; for multiple values.
* EUQERRTAG0*9 are the tagname containing a value with some data and
* if equal to one of the listed vaules it is an error. This type is in
* the format ZMFvariable <tagname> value;value;value. Where value is a
* value at the tagname to check against. Values are separated by a ;
* for multiple values.
* XMLNORECFD is a field/value or a tag name to look for an INFO record
* not found situation.
* All ZMF variables with an associated XML tag value must contain the
* '<' start of tag name and '>' end of tag name. The 3 exceptions for
* this are XMLNORECFD, XMLERRMSG0*9 and XMLINFOID#.
*
* XMLPRNTID# is an associated record number with the initial READREQ. If
* there is a value for XMLPRNTID# the PARENTREQ will be initiated. This
* is another read request for another record to find other associated
* values. If the PARENTREQ returns another value for XMLPRNTID# it will
* continue to issue the PARENTREQ for the new value until no value is
* returned for XMLPRNTID#.
*
* ENDPOINT is a required definition for the soap call (HTTP caller)
* Endpoint is the destination URL for the HTTP caller. The endpoint
* should be the first statement that follows the start of the call types
* read (READREQ), update (UPDATEREQ), create (CREATEREQ) or parent read
* (PARENTREQ) All statements prior to the ENDPOINT will be ignored. The
* ENDPOINT statement must be contained all on one line.
*
* SOAPAction is not a required definition for a soap call (HTTP caller).
* This statement must follow the ENDPOINT statement if you require a
* SOAPAction. The value of the action will be used by the HTTP caller.
* The SOAPAction statement must be contained all on one line.
*
* Method is not a required definition for a soap call (HTTP caller).
* This statement must follow the SOAPAction statement if you require a
* Method. If there is no SOAPAction statement the Method statement if
* required must then follow the ENDPOINT statement. The value of the
* method action will be used by the HTTP caller.
*
* READREQ and ENDREAD are required statements. These statements begin
* and end the soap and xml required to issue a read only request.
* The first valid statement following the READREQ is the ENDPOINT
* statement anything in between the READREQ and ENDPOINT statement is
* considered a comment and will be ignored. Everything after the
* ENDPOINT should only be the SOAPAction and/or the Method statements
* or soap and xml until the ENDREAD is reached.
*
* UPDATEREQ and ENDUPDATE are required statements. These statements
* begin and end the soap and xml required to issue an update request.
* The first valid statement following the UPDATEREQ is the ENDPOINT
* statement anything in between the UPDATEREQ and ENDPOINT statement is
* considered a comment and will be ignored. Everything after the
* ENDPOINT should only be the SOAPAction and/or the Method statements
* or soap and xml until the ENDUPDATE is reached.
*
* CREATEREQ and ENDCREATE are required statements. These statements
* begin and end the soap and xml required to issue a create request.
* The first valid statement following the CREATEREQ is the ENDPOINT
* statement anything in between the CREATEREQ and ENDPOINT statement is
* considered a comment and will be ignored. Everything after the
* ENDPOINT should only be the SOAPAction and/or the Method statements
* or soap and xml until the ENDCREATE is reached.
*
* PARENTREQ and ENDPARENT are not required statements. These statements
* begin and end the soap and xml required to issue a parent request.
* The first valid statement following the PARENTREQ is the ENDPOINT
* statement anything in between the PARENTREQ and ENDPOINT statement is
* considered a comment and will be ignored. Everything after the
* ENDPOINT should only be the SOAPAction and/or the Method statements
* or soap and xml until the ENDPARENT is reached.
*
************************************************************************
ZMF variable names CANNOT be changed but can be removed if they are not
used. The ZMF variables that have no associated tagname or data after
the ZMF variable will be ignored.
The tagname is a maximum of 120 characters. Values for NEQERRTAG0-9 and
EQUERRTAG0-9 are a maximum of 120 characters. XMLNORECFD, XMLERRMSG0-9
can be a tagname or any string of 120 characters. XMLINFOID# does not
have to be a tagname. All other field are validated for a tagname that
start with < and end with >.
Format for NEQERRTAG0-9 and EQUERRTAG0-9:
Format for NEQERRTAG0-9 and EQUERRTAG0-9:
ZMFvar <tagname> value1;value2;value3.......
ZMF Var XML tag name (DO NOT comment after tag)
---------- -----------------------------------------------------------
XMLTAGS:
XMLNORECFD Invalid record
XMLERRMSG0 success="false"
XMLERRMSG1 <error>
XMLERRMSG2
XMLERRMSG3
XMLERRMSG4
XMLERRMSG5
XMLERRMSG6
XMLERRMSG7
XMLERRMSG8
XMLERRMSG9
NEQERRTAG0 <CHANGEMAN_LPAR> TSYS
NEQERRTAG1 <CHANGE_TYPE> APP;SSW;ALLPA
NEQERRTAG2
NEQERRTAG3
NEQERRTAG4
NEQERRTAG5
NEQERRTAG6
NEQERRTAG7
NEQERRTAG8
NEQERRTAG9
EQUERRTAG0
EQUERRTAG1
EQUERRTAG2
EQUERRTAG3
EQUERRTAG4
EQUERRTAG5
EQUERRTAG6
EQUERRTAG7
EQUERRTAG8
EQUERRTAG9
XMLINFOID#
XMLPRNTID# <PARENT_CHANGE_NUM>
XMLAPPRSTA <APPROVAL_STATUS>
XMLPACKAGE <CHANGEMAN_PACKAGE_ID>
XMLPKGSTAT <CHANGEMAN_STATUS>
XMLINSDATE <INSTALL_DATE>
XMLINSFTME <INSTALL_TIME>
XMLPKGDESC <BRIEF_DESCRIPTION>
XMLREQNAME <REQUESTER_NAME>
XMLREQPHON <REQUESTER_PHONE>
XMLDEPART# <ASSIGNEE_DEPT>
XMLPRMNAME <PRIMARY_NAME>
XMLPRMPHON <PRIMARY_PHONE>
XMLSCDNAME <SECONDARY_NAME>
XMLSCDPHON <SECONDARY_PHONE>
XMLRMTSITE
XMLPKGTYPE XMLPKGLEVL
XMLPKGCRTN
XMLINSTTME
XMLRLSNAME
XMLARENAME
ENDXMLTAGS: End of XML tag name table
READREQ:
Comments here:
Soap request for read, only put the ENDPOINT, SOAPAction, soap and xml
between here and the ENDREAD statement. Everything between READREQ and
the ENDPOINT is ignored.
End Comments:
ENDPOINT=http://your.host.name:38400/Your/Url/serviceagent/Endpoint
SOAPAction:"/Your/Change/Services/serviceagent//readRecord"
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:vc="http://Your/Change/Schemas/vc-request.xsd">
<soapenv:Header/>
<soapenv:Body>
<vc:read-record recordId="XMLINFOID#">
<vc:fields>
<!--1 or more repetitions:-->
<vc:field>CHANGEMAN_PACKAGE_ID</vc:field>
<vc:field>CHANGEMAN_STATUS</vc:field>
<vc:field>BRIEF_DESCRIPTION</vc:field>
<vc:field>INSTALL_DATE</vc:field>
<vc:field>INSTALL_TIME</vc:field>
<vc:field>REQUESTER_NAME</vc:field>
<vc:field>REQUESTER_PHONE</vc:field>
<vc:field>PRIMARY_NAME</vc:field>
<vc:field>PRIMARY_PHONE</vc:field>
<vc:field>SECONDARY_NAME</vc:field>
<vc:field>SECONDARY_PHONE</vc:field>
<vc:field>ASSIGNEE_DEPT</vc:field>
<vc:field>PARENT_CHANGE_NUM</vc:field>
<vc:field>CHANGEMAN_LPAR</vc:field>
<vc:field>CHANGE_TYPE</vc:field>
</vc:fields>
</vc:read-record>
</soapenv:Body>
</soapenv:Envelope>
ENDREAD: end of soap request for read only
PARENTREQ:
Comments:
Soap request for parent, only put the ENDPOINT, SOAPAction, soap and xml
between here and the ENDPARENT statement. Everything between PARENTREQ
and the ENDPOINT is ignored.
End Comments:
ENDPOINT=http://your.host.name:38400/Your/Url/serviceagent/Endpoint
SOAPAction="/Your/Change/Services/serviceagent//readRecord"
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:vc="http://Your/Change/Schemas/vc-request.xsd">
<soapenv:Header/>
<soapenv:Body>
<vc:read-record recordId="XMLPRNTID#">
<vc:fields>
<!--1 or more repetitions:-->
<vc:field>APPROVAL_STATUS</vc:field>
</vc:fields>
</vc:read-record>
</soapenv:Body>
</soapenv:Envelope>
ENDPARENT: end of soap request for read only parent record call
UPDATEREQ:
Comments:
Soap request for update, only put the ENDPOINT, SOAPAction, soap and xml
between here and the ENDUPDATE statement. Everything between UPDATEREQ
and the ENDPOINT is ignored.
End Comments:
ENDPOINT=http://your.host.name:38400/Your/Url/serviceagent/Endpoint
SOAPAction="/Your/Change/Services/serviceagent/addModRecord"
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:vc="http://Your/Change/Schemas/vc-request.xsd">
<soapenv:Header/>
<soapenv:Body>
<vc:addmod-record iAm="ChangeMan" recordId="XMLINFOID#" type="ACTIVITY"
userId="USER">
<vc:param>
<vc:name>FL_UPDATE</vc:name>
<vc:value>Y</vc:value>
</vc:param>
<vc:param>
<vc:name>CHANGEMAN_PACKAGE_ID</vc:name>
<vc:value>XMLPACKAGE</vc:value>
</vc:param>
<vc:param>
<vc:name>CHANGEMAN_STATUS</vc:name>
<vc:value>XMLPKGSTAT</vc:value>
</vc:param>
<vc:param>
<vc:name>INSTALL_DATE</vc:name>
<vc:value>XMLINSDATE</vc:value>
</vc:param>
<vc:param>
<vc:name>INSTALL_TIME</vc:name>
<vc:value>XMLINSFTME</vc:value>
</vc:param>
<vc:param>
<vc:name>REQUESTER_NAME</vc:name>
<vc:value>XMLREQNAME</vc:value>
</vc:param>
<vc:param>
<vc:name>REQUESTER_PHONE</vc:name>
<vc:value>XMLREQPHON</vc:value>
</vc:param>
<vc:param>
<vc:name>ASSIGNEE_DEPT</vc:name>
<vc:value>XMLDEPART#</vc:value>
</vc:param>
<vc:param>
<vc:name>BRIEF_DESCRIPTION</vc:name>
<vc:value>XMLPKGDESC</vc:value>
</vc:param>
</vc:addmod-record>
</soapenv:Body>
</soapenv:Envelope>
ENDUPDATE: end of soap request for update
CREATEREQ:
Comments:
Create request is not used.
Soap request for create, only put the ENDPOINT, SOAPAction, soap and xml
between here and the ENDCREATE statement. Everything between CREATEREQ
and the ENDPOINT is ignored.
End Comments:
ENDPOINT=http://no connection or call here
ENDCREATE: end of soap request for create record call