Messages - GetUnreadMessages - Gets a list of unread messages from a particular users message centre in Learning Assistant.
Service URL: https://api.learningassistant.com/webservices/soap/MessageCentreSoapApi.cfc?wsdl
Request
<?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>
<authToken loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0" xmlns="https://api.learningassistant.com" xmlns:ns1="https://api.learningassistant.com">
<id type="xsd:string"> {ID} </id>
<uuid type="xsd:string"> {UUID} </uuid>
</authToken>
</soapenv:Header>
<soapenv:Body>
<ns1:GetUnreadMessages soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="https://api.learningassistant.com">
<UUIDUser xsi:type="xsd:string"> {UUIDUser} </UUIDUser>
</ns1:GetUnreadMessages>
</soapenv:Body>
</soapenv: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>
<authToken loggedin="YES" soapenv:actor="" soapenv:mustUnderstand="0" xmlns="https://api.learningassistant.com" xmlns:ns1="https://api.learningassistant.com">
<id type="xsd:string"> {ID} </id>
<uuid type="xsd:string"> {UUID} </uuid>
</authToken>
</soapenv:Header>
<soapenv:Body>
<ns2:GetUnreadMessagesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="https://api.learningassistant.com">
<GetUnreadMessagesReturn soapenc:arrayType="ns3:UnreadMessages[1]" xmlns:ns3="http://messagecentre.types.soap.webservices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:Array">
<GetUnreadMessagesReturn xsi:type="ns3:UnreadMessages">
<Messages soapenc:arrayType="ns3:Message[1]" xsi:type="soapenc:Array">
<Messages xsi:type="ns3:Message">
<szMessage xsi:type="xsd:string"> {szMessage} </szMessage>
<szMessageDate xsi:type="xsd:dateTime"> {szMessageDate} </szMessageDate>
<szMessageTitle xsi:type="xsd:string"> {szMessageTitle} </szMessageTitle>
<szReadStatus xsi:type="xsd:boolean"> {szReadStatus} </szReadStatus>
<uuidMessage xsi:type="xsd:string"> {uuidMessage} </uuidMessage>
<uuidUserFrom xsi:type="xsd:string"> {uuidUserForm} </uuidUserFrom>
<Link xsi:type="xsd:string"> {Link} </Link>
</Messages>
</Messages>
</GetUnreadMessagesReturn>
</GetUnreadMessagesReturn>
</ns2:GetUnreadMessagesResponse>
</soapenv:Body>
</soapenv:Envelope>
Request Fields
-
GetUnreadMessages array
Required
Top level field for GetUnreadMessages method
-
UUIDUser string
Required
Users uuid
Response Fields
-
GetUnreadMessagesResponse array
Top level field for GetUnreadMessages method
-
Messages array
Top level field for GetUnreadMessages method
-
szMessage string
Top level field for GetUnreadMessages method
-
szMessageDate string
Top level field for GetUnreadMessages method
-
szMessageTitle string
Top level field for GetUnreadMessages method
-
szReadStatus string
Top level field for GetUnreadMessages method
-
uuidMessage string
Top level field for GetUnreadMessages method
-
uuidUserFrom string
Top level field for GetUnreadMessages method
-
Link string
Top level field for GetUnreadMessages method