EServices XML Interface
To send arequest for EDSS’ eServices available for a user, a single parameter (named XMLRequest) must be posted to The value of the parameter is an XML document which will be described below. The response will be an XML document, also described below.
XML Request for Enrolled and Available eServices
The following describes the layout of XML for submitting a request for enrolled and available EDSS eServices. Field constraints are included as inline comments (recognizable with double leading slashes (“//”)). Please do not include comments in your XML. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified.
<?xml version=”1.0”?>
<REQUEST TYPE="com.edss.cartridges.framework.EServices">
<HEAD>
<AUTHENTICATION>
<USERNAME> ... </USERNAME> // Max 50
<PASSWORD> ... </PASSWORD> // Max 50
</AUTHENTICATION>
</HEAD>
</REQUEST>
All fields are required.
XML Response for Enrolled and Available eServices
The following describes the XML response layout generated from an EDSS eServices request. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified.
<?xml version=”1.0”?>
<RESPONSE TYPE="com.edss.cartridges.framework.Enrollment">
<HEAD>
<AUTHENTICATION>
<USERNAME> ... </USERNAME>
<PASSWORD> ... </PASSWORD>
</AUTHENTICATION>
<USER_PROFILE>
<NAME>
<FIRST_NAME> ... </FIRST_NAME>
<LAST_NAME> ... </LAST_NAME>
</NAME>
<CONTACT_INFORMATION>
<ADDRESS>
<STREET_1> ... </STREET_1>
<STREET_2> ... </STREET_2>
<CITY> ... </CITY>
<STATE> ... </STATE>
<ZIP> ... </ZIP>
</ADDRESS>
<EMAIL> ... </EMAIL>
<TELEPHONE> ... </TELEPHONE>
<FAX> ... </FAX>
</CONTACT_INFORMATION>
<BILLABLE> (Optional)</BILLABLE>
</USER_PROFILE>
</HEAD>
<STATUS>
<CODE> ... </CODE>
<MESSAGE... </MESSAGE>
</STATUS>
Continued …
<DATA>
<ENROLLED>
<APPLICATION>
<NAME> Application Name </NAME>
<DESCRIPTION> App Description </DESCRIPTION>
<URL> URL to EDSS Application Front-end </URL>
<ICON_URL> URL to Applications icon </ICON_URL>
<ALTERNATE_ICON_URL> Alternate icon(optional)</ALTERNATE_ICON_URL>
<MORE_INFO_URL> App extended info (optional) </MORE_INFO_URL>
<FEE_DESCRIPTION> App Fee Desc (optional) </FEE_DESCRIPTION>
<ENROLLMENT_FEE> (optional) </ENROLLMENT_FEE>
<MONTHLY_FEE> (optional) </MONTHLY_FEE>
<ENROLLMENT_URL> Front-end enroll URL (optional) </ENROLLMENT_URL>
<ADMIN_URL> (optional) </ADMIN_URL>
<STATUS> (optional) </STATUS>
</APPLICATION>
</ENROLLED>
<AVAILABLE>
<NAME> Application Name </NAME>
<DESCRIPTION> App Description </DESCRIPTION>
<URL> URL to EDSS Application Front-end </URL>
<ICON_URL> URL to Applications icon </ICON_URL>
<ALTERNATE_ICON_URL> Alternate icon(optional)</ALTERNATE_ICON_URL>
<MORE_INFO_URL> App extended info (optional) </MORE_INFO_URL>
<FEE_DESCRIPTION> App Fee Desc (optional) </FEE_DESCRIPTION>
<ENROLLMENT_FEE> (optional) </ENROLLMENT_FEE>
<MONTHLY_FEE> (optional) </MONTHLY_FEE>
<ENROLLMENT_URL> Front-end enroll URL (optional) </ENROLLMENT_URL>
<ADMIN_URL> (optional) </ADMIN_URL>
</APPLICATION>
</AVAILABLE>
</DATA>
</RESPONSE>
If the value of the RESPONSE/STATUS/CODE field is 200, the eServices request was successfully completed. Otherwise, there was an error. The RESPONSE/STATUS/MESSAGE field will have an error message indicating what went wrong.
All applicationsactivatedfor user will be under the RESPONSE/DATA/ENROLLED/APPLICATION tags. Please note that there will be a variable number of <APPLICATION> tags, depending on the number of applications the user has successfully enrolled for. This tag is not required.
All applications for which the user will have the opportunity to enroll will be in the REPONSE/DATA/AVAILABLE/APPLICATION tags.It has been determined that these are applications that the user might find beneficial. Please note that there will be a variable number of <APPLICATION> tags, depending on the number of applications that have been made available, for which the user has not yetenrolled. This tag is not required.
Confidential