Operation storeForum |
Name: |
storeForum |
Signature: |
storeForum (forum {forum:Forum}) => storedForum {forum:Forum} |
Java signature: |
org.matrix.forum.Forum storeForum(org.matrix.forum.Forum forum) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
forum |
forum:Forum |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedForum |
forum:Forum |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeForum xmlns:ns2="http://forum.matrix.org/">
<forum>
<forumId>{xs:string}</forumId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<name>{xs:string}</name>
<description>{xs:string}</description>
<type>{forum:ForumType}</type>
<emailFrom>{xs:string}</emailFrom>
<emailTo>{xs:string}</emailTo>
<lastInputIndex>{xs:int}</lastInputIndex>
<lastOutputIndex>{xs:int}</lastOutputIndex>
<group>{xs:string}</group>
<adminRoleId>{xs:string}</adminRoleId>
<maxQuestions>{xs:int}</maxQuestions>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
</forum>
</ns2:storeForum>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeForumResponse xmlns:ns2="http://forum.matrix.org/">
<storedForum>
<forumId>{xs:string}</forumId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<name>{xs:string}</name>
<description>{xs:string}</description>
<type>{forum:ForumType}</type>
<emailFrom>{xs:string}</emailFrom>
<emailTo>{xs:string}</emailTo>
<lastInputIndex>{xs:int}</lastInputIndex>
<lastOutputIndex>{xs:int}</lastOutputIndex>
<group>{xs:string}</group>
<adminRoleId>{xs:string}</adminRoleId>
<maxQuestions>{xs:int}</maxQuestions>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
</storedForum>
</ns2:storeForumResponse>
</S:Body>
</S:Envelope> |
Operation loadQuestion |
Name: |
loadQuestion |
Signature: |
loadQuestion (questionId {xs:string}) => question {forum:Question} |
Java signature: |
org.matrix.forum.Question loadQuestion(String questionId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
questionId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
question |
forum:Question |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadQuestion xmlns:ns2="http://forum.matrix.org/">
<questionId>{xs:string}</questionId>
</ns2:loadQuestion>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadQuestionResponse xmlns:ns2="http://forum.matrix.org/">
<question>
<questionId>{xs:string}</questionId>
<forumId>{xs:string}</forumId>
<inputIndex>{xs:int}</inputIndex>
<outputIndex>{xs:int}</outputIndex>
<title>{xs:string}</title>
<text>{xs:string}</text>
<readCount>{xs:int}</readCount>
<visible>{xs:boolean}</visible>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<activityDateTime>{mx:dateTime}</activityDateTime>
</question>
</ns2:loadQuestionResponse>
</S:Body>
</S:Envelope> |
Operation storeQuestion |
Name: |
storeQuestion |
Signature: |
storeQuestion (question {forum:Question}) => storedQuestion {forum:Question} |
Java signature: |
org.matrix.forum.Question storeQuestion(org.matrix.forum.Question question) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
question |
forum:Question |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedQuestion |
forum:Question |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeQuestion xmlns:ns2="http://forum.matrix.org/">
<question>
<questionId>{xs:string}</questionId>
<forumId>{xs:string}</forumId>
<inputIndex>{xs:int}</inputIndex>
<outputIndex>{xs:int}</outputIndex>
<title>{xs:string}</title>
<text>{xs:string}</text>
<readCount>{xs:int}</readCount>
<visible>{xs:boolean}</visible>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<activityDateTime>{mx:dateTime}</activityDateTime>
</question>
</ns2:storeQuestion>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeQuestionResponse xmlns:ns2="http://forum.matrix.org/">
<storedQuestion>
<questionId>{xs:string}</questionId>
<forumId>{xs:string}</forumId>
<inputIndex>{xs:int}</inputIndex>
<outputIndex>{xs:int}</outputIndex>
<title>{xs:string}</title>
<text>{xs:string}</text>
<readCount>{xs:int}</readCount>
<visible>{xs:boolean}</visible>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<activityDateTime>{mx:dateTime}</activityDateTime>
</storedQuestion>
</ns2:storeQuestionResponse>
</S:Body>
</S:Envelope> |
Operation readQuestion |
Name: |
readQuestion |
Signature: |
readQuestion (questionId {xs:string}) => question {forum:Question} |
Java signature: |
org.matrix.forum.Question readQuestion(String questionId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
questionId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
question |
forum:Question |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:readQuestion xmlns:ns2="http://forum.matrix.org/">
<questionId>{xs:string}</questionId>
</ns2:readQuestion>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:readQuestionResponse xmlns:ns2="http://forum.matrix.org/">
<question>
<questionId>{xs:string}</questionId>
<forumId>{xs:string}</forumId>
<inputIndex>{xs:int}</inputIndex>
<outputIndex>{xs:int}</outputIndex>
<title>{xs:string}</title>
<text>{xs:string}</text>
<readCount>{xs:int}</readCount>
<visible>{xs:boolean}</visible>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<activityDateTime>{mx:dateTime}</activityDateTime>
</question>
</ns2:readQuestionResponse>
</S:Body>
</S:Envelope> |
Operation storeAnswer |
Name: |
storeAnswer |
Signature: |
storeAnswer (answer {forum:Answer}) => storedAnswer {forum:Answer} |
Java signature: |
org.matrix.forum.Answer storeAnswer(org.matrix.forum.Answer answer) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
answer |
forum:Answer |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedAnswer |
forum:Answer |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeAnswer xmlns:ns2="http://forum.matrix.org/">
<answer>
<answerId>{xs:string}</answerId>
<questionId>{xs:string}</questionId>
<text>{xs:string}</text>
<comments>{xs:string}</comments>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
</answer>
</ns2:storeAnswer>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeAnswerResponse xmlns:ns2="http://forum.matrix.org/">
<storedAnswer>
<answerId>{xs:string}</answerId>
<questionId>{xs:string}</questionId>
<text>{xs:string}</text>
<comments>{xs:string}</comments>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
</storedAnswer>
</ns2:storeAnswerResponse>
</S:Body>
</S:Envelope> |
Operation findForums |
Name: |
findForums |
Signature: |
findForums (filter {forum:ForumFilter}) => forum {forum:Forum}* |
Java signature: |
List<org.matrix.forum.Forum> findForums(org.matrix.forum.ForumFilter filter) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
filter |
forum:ForumFilter |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
forum |
forum:Forum |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findForums xmlns:ns2="http://forum.matrix.org/">
<filter>
<forumId>{xs:string}</forumId>
<name>{xs:string}</name>
<description>{xs:string}</description>
<group>{xs:string}</group>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findForums>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findForumsResponse xmlns:ns2="http://forum.matrix.org/">
<forum>
<forumId>{xs:string}</forumId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<name>{xs:string}</name>
<description>{xs:string}</description>
<type>{forum:ForumType}</type>
<emailFrom>{xs:string}</emailFrom>
<emailTo>{xs:string}</emailTo>
<lastInputIndex>{xs:int}</lastInputIndex>
<lastOutputIndex>{xs:int}</lastOutputIndex>
<group>{xs:string}</group>
<adminRoleId>{xs:string}</adminRoleId>
<maxQuestions>{xs:int}</maxQuestions>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
</forum>
</ns2:findForumsResponse>
</S:Body>
</S:Envelope> |
Operation findForumViews |
Name: |
findForumViews |
Signature: |
findForumViews (filter {forum:ForumFilter}) => forumView {forum:ForumView}* |
Java signature: |
List<org.matrix.forum.ForumView> findForumViews(org.matrix.forum.ForumFilter filter) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
filter |
forum:ForumFilter |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
forumView |
forum:ForumView |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findForumViews xmlns:ns2="http://forum.matrix.org/">
<filter>
<forumId>{xs:string}</forumId>
<name>{xs:string}</name>
<description>{xs:string}</description>
<group>{xs:string}</group>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findForumViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findForumViewsResponse xmlns:ns2="http://forum.matrix.org/">
<forumView>
<forum>
<forumId>{xs:string}</forumId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<name>{xs:string}</name>
<description>{xs:string}</description>
<type>{forum:ForumType}</type>
<emailFrom>{xs:string}</emailFrom>
<emailTo>{xs:string}</emailTo>
<lastInputIndex>{xs:int}</lastInputIndex>
<lastOutputIndex>{xs:int}</lastOutputIndex>
<group>{xs:string}</group>
<adminRoleId>{xs:string}</adminRoleId>
<maxQuestions>{xs:int}</maxQuestions>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
</forum>
<visibleQuestionCount>{xs:int}</visibleQuestionCount>
<visibleAnswerCount>{xs:int}</visibleAnswerCount>
<pendentQuestionCount>{xs:int}</pendentQuestionCount>
<editable>{xs:boolean}</editable>
<status>{forum:ForumStatus}</status>
</forumView>
</ns2:findForumViewsResponse>
</S:Body>
</S:Envelope> |
Operation countQuestionViews |
Name: |
countQuestionViews |
Signature: |
countQuestionViews (filter {forum:QuestionFilter}) => questionViewCount {xs:int} |
Java signature: |
int countQuestionViews(org.matrix.forum.QuestionFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
questionViewCount |
xs:int |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countQuestionViews xmlns:ns2="http://forum.matrix.org/">
<filter>
<questionId>{xs:string}</questionId>
<forumId>{xs:string}</forumId>
<showAnswered>{forum:ShowAnswered}</showAnswered>
<showVisible>{forum:ShowVisible}</showVisible>
<orderBy>{forum:OrderBy}</orderBy>
<creationUserId>{xs:string}</creationUserId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countQuestionViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countQuestionViewsResponse xmlns:ns2="http://forum.matrix.org/">
<questionViewCount>{xs:int}</questionViewCount>
</ns2:countQuestionViewsResponse>
</S:Body>
</S:Envelope> |
Operation findQuestionViews |
Name: |
findQuestionViews |
Signature: |
findQuestionViews (filter {forum:QuestionFilter}) => questionView {forum:QuestionView}* |
Java signature: |
List<org.matrix.forum.QuestionView> findQuestionViews(org.matrix.forum.QuestionFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
questionView |
forum:QuestionView |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findQuestionViews xmlns:ns2="http://forum.matrix.org/">
<filter>
<questionId>{xs:string}</questionId>
<forumId>{xs:string}</forumId>
<showAnswered>{forum:ShowAnswered}</showAnswered>
<showVisible>{forum:ShowVisible}</showVisible>
<orderBy>{forum:OrderBy}</orderBy>
<creationUserId>{xs:string}</creationUserId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findQuestionViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findQuestionViewsResponse xmlns:ns2="http://forum.matrix.org/">
<questionView>
<question>
<questionId>{xs:string}</questionId>
<forumId>{xs:string}</forumId>
<inputIndex>{xs:int}</inputIndex>
<outputIndex>{xs:int}</outputIndex>
<title>{xs:string}</title>
<text>{xs:string}</text>
<readCount>{xs:int}</readCount>
<visible>{xs:boolean}</visible>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<activityDateTime>{mx:dateTime}</activityDateTime>
</question>
<answer>
<answerId>{xs:string}</answerId>
<questionId>{xs:string}</questionId>
<text>{xs:string}</text>
<comments>{xs:string}</comments>
<creationUserId>{xs:string}</creationUserId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<changeUserId>{xs:string}</changeUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
</answer>
</questionView>
</ns2:findQuestionViewsResponse>
</S:Body>
</S:Envelope> |