Mark Message as Seen

Last updated
Save as PDF

Mark Message as Seen

Given a GMH and a valid user/coverage, mark the message as seen by the specified user/coverage. This web service will only operate on return or local messages, not forward messages.

String markMessageSeen(int inGMH, String markAllSeen, String userOrCvg,throws WSException);

inGMH: The global message handle of the message to mark as seen.
markAllSeen: Valid values are blank, "N", "Y", and "I". See the table below for behavior.
userOrCvg: the User or Address List whose copy is to be marked seen.

The GMH field is required. The last two fields may be left blank. The behavior of the parameters is as follows:

markAllSeen Flag	userOrCvg Field	Behavior
Y	Specified	This will result in error 012, whether a user or coverage is specified.
Y	Blank	mark every recipient's copy of the message as seen regardless of their user preference settings.
I	Specified	If a user is specified, the specified user's copy is marked ignored, or left unseen, based on his user preference settings. If a coverage is specified, each copy belonging to a member of that coverage is marked ignored or left unseen based on that member's user preference settings.
I	Blank	Mark every recipient's copy of the message as ignored, or if the recipient is ineligible for ignoring messages, leave the copy as unseen.
N	Specified	If a user is specified, the specified user's copy is marked seen or claimed based on his user preference settings. If a coverage is specified, this will result in error 013.
N	Blank	Mark (the user calling the web service) copy of the message as seen or claimed based on his user preference settings.
Blank	Specified	If a user is specified, the specified user's copy is marked seen or claimed based on his user preference settings. If a coverage is specified, this will result in error 013.
Blank	Blank	Mark (the user calling the web service) copy of the message as seen or claimed based on his user preference settings.

Returns a null string on exceptions; otherwise returns a string containing a status of "1" meaning success.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use QTRACS
- If the message is from a vehicle, can see data for all assets OR the vehicle must be in the user's coverage or global group

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<markMessageSeen>

<inGMH>00015878</inGMH>

<markAllSeen>Y</markAllSeen>

<userOrCvg>SOMEUSER</userOrCvg>

</markMessageSeen>

</soap:Body>

Sample XML Response

<soapenv:Body>

<markMessageSeenResponse>

<markMessageSeenReturn>1</markMessageSeenReturn>

</markMessageSeenResponse>

</soapenv:Body>

Exceptions

002 Required field not specified
003 Authenticated company not specified.
004 Authenticated user not specified.
005 User is not authorized.
006 Specified GMH not found
007 Mark field is not valid
008 Internal database integrity error
009 Message not in specified users mailbox
010 Message not return or local
011 Specified user or address list does not exist
012 Mark all set to Y and user id has been specified
013 Mark all must be I if user id is an address list
014 Specified user not set to ignore message
015 Message from a user to a coverage is not eligible for ignoring