Operation loadClass |
Name: |
loadClass |
Signature: |
loadClass (classId {xs:string}, dateTime {mx:dateTime}) => class {classif:Class} |
Java signature: |
org.matrix.classif.Class loadClass(String classId, mx:dateTime dateTime) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
classId |
xs:string |
1 |
false |
false |
|
dateTime |
mx:dateTime |
1 |
true |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
class |
classif:Class |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadClass xmlns:ns2="http://classif.matrix.org/">
<classId>{xs:string}</classId>
<dateTime>{mx:dateTime}</dateTime>
</ns2:loadClass>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadClassResponse xmlns:ns2="http://classif.matrix.org/">
<class>
<classId>{xs:string}</classId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<classTypeId>{xs:string}</classTypeId>
<title>{xs:string}</title>
<description>{xs:string}</description>
<location>{xs:string}</location>
<offlineDownload>{xs:boolean}</offlineDownload>
<superClassId>{xs:string}</superClassId>
<accessControlUserId>{xs:string}</accessControlUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
<changeReason>{xs:string}</changeReason>
</class>
</ns2:loadClassResponse>
</S:Body>
</S:Envelope> |
Operation storeClass |
Name: |
storeClass |
Signature: |
storeClass (class {classif:Class}) => storedClass {classif:Class} |
Java signature: |
org.matrix.classif.Class storeClass(org.matrix.classif.Class class) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
class |
classif:Class |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedClass |
classif:Class |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeClass xmlns:ns2="http://classif.matrix.org/">
<class>
<classId>{xs:string}</classId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<classTypeId>{xs:string}</classTypeId>
<title>{xs:string}</title>
<description>{xs:string}</description>
<location>{xs:string}</location>
<offlineDownload>{xs:boolean}</offlineDownload>
<superClassId>{xs:string}</superClassId>
<accessControlUserId>{xs:string}</accessControlUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
<changeReason>{xs:string}</changeReason>
</class>
</ns2:storeClass>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeClassResponse xmlns:ns2="http://classif.matrix.org/">
<storedClass>
<classId>{xs:string}</classId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<classTypeId>{xs:string}</classTypeId>
<title>{xs:string}</title>
<description>{xs:string}</description>
<location>{xs:string}</location>
<offlineDownload>{xs:boolean}</offlineDownload>
<superClassId>{xs:string}</superClassId>
<accessControlUserId>{xs:string}</accessControlUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
<changeReason>{xs:string}</changeReason>
</storedClass>
</ns2:storeClassResponse>
</S:Body>
</S:Envelope> |
Operation findClasses |
Name: |
findClasses |
Signature: |
findClasses (filter {classif:ClassFilter}) => class {classif:Class}* |
Java signature: |
List<org.matrix.classif.Class> findClasses(org.matrix.classif.ClassFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
class |
classif:Class |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findClasses xmlns:ns2="http://classif.matrix.org/">
<filter>
<classId>{xs:string}</classId>
<title>{xs:string}</title>
<superClassId>{xs:string}</superClassId>
<description>{xs:string}</description>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findClasses>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findClassesResponse xmlns:ns2="http://classif.matrix.org/">
<class>
<classId>{xs:string}</classId>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<classTypeId>{xs:string}</classTypeId>
<title>{xs:string}</title>
<description>{xs:string}</description>
<location>{xs:string}</location>
<offlineDownload>{xs:boolean}</offlineDownload>
<superClassId>{xs:string}</superClassId>
<accessControlUserId>{xs:string}</accessControlUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
<changeReason>{xs:string}</changeReason>
</class>
</ns2:findClassesResponse>
</S:Body>
</S:Envelope> |
Operation countClasses |
Name: |
countClasses |
Signature: |
countClasses (filter {classif:ClassFilter}) => classCount {xs:int} |
Java signature: |
int countClasses(org.matrix.classif.ClassFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
classCount |
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:countClasses xmlns:ns2="http://classif.matrix.org/">
<filter>
<classId>{xs:string}</classId>
<title>{xs:string}</title>
<superClassId>{xs:string}</superClassId>
<description>{xs:string}</description>
<startDateTime>{mx:dateTime}</startDateTime>
<endDateTime>{mx:dateTime}</endDateTime>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countClasses>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countClassesResponse xmlns:ns2="http://classif.matrix.org/">
<classCount>{xs:int}</classCount>
</ns2:countClassesResponse>
</S:Body>
</S:Envelope> |
Operation listModifiedClasses |
Name: |
listModifiedClasses |
Signature: |
listModifiedClasses (dateTime1 {xs:string}, dateTime2 {xs:string}) => classId {xs:string}* |
Java signature: |
List<String> listModifiedClasses(String dateTime1, String dateTime2) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
dateTime1 |
xs:string |
1 |
false |
false |
|
dateTime2 |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
classId |
xs:string |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listModifiedClasses xmlns:ns2="http://classif.matrix.org/">
<dateTime1>{xs:string}</dateTime1>
<dateTime2>{xs:string}</dateTime2>
</ns2:listModifiedClasses>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listModifiedClassesResponse xmlns:ns2="http://classif.matrix.org/">
<classId>{xs:string}</classId>
</ns2:listModifiedClassesResponse>
</S:Body>
</S:Envelope> |