Messages - UpdateMessageStatus - This Method updates the read status of a particular message in Learning Assistant from the Routemap.

Service URL: https://api.learningassistant.com/webservices/soap/MessageCentreSoapApi.cfc?wsdl

Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="https://api.learningassistant.com" xmlns:types="https://api.learningassistant.com/encodedTypes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <tns:authToken id="h_id1">
      <id xsi:type="xsd:string"> {id} </id>
      <uuid xsi:type="xsd:string"> {uuid} </uuid>
    </tns:authToken>
  </soap:Header>
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:UpdateMessageStatus>
      <UUIDMessage xsi:type="xsd:string"> {UUIDMessage} </UUIDMessage>
      <UUIDReadBy xsi:type="xsd:string"> {UUIDReadBy} </UUIDReadBy>
    </tns:UpdateMessageStatus>
  </soap:Body>
</soap:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <ns1:authToken loggedin="YES" xmlns="https://api.learningassistant.com" soapenv:actor="" soapenv:mustUnderstand="0" xmlns:ns1="https://api.learningassistant.com">
      <ns1:id type="xsd:string"> {id} </ns1:id>
      <ns1:uuid type="xsd:string"> {uuid} </ns1:uuid>
    </ns1:authToken>
  </soapenv:Header>
  <soapenv:Body>
    <ns2:UpdateMessageStatusResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="https://api.learningassistant.com">
      <UpdateMessageStatusReturn soapenc:arrayType="ns3:Response[1]" xsi:type="soapenc:Array" xmlns:ns3="http://messagecentre.types.soap.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
        <UpdateMessageStatusReturn xsi:type="ns3:Response">
          <Message soapenc:arrayType="ns3:ResponseMessage[1]" xsi:type="soapenc:Array">
            <Message xsi:type="ns3:ResponseMessage">
              <success xsi:type="xsd:boolean"> {success} </success>
              <szErrorDescription xsi:type="xsd:string"> {szErrorDescription} </szErrorDescription>
              <szReadStatus xsi:type="xsd:boolean"> {szReadStatus} </szReadStatus>
              <uuidMessage xsi:type="xsd:string"> {uuidMessage} </uuidMessage>
              <uuidReadBy xsi:type="xsd:string"> {uuidReadBy} </uuidReadBy>
            </Message>
          </Message>
        </UpdateMessageStatusReturn>
      </UpdateMessageStatusReturn>
    </ns2:UpdateMessageStatusResponse>
  </soapenv:Body>
</soapenv:Envelope>
Request Fields
  • UpdateMessageStatus array Required
    Top level field for UpdateMessageStatus
  • UUIDMessage string Required
    Message uuid
  • UUIDReadBy string Required
    Uuid read by
Response Fields
  • UpdateMessageStatusResponse array
    Top level field for UpdateMessageStatus
  • Message array
    Top level field for UpdateMessageStatus
  • success boolean
    Top level field for UpdateMessageStatus
  • szErrorDescription string
    Top level field for UpdateMessageStatus
  • szReadStatus boolean
    Top level field for UpdateMessageStatus
  • uuidMessage string
    Top level field for UpdateMessageStatus
  • uuidReadBy string
    Top level field for UpdateMessageStatus