Reference for http://apisandbox.inapub.co.uk/api.svc/user/CGC/{ID}/messages/?page={PG}&appID={APPID}
Get a page of forum messages for a given CGC, returned as XML by default.
Url: http://apisandbox.inapub.co.uk/api.svc/user/CGC/{ID}/messages/?page={PG}&appID={APPID}
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<ForumMessages xmlns="http://schemas.datacontract.org/2004/07/EventilityAPI.DataContracts"> <ForumMessagesList> <ForumMessages.ForumMessage> <CommunityId>2147483647</CommunityId> <CommunityMemberId>2147483647</CommunityMemberId> <DateStamp>1999-05-31T11:20:00</DateStamp> <Message>String content</Message> <MessageId>2147483647</MessageId> </ForumMessages.ForumMessage> <ForumMessages.ForumMessage> <CommunityId>2147483647</CommunityId> <CommunityMemberId>2147483647</CommunityMemberId> <DateStamp>1999-05-31T11:20:00</DateStamp> <Message>String content</Message> <MessageId>2147483647</MessageId> </ForumMessages.ForumMessage> </ForumMessagesList> <TotalForumMessageCount>2147483647</TotalForumMessageCount> </ForumMessages>
The following is an example response Json body:
{ "ForumMessagesList":[{ "CommunityId":2147483647, "CommunityMemberId":2147483647, "DateStamp":"\/Date(928146000000+0100)\/", "Message":"String content", "MessageId":2147483647 }], "TotalForumMessageCount":2147483647 }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/EventilityAPI.DataContracts" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/EventilityAPI.DataContracts" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ForumMessages"> <xs:sequence> <xs:element minOccurs="0" name="ForumMessagesList" nillable="true" type="tns:ArrayOfForumMessages.ForumMessage" /> <xs:element minOccurs="0" name="TotalForumMessageCount" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ForumMessages" nillable="true" type="tns:ForumMessages" /> <xs:complexType name="ArrayOfForumMessages.ForumMessage"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="ForumMessages.ForumMessage" nillable="true" type="tns:ForumMessages.ForumMessage" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfForumMessages.ForumMessage" nillable="true" type="tns:ArrayOfForumMessages.ForumMessage" /> <xs:complexType name="ForumMessages.ForumMessage"> <xs:sequence> <xs:element minOccurs="0" name="CommunityId" type="xs:int" /> <xs:element minOccurs="0" name="CommunityMemberId" type="xs:int" /> <xs:element minOccurs="0" name="DateStamp" type="xs:dateTime" /> <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="MessageId" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ForumMessages.ForumMessage" nillable="true" type="tns:ForumMessages.ForumMessage" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>