EndPreviousNextEnd EndPrint This TopicEnd

SetNotificationAsRead

Once a notification has been viewed by your user, you should let the server know that it has been read (if it wasn’t already flagged as read)

 

Data to be passed to the webservice

Variable name

Data type

Description

authToken

String

The (logged in) authentication token for your session

uniqueIdentifier

String

The unique identifier of the notification that you want to flag as read

 

Data which is returned

Variable name

Data type

Description

errorCode

String

If your request was successful, the errorCode will be 0

If your request had a problem, there will be an error code for each kind of problem

errorMessage

String

A description of the problem with your error request (if there was a problem)

If your request was successful, this will be an empty string

 

Example XML for a GetAllNotifications request

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <SetNotificationAsRead xmlns="http://contegro.com/">

      <authToken>14ffdfd6-78c3-4fc0-9c63-3902011640af</authToken>

      <uniqueIdentifier>11342_2606</uniqueIdentifier>

    </SetNotificationAsRead>

  </soap:Body>

</soap:Envelope>

 

 

Example XML which is returned

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <SetNotificationAsReadResponse xmlns="http://contegro.com/">

      <SetNotificationAsReadResult>

        <errorCode>0</errorCode>

        <errorMessage></errorMessage>

      </SetNotificationAsReadResult>

    </SetNotificationAsReadResponse>

  </soap:Body>

</soap:Envelope>

 

 

Topic Link