Message Center XML Interface

Message Center XML Interface

To send Message Center XML requests, a single parameter (named XMLRequest) must be posted to The value of the parameter must be one of the XML documents, which will be described below. The response will be an XML document, also described below.

XML Request for retrieving list of messages in user’s message box

The following describes the layout of XML for submitting a request to the Message Center to get a list of messages in the user’s message box. Field constraints are included as inline comments (recognizable with double leading slashes (“//”)). Please do not include comments in your XML. Anything with multiple values separated with a ‘| |’ indicates an “or” relationship. You may choose the most appropriate value listed. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified unless you have a choice between multiple values as indicated above.

<?xml version=”1.0”?>

<HEAD>

<USERNAME> ... </USERNAME> // Max 50

<PASSWORD> ... </PASSWORD> // Max 50

</AUTHENTICATION>

</HEAD>

<DATA>

<FIELD> FROM || SUBJECT || DATE </FIELD>

</SORT>

</ACTION>

</DATA>

</REQUEST>

All fields are required. The <SORT> tag represents the order in which the list of messages is returned. The ORDER attribute in the <SORT> tag gives the option of returning the messages in ascending or descending order. The <FIELD> tag represents the field (FROM, SUBJECT or DATE) on which to sort.

XML Response for retrieving list of messages in users message box

The following describes the XML response layout generated from a request for a list of user’s messages. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified.

<?xml version=”1.0”?>

<HEAD>

</AUTHENTICATION>

<USER_PROFILE>

<NAME>

<FIRST_NAME> ... </FIRST_NAME>

<LAST_NAME> ... </LAST_NAME>

</NAME>

<CONTACT_INFORMATION>

<STREET_1> ... </STREET_1>

<STREET_2> ... </STREET_2>

</ADDRESS>

Continued …

</CONTACT_INFORMATION>

<BILLABLE> (Optional)</BILLABLE>

</USER_PROFILE>

</HEAD>

</STATUS>

<DATA>

<MSG>

<ID> Messages unique ID </ID>

<DATE> Date message was received </DATE>

<LENGTH> Message Length in bytes </LENGTH>

</MSG>

</DATA>

</RESPONSE>

If the value of the RESPONSE/STATUS/CODE field is 200, the request was successfully completed. Otherwise, there was an error. The RESPONSE/STATUS/MESSAGE field will have an error message indicating what went wrong.

Messages will be under the RESPONSE/DATA/MSG tags. Please note that there will be a variable number of <MSG> tags, depending on the number of messages in the user’s message box. This tag is not required.

XML Request for retrieving message content

The following describes the XML layout for submitting a request to the Message Center for retrieval of a specific message’s content. 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”?>

<HEAD>

<USERNAME> ... </USERNAME> // Max 50

<PASSWORD> ... </PASSWORD> // Max 50

</AUTHENTICATION>

</HEAD>

<DATA>

<MSG_ID> Message ID from <ID> tag in message list </MSG_ID>

</ACTION>

</DATA>

</REQUEST>

All fields are required.

XML Response for retrieving message content

The following describes the XML response layout generated from a request for retrieval of a specific messages content. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified.

Continued…

<?xml version=”1.0”?>

<HEAD>

</AUTHENTICATION>

<USER_PROFILE>

<NAME>

<FIRST_NAME> ... </FIRST_NAME>

<LAST_NAME> ... </LAST_NAME>

</NAME>

<CONTACT_INFORMATION>

<STREET_1> ... </STREET_1>

<STREET_2> ... </STREET_2>

</ADDRESS>

</CONTACT_INFORMATION>

<BILLABLE> (Optional)</BILLABLE>

</USER_PROFILE>

</HEAD>

</STATUS>

<DATA>

<MSG>

<ID> Messages unique ID </ID>

<DATE> Date message was received </DATE>

<LENGTH> Message length in bytes </LENGTH>

<BODY> Message content </BODY>

</MSG>

</DATA>

</RESPONSE>

There will be only one <MSG> tag. Note: the <BODY> tag can contain very large amounts of data, since it contains the entire message body.

XML Request for deleting a message

The following describes the XML layout for requesting a specific message is deleted. 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”?>

Continued…

<HEAD>

<USERNAME> ... </USERNAME> // Max 50

<PASSWORD> ... </PASSWORD> // Max 50

</AUTHENTICATION>

</HEAD>

<DATA>

<MSG_ID> Message ID from <ID> tag in message list </MSG_ID>

</ACTION>

</DATA>

</REQUEST>

All fields are required. To delete multiple messages, include a <MSG_ID> tag for each message.

XML Response for deleting a message

The following describes the XML response layout generated from a request for deletion of specific messages. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified.

<?xml version=”1.0”?>

<HEAD>

</AUTHENTICATION>

<USER_PROFILE>

<NAME>

<FIRST_NAME> ... </FIRST_NAME>

<LAST_NAME> ... </LAST_NAME>

</NAME>

<CONTACT_INFORMATION>

<STREET_1> ... </STREET_1>

<STREET_2> ... </STREET_2>

</ADDRESS>

</CONTACT_INFORMATION>

<BILLABLE> (Optional)</BILLABLE>

</USER_PROFILE>

</HEAD>

</STATUS>

<DATA>

<MSG_ID DELETED=”Y || N”</MSG_ID>

</DATA>

</RESPONSE>

For each message a delete request was done on, there will be a corresponding <MSG_ID> tag. Each one will contain a DELETED attribute indicating whether the delete process was successful (Y) or unsuccessful (N).

XML Request to check for EDSS reports for user’s organizations

The following describes the layout of XML for submitting a request to the Message Center to check if EDSS has internal reports for this user’s organizations that can be imported into the Message Center. 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”?>

<HEAD>

<USERNAME> ... </USERNAME> // Max 50

<PASSWORD> ... </PASSWORD> // Max 50

</AUTHENTICATION>

</HEAD>

<DATA>

</DATA>

</REQUEST>

All fields are required.

XML Response to check for EDSS reports for user’s organizations

The following describes the XML response layout generated from a request for available reports for the user's organizations. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified.

<?xml version=”1.0”?>

<HEAD>

</AUTHENTICATION>

<USER_PROFILE>

<NAME>

<FIRST_NAME> ... </FIRST_NAME>

<LAST_NAME> ... </LAST_NAME>

</NAME>

<CONTACT_INFORMATION>

<STREET_1> ... </STREET_1>

<STREET_2> ... </STREET_2>

</ADDRESS>

</CONTACT_INFORMATION>

<BILLABLE> (Optional)</BILLABLE>

</USER_PROFILE>

</HEAD>

</STATUS>

<DATA>

<AVAIL_REPS>

<ORG_ID> Organization with Report </ORG_ID>

</AVAIL_REPS>

</DATA>

</RESPONSE>

All organizations with reports available will be under the RESPONSE/DATA/AVAIL_REPS/ORG_ID tags. Please note that there will be a variable number of <ORG_ID> tags, depending on the number of organizations associated with this user who have reports in the EDSS System. This tag is not required.

XML Request for importing an EDSS report into the Message Center

The following describes the layout of XML for submitting a request to import an EDSS report into the message center. 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”?>

<HEAD>

<USERNAME> ... </USERNAME> // Max 50

<PASSWORD> ... </PASSWORD> // Max 50

</AUTHENTICATION>

</HEAD>

<DATA>

<ORG_ID> Organization ID of report to import </ORG_ID>

</ACTION>

</DATA>

</REQUEST>

All fields are required. The organization Ids available for a download for the user, can be determined by doing the CHECK_REPORTS request.

XML Response for importing an EDSS report into the Message Center

The following describes the XML response layout generated from a request for an import of an EDSS report into the message center. Note: all tag names MUST be upper case. Anything in quotes is to be included EXACTLY as specified.

<?xml version=”1.0”?>

<HEAD>

</AUTHENTICATION>

<USER_PROFILE>

<NAME>

<FIRST_NAME> ... </FIRST_NAME>

<LAST_NAME> ... </LAST_NAME>

</NAME>

<CONTACT_INFORMATION>

<STREET_1> ... </STREET_1>

<STREET_2> ... </STREET_2>

</ADDRESS>

</CONTACT_INFORMATION>

Continued…

<BILLABLE> (Optional)</BILLABLE>

</USER_PROFILE>

</HEAD>

</STATUS>

<DATA>

<ORG_ID LOADED=”Y || N”>

Organization ID requested for import

</ORG_ID>

</DATA>

</RESPONSE>

For each organization ID requesting an import of an EDSS report, there will be a corresponding <ORG_ID> tag with a LOADED attribute indicating whether the import process was successful (Y) or unsuccessful (N).

Confidential