Operation getKernelMetaData |
Name: |
getKernelMetaData |
Signature: |
getKernelMetaData () => kernelMetaData {kernel:KernelMetaData} |
Java signature: |
org.matrix.kernel.KernelMetaData getKernelMetaData() |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getKernelMetaData xmlns:ns2="http://kernel.matrix.org/">
</ns2:getKernelMetaData>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getKernelMetaDataResponse xmlns:ns2="http://kernel.matrix.org/">
<kernelMetaData>
</kernelMetaData>
</ns2:getKernelMetaDataResponse>
</S:Body>
</S:Envelope> |
Operation storePerson |
Name: |
storePerson |
Signature: |
storePerson (person {kernel:Person}) => storedPerson {kernel:Person} |
Java signature: |
org.matrix.kernel.Person storePerson(org.matrix.kernel.Person person) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
person |
kernel:Person |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedPerson |
kernel:Person |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePerson xmlns:ns2="http://kernel.matrix.org/">
<person>
<personId>{xs:string}</personId>
<personTypeId>{xs:string}</personTypeId>
<name>{xs:string}</name>
<firstParticle>{xs:string}</firstParticle>
<firstSurname>{xs:string}</firstSurname>
<secondParticle>{xs:string}</secondParticle>
<secondSurname>{xs:string}</secondSurname>
<sex>{kernel:Sex}</sex>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<birthDate>{mx:date}</birthDate>
<nationalityId>{xs:string}</nationalityId>
<birthCityId>{xs:string}</birthCityId>
<fatherName>{xs:string}</fatherName>
<motherName>{xs:string}</motherName>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</person>
</ns2:storePerson>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonResponse xmlns:ns2="http://kernel.matrix.org/">
<storedPerson>
<personId>{xs:string}</personId>
<personTypeId>{xs:string}</personTypeId>
<name>{xs:string}</name>
<firstParticle>{xs:string}</firstParticle>
<firstSurname>{xs:string}</firstSurname>
<secondParticle>{xs:string}</secondParticle>
<secondSurname>{xs:string}</secondSurname>
<sex>{kernel:Sex}</sex>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<birthDate>{mx:date}</birthDate>
<nationalityId>{xs:string}</nationalityId>
<birthCityId>{xs:string}</birthCityId>
<fatherName>{xs:string}</fatherName>
<motherName>{xs:string}</motherName>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</storedPerson>
</ns2:storePersonResponse>
</S:Body>
</S:Envelope> |
Operation countPersons |
Name: |
countPersons |
Signature: |
countPersons (filter {kernel:PersonFilter}) => personCount {xs:int} |
Java signature: |
int countPersons(org.matrix.kernel.PersonFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
personCount |
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:countPersons xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<name>{xs:string}</name>
<firstSurname>{xs:string}</firstSurname>
<secondSurname>{xs:string}</secondSurname>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countPersons>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countPersonsResponse xmlns:ns2="http://kernel.matrix.org/">
<personCount>{xs:int}</personCount>
</ns2:countPersonsResponse>
</S:Body>
</S:Envelope> |
Operation findPersons |
Name: |
findPersons |
Signature: |
findPersons (filter {kernel:PersonFilter}) => person {kernel:Person}* |
Java signature: |
List<org.matrix.kernel.Person> findPersons(org.matrix.kernel.PersonFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
person |
kernel:Person |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersons xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<name>{xs:string}</name>
<firstSurname>{xs:string}</firstSurname>
<secondSurname>{xs:string}</secondSurname>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findPersons>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonsResponse xmlns:ns2="http://kernel.matrix.org/">
<person>
<personId>{xs:string}</personId>
<personTypeId>{xs:string}</personTypeId>
<name>{xs:string}</name>
<firstParticle>{xs:string}</firstParticle>
<firstSurname>{xs:string}</firstSurname>
<secondParticle>{xs:string}</secondParticle>
<secondSurname>{xs:string}</secondSurname>
<sex>{kernel:Sex}</sex>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<birthDate>{mx:date}</birthDate>
<nationalityId>{xs:string}</nationalityId>
<birthCityId>{xs:string}</birthCityId>
<fatherName>{xs:string}</fatherName>
<motherName>{xs:string}</motherName>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</person>
</ns2:findPersonsResponse>
</S:Body>
</S:Envelope> |
Operation findPersonViews |
Name: |
findPersonViews |
Signature: |
findPersonViews (filter {kernel:PersonFilter}) => personView {kernel:PersonView}* |
Java signature: |
List<org.matrix.kernel.PersonView> findPersonViews(org.matrix.kernel.PersonFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
personView |
kernel:PersonView |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<name>{xs:string}</name>
<firstSurname>{xs:string}</firstSurname>
<secondSurname>{xs:string}</secondSurname>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findPersonViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<personView>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</personView>
</ns2:findPersonViewsResponse>
</S:Body>
</S:Envelope> |
Operation storeContact |
Name: |
storeContact |
Signature: |
storeContact (contact {kernel:Contact}) => storedContact {kernel:Contact} |
Java signature: |
org.matrix.kernel.Contact storeContact(org.matrix.kernel.Contact contact) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
contact |
kernel:Contact |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedContact |
kernel:Contact |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeContact xmlns:ns2="http://kernel.matrix.org/">
<contact>
<contactId>{xs:string}</contactId>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<contactTypeId>{xs:string}</contactTypeId>
<value>{xs:string}</value>
<comments>{xs:string}</comments>
</contact>
</ns2:storeContact>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeContactResponse xmlns:ns2="http://kernel.matrix.org/">
<storedContact>
<contactId>{xs:string}</contactId>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<contactTypeId>{xs:string}</contactTypeId>
<value>{xs:string}</value>
<comments>{xs:string}</comments>
</storedContact>
</ns2:storeContactResponse>
</S:Body>
</S:Envelope> |
Operation countContacts |
Name: |
countContacts |
Signature: |
countContacts (filter {kernel:ContactFilter}) => contactCount {xs:int} |
Java signature: |
int countContacts(org.matrix.kernel.ContactFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
contactCount |
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:countContacts xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<contactTypeId>{xs:string}</contactTypeId>
<value>{xs:string}</value>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countContacts>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countContactsResponse xmlns:ns2="http://kernel.matrix.org/">
<contactCount>{xs:int}</contactCount>
</ns2:countContactsResponse>
</S:Body>
</S:Envelope> |
Operation findContactViews |
Name: |
findContactViews |
Signature: |
findContactViews (filter {kernel:ContactFilter}) => contactView {kernel:ContactView}* |
Java signature: |
List<org.matrix.kernel.ContactView> findContactViews(org.matrix.kernel.ContactFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
contactView |
kernel:ContactView |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findContactViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<contactTypeId>{xs:string}</contactTypeId>
<value>{xs:string}</value>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findContactViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findContactViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<contactView>
<contactId>{xs:string}</contactId>
<contactTypeId>{xs:string}</contactTypeId>
<contactTypeLabel>{xs:string}</contactTypeLabel>
<value>{xs:string}</value>
<comments>{xs:string}</comments>
<person>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</person>
<address>
<addressId>{xs:string}</addressId>
<description>{xs:string}</description>
<city>{xs:string}</city>
<province>{xs:string}</province>
<country>{xs:string}</country>
<addressTypeId>{xs:string}</addressTypeId>
</address>
</contactView>
</ns2:findContactViewsResponse>
</S:Body>
</S:Envelope> |
Operation loadAddress |
Name: |
loadAddress |
Signature: |
loadAddress (addressId {xs:string}) => address {kernel:Address} |
Java signature: |
org.matrix.kernel.Address loadAddress(String addressId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
addressId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
address |
kernel:Address |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadAddress xmlns:ns2="http://kernel.matrix.org/">
<addressId>{xs:string}</addressId>
</ns2:loadAddress>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadAddressResponse xmlns:ns2="http://kernel.matrix.org/">
<address>
<addressId>{xs:string}</addressId>
<streetId>{xs:string}</streetId>
<addressTypeId>{xs:string}</addressTypeId>
<number1>{xs:string}</number1>
<number2>{xs:string}</number2>
<bis1>{xs:string}</bis1>
<bis2>{xs:string}</bis2>
<km>{xs:double}</km>
<block>{xs:string}</block>
<entranceHall>{xs:string}</entranceHall>
<stair>{xs:string}</stair>
<floor>{xs:string}</floor>
<door>{xs:string}</door>
<postalCode>{xs:string}</postalCode>
<postOfficeBox>{xs:string}</postOfficeBox>
<gisReference>{xs:string}</gisReference>
<cadastralReference>{xs:string}</cadastralReference>
<civ>{xs:string}</civ>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</address>
</ns2:loadAddressResponse>
</S:Body>
</S:Envelope> |
Operation storeAddress |
Name: |
storeAddress |
Signature: |
storeAddress (address {kernel:Address}) => storedAddress {kernel:Address} |
Java signature: |
org.matrix.kernel.Address storeAddress(org.matrix.kernel.Address address) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
address |
kernel:Address |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedAddress |
kernel:Address |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeAddress xmlns:ns2="http://kernel.matrix.org/">
<address>
<addressId>{xs:string}</addressId>
<streetId>{xs:string}</streetId>
<addressTypeId>{xs:string}</addressTypeId>
<number1>{xs:string}</number1>
<number2>{xs:string}</number2>
<bis1>{xs:string}</bis1>
<bis2>{xs:string}</bis2>
<km>{xs:double}</km>
<block>{xs:string}</block>
<entranceHall>{xs:string}</entranceHall>
<stair>{xs:string}</stair>
<floor>{xs:string}</floor>
<door>{xs:string}</door>
<postalCode>{xs:string}</postalCode>
<postOfficeBox>{xs:string}</postOfficeBox>
<gisReference>{xs:string}</gisReference>
<cadastralReference>{xs:string}</cadastralReference>
<civ>{xs:string}</civ>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</address>
</ns2:storeAddress>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeAddressResponse xmlns:ns2="http://kernel.matrix.org/">
<storedAddress>
<addressId>{xs:string}</addressId>
<streetId>{xs:string}</streetId>
<addressTypeId>{xs:string}</addressTypeId>
<number1>{xs:string}</number1>
<number2>{xs:string}</number2>
<bis1>{xs:string}</bis1>
<bis2>{xs:string}</bis2>
<km>{xs:double}</km>
<block>{xs:string}</block>
<entranceHall>{xs:string}</entranceHall>
<stair>{xs:string}</stair>
<floor>{xs:string}</floor>
<door>{xs:string}</door>
<postalCode>{xs:string}</postalCode>
<postOfficeBox>{xs:string}</postOfficeBox>
<gisReference>{xs:string}</gisReference>
<cadastralReference>{xs:string}</cadastralReference>
<civ>{xs:string}</civ>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</storedAddress>
</ns2:storeAddressResponse>
</S:Body>
</S:Envelope> |
Operation countAddresses |
Name: |
countAddresses |
Signature: |
countAddresses (filter {kernel:AddressFilter}) => addressCount {xs:int} |
Java signature: |
int countAddresses(org.matrix.kernel.AddressFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
addressCount |
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:countAddresses xmlns:ns2="http://kernel.matrix.org/">
<filter>
<addressIdList>{xs:string}</addressIdList>
<description>{xs:string}</description>
<countryName>{xs:string}</countryName>
<cityName>{xs:string}</cityName>
<streetName>{xs:string}</streetName>
<number>{xs:string}</number>
<km>{xs:double}</km>
<block>{xs:string}</block>
<entranceHall>{xs:string}</entranceHall>
<stair>{xs:string}</stair>
<floor>{xs:string}</floor>
<door>{xs:string}</door>
<postalCode>{xs:string}</postalCode>
<postOfficeBox>{xs:string}</postOfficeBox>
<gisReference>{xs:string}</gisReference>
<cadastralReference>{xs:string}</cadastralReference>
<civ>{xs:string}</civ>
<comments>{xs:string}</comments>
<addressTypeId>{xs:string}</addressTypeId>
<streetTypeId>{xs:string}</streetTypeId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countAddresses>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countAddressesResponse xmlns:ns2="http://kernel.matrix.org/">
<addressCount>{xs:int}</addressCount>
</ns2:countAddressesResponse>
</S:Body>
</S:Envelope> |
Operation findAddresses |
Name: |
findAddresses |
Signature: |
findAddresses (filter {kernel:AddressFilter}) => address {kernel:Address}* |
Java signature: |
List<org.matrix.kernel.Address> findAddresses(org.matrix.kernel.AddressFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
address |
kernel:Address |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findAddresses xmlns:ns2="http://kernel.matrix.org/">
<filter>
<addressIdList>{xs:string}</addressIdList>
<description>{xs:string}</description>
<countryName>{xs:string}</countryName>
<cityName>{xs:string}</cityName>
<streetName>{xs:string}</streetName>
<number>{xs:string}</number>
<km>{xs:double}</km>
<block>{xs:string}</block>
<entranceHall>{xs:string}</entranceHall>
<stair>{xs:string}</stair>
<floor>{xs:string}</floor>
<door>{xs:string}</door>
<postalCode>{xs:string}</postalCode>
<postOfficeBox>{xs:string}</postOfficeBox>
<gisReference>{xs:string}</gisReference>
<cadastralReference>{xs:string}</cadastralReference>
<civ>{xs:string}</civ>
<comments>{xs:string}</comments>
<addressTypeId>{xs:string}</addressTypeId>
<streetTypeId>{xs:string}</streetTypeId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findAddresses>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findAddressesResponse xmlns:ns2="http://kernel.matrix.org/">
<address>
<addressId>{xs:string}</addressId>
<streetId>{xs:string}</streetId>
<addressTypeId>{xs:string}</addressTypeId>
<number1>{xs:string}</number1>
<number2>{xs:string}</number2>
<bis1>{xs:string}</bis1>
<bis2>{xs:string}</bis2>
<km>{xs:double}</km>
<block>{xs:string}</block>
<entranceHall>{xs:string}</entranceHall>
<stair>{xs:string}</stair>
<floor>{xs:string}</floor>
<door>{xs:string}</door>
<postalCode>{xs:string}</postalCode>
<postOfficeBox>{xs:string}</postOfficeBox>
<gisReference>{xs:string}</gisReference>
<cadastralReference>{xs:string}</cadastralReference>
<civ>{xs:string}</civ>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</address>
</ns2:findAddressesResponse>
</S:Body>
</S:Envelope> |
Operation findAddressViews |
Name: |
findAddressViews |
Signature: |
findAddressViews (filter {kernel:AddressFilter}) => addressView {kernel:AddressView}* |
Java signature: |
List<org.matrix.kernel.AddressView> findAddressViews(org.matrix.kernel.AddressFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
addressView |
kernel:AddressView |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findAddressViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<addressIdList>{xs:string}</addressIdList>
<description>{xs:string}</description>
<countryName>{xs:string}</countryName>
<cityName>{xs:string}</cityName>
<streetName>{xs:string}</streetName>
<number>{xs:string}</number>
<km>{xs:double}</km>
<block>{xs:string}</block>
<entranceHall>{xs:string}</entranceHall>
<stair>{xs:string}</stair>
<floor>{xs:string}</floor>
<door>{xs:string}</door>
<postalCode>{xs:string}</postalCode>
<postOfficeBox>{xs:string}</postOfficeBox>
<gisReference>{xs:string}</gisReference>
<cadastralReference>{xs:string}</cadastralReference>
<civ>{xs:string}</civ>
<comments>{xs:string}</comments>
<addressTypeId>{xs:string}</addressTypeId>
<streetTypeId>{xs:string}</streetTypeId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findAddressViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findAddressViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<addressView>
<addressId>{xs:string}</addressId>
<description>{xs:string}</description>
<city>{xs:string}</city>
<province>{xs:string}</province>
<country>{xs:string}</country>
<addressTypeId>{xs:string}</addressTypeId>
</addressView>
</ns2:findAddressViewsResponse>
</S:Body>
</S:Envelope> |
Operation loadPersonAddress |
Name: |
loadPersonAddress |
Signature: |
loadPersonAddress (personAddressId {xs:string}) => personAddress {kernel:PersonAddress} |
Java signature: |
org.matrix.kernel.PersonAddress loadPersonAddress(String personAddressId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personAddressId |
xs:string |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonAddress xmlns:ns2="http://kernel.matrix.org/">
<personAddressId>{xs:string}</personAddressId>
</ns2:loadPersonAddress>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonAddressResponse xmlns:ns2="http://kernel.matrix.org/">
<personAddress>
<personAddressId>{xs:string}</personAddressId>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<personAddressTypeId>{xs:string}</personAddressTypeId>
</personAddress>
</ns2:loadPersonAddressResponse>
</S:Body>
</S:Envelope> |
Operation storePersonAddress |
Name: |
storePersonAddress |
Signature: |
storePersonAddress (personAddress {kernel:PersonAddress}) => storedPersonAddress {kernel:PersonAddress} |
Java signature: |
org.matrix.kernel.PersonAddress storePersonAddress(org.matrix.kernel.PersonAddress personAddress) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedPersonAddress |
kernel:PersonAddress |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonAddress xmlns:ns2="http://kernel.matrix.org/">
<personAddress>
<personAddressId>{xs:string}</personAddressId>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<personAddressTypeId>{xs:string}</personAddressTypeId>
</personAddress>
</ns2:storePersonAddress>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonAddressResponse xmlns:ns2="http://kernel.matrix.org/">
<storedPersonAddress>
<personAddressId>{xs:string}</personAddressId>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<personAddressTypeId>{xs:string}</personAddressTypeId>
</storedPersonAddress>
</ns2:storePersonAddressResponse>
</S:Body>
</S:Envelope> |
Operation removePersonAddress |
Name: |
removePersonAddress |
Signature: |
removePersonAddress (personAddressId {xs:string}) => removed {xs:boolean} |
Java signature: |
boolean removePersonAddress(String personAddressId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personAddressId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
removed |
xs:boolean |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonAddress xmlns:ns2="http://kernel.matrix.org/">
<personAddressId>{xs:string}</personAddressId>
</ns2:removePersonAddress>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonAddressResponse xmlns:ns2="http://kernel.matrix.org/">
<removed>{xs:boolean}</removed>
</ns2:removePersonAddressResponse>
</S:Body>
</S:Envelope> |
Operation countPersonAddresses |
Name: |
countPersonAddresses |
Signature: |
countPersonAddresses (filter {kernel:PersonAddressFilter}) => personAddressCount {xs:int} |
Java signature: |
int countPersonAddresses(org.matrix.kernel.PersonAddressFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
personAddressCount |
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:countPersonAddresses xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countPersonAddresses>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countPersonAddressesResponse xmlns:ns2="http://kernel.matrix.org/">
<personAddressCount>{xs:int}</personAddressCount>
</ns2:countPersonAddressesResponse>
</S:Body>
</S:Envelope> |
Operation findPersonAddressViews |
Name: |
findPersonAddressViews |
Signature: |
findPersonAddressViews (filter {kernel:PersonAddressFilter}) => personAddressView {kernel:PersonAddressView}* |
Java signature: |
List<org.matrix.kernel.PersonAddressView> findPersonAddressViews(org.matrix.kernel.PersonAddressFilter filter) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonAddressViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<addressId>{xs:string}</addressId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findPersonAddressViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonAddressViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<personAddressView>
<personAddressId>{xs:string}</personAddressId>
<person>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</person>
<address>
<addressId>{xs:string}</addressId>
<description>{xs:string}</description>
<city>{xs:string}</city>
<province>{xs:string}</province>
<country>{xs:string}</country>
<addressTypeId>{xs:string}</addressTypeId>
</address>
</personAddressView>
</ns2:findPersonAddressViewsResponse>
</S:Body>
</S:Envelope> |
Operation loadPersonRepresentant |
Name: |
loadPersonRepresentant |
Signature: |
loadPersonRepresentant (personRepresentantId {xs:string}) => personRepresentant {kernel:PersonRepresentant} |
Java signature: |
org.matrix.kernel.PersonRepresentant loadPersonRepresentant(String personRepresentantId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personRepresentantId |
xs:string |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonRepresentant xmlns:ns2="http://kernel.matrix.org/">
<personRepresentantId>{xs:string}</personRepresentantId>
</ns2:loadPersonRepresentant>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonRepresentantResponse xmlns:ns2="http://kernel.matrix.org/">
<personRepresentant>
<personRepresentantId>{xs:string}</personRepresentantId>
<personId>{xs:string}</personId>
<representantId>{xs:string}</representantId>
<representationTypeId>{xs:string}</representationTypeId>
<comments>{xs:string}</comments>
</personRepresentant>
</ns2:loadPersonRepresentantResponse>
</S:Body>
</S:Envelope> |
Operation storePersonRepresentant |
Name: |
storePersonRepresentant |
Signature: |
storePersonRepresentant (personRepresentant {kernel:PersonRepresentant}) => storedPersonRepresentant {kernel:PersonRepresentant} |
Java signature: |
org.matrix.kernel.PersonRepresentant storePersonRepresentant(org.matrix.kernel.PersonRepresentant personRepresentant) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonRepresentant xmlns:ns2="http://kernel.matrix.org/">
<personRepresentant>
<personRepresentantId>{xs:string}</personRepresentantId>
<personId>{xs:string}</personId>
<representantId>{xs:string}</representantId>
<representationTypeId>{xs:string}</representationTypeId>
<comments>{xs:string}</comments>
</personRepresentant>
</ns2:storePersonRepresentant>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonRepresentantResponse xmlns:ns2="http://kernel.matrix.org/">
<storedPersonRepresentant>
<personRepresentantId>{xs:string}</personRepresentantId>
<personId>{xs:string}</personId>
<representantId>{xs:string}</representantId>
<representationTypeId>{xs:string}</representationTypeId>
<comments>{xs:string}</comments>
</storedPersonRepresentant>
</ns2:storePersonRepresentantResponse>
</S:Body>
</S:Envelope> |
Operation removePersonRepresentant |
Name: |
removePersonRepresentant |
Signature: |
removePersonRepresentant (personRepresentantId {xs:string}) => removed {xs:boolean} |
Java signature: |
boolean removePersonRepresentant(String personRepresentantId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personRepresentantId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
removed |
xs:boolean |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonRepresentant xmlns:ns2="http://kernel.matrix.org/">
<personRepresentantId>{xs:string}</personRepresentantId>
</ns2:removePersonRepresentant>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonRepresentantResponse xmlns:ns2="http://kernel.matrix.org/">
<removed>{xs:boolean}</removed>
</ns2:removePersonRepresentantResponse>
</S:Body>
</S:Envelope> |
Operation findPersonRepresentantViews |
Name: |
findPersonRepresentantViews |
Signature: |
findPersonRepresentantViews (filter {kernel:PersonRepresentantFilter}) => personRepresentantView {kernel:PersonRepresentantView}* |
Java signature: |
List<org.matrix.kernel.PersonRepresentantView> findPersonRepresentantViews(org.matrix.kernel.PersonRepresentantFilter filter) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonRepresentantViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<representantId>{xs:string}</representantId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findPersonRepresentantViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonRepresentantViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<personRepresentantView>
<personRepresentantId>{xs:string}</personRepresentantId>
<person>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</person>
<representant>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</representant>
<representationTypeId>{xs:string}</representationTypeId>
</personRepresentantView>
</ns2:findPersonRepresentantViewsResponse>
</S:Body>
</S:Envelope> |
Operation loadPersonPerson |
Name: |
loadPersonPerson |
Signature: |
loadPersonPerson (personPersonId {xs:string}) => personPerson {kernel:PersonPerson} |
Java signature: |
org.matrix.kernel.PersonPerson loadPersonPerson(String personPersonId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personPersonId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
personPerson |
kernel:PersonPerson |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonPerson xmlns:ns2="http://kernel.matrix.org/">
<personPersonId>{xs:string}</personPersonId>
</ns2:loadPersonPerson>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonPersonResponse xmlns:ns2="http://kernel.matrix.org/">
<personPerson>
<personPersonId>{xs:string}</personPersonId>
<personId>{xs:string}</personId>
<relPersonId>{xs:string}</relPersonId>
<personPersonTypeId>{xs:string}</personPersonTypeId>
<comments>{xs:string}</comments>
</personPerson>
</ns2:loadPersonPersonResponse>
</S:Body>
</S:Envelope> |
Operation storePersonPerson |
Name: |
storePersonPerson |
Signature: |
storePersonPerson (personPerson {kernel:PersonPerson}) => storedPersonPerson {kernel:PersonPerson} |
Java signature: |
org.matrix.kernel.PersonPerson storePersonPerson(org.matrix.kernel.PersonPerson personPerson) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personPerson |
kernel:PersonPerson |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedPersonPerson |
kernel:PersonPerson |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonPerson xmlns:ns2="http://kernel.matrix.org/">
<personPerson>
<personPersonId>{xs:string}</personPersonId>
<personId>{xs:string}</personId>
<relPersonId>{xs:string}</relPersonId>
<personPersonTypeId>{xs:string}</personPersonTypeId>
<comments>{xs:string}</comments>
</personPerson>
</ns2:storePersonPerson>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonPersonResponse xmlns:ns2="http://kernel.matrix.org/">
<storedPersonPerson>
<personPersonId>{xs:string}</personPersonId>
<personId>{xs:string}</personId>
<relPersonId>{xs:string}</relPersonId>
<personPersonTypeId>{xs:string}</personPersonTypeId>
<comments>{xs:string}</comments>
</storedPersonPerson>
</ns2:storePersonPersonResponse>
</S:Body>
</S:Envelope> |
Operation removePersonPerson |
Name: |
removePersonPerson |
Signature: |
removePersonPerson (personPersonId {xs:string}) => removed {xs:boolean} |
Java signature: |
boolean removePersonPerson(String personPersonId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personPersonId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
removed |
xs:boolean |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonPerson xmlns:ns2="http://kernel.matrix.org/">
<personPersonId>{xs:string}</personPersonId>
</ns2:removePersonPerson>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonPersonResponse xmlns:ns2="http://kernel.matrix.org/">
<removed>{xs:boolean}</removed>
</ns2:removePersonPersonResponse>
</S:Body>
</S:Envelope> |
Operation findPersonPersonViews |
Name: |
findPersonPersonViews |
Signature: |
findPersonPersonViews (filter {kernel:PersonPersonFilter}) => personPersonView {kernel:PersonPersonView}* |
Java signature: |
List<org.matrix.kernel.PersonPersonView> findPersonPersonViews(org.matrix.kernel.PersonPersonFilter filter) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonPersonViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<personId>{xs:string}</personId>
<relPersonId>{xs:string}</relPersonId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findPersonPersonViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonPersonViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<personPersonView>
<personPersonId>{xs:string}</personPersonId>
<personView>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</personView>
<relPersonView>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</relPersonView>
<personPersonTypeId>{xs:string}</personPersonTypeId>
</personPersonView>
</ns2:findPersonPersonViewsResponse>
</S:Body>
</S:Envelope> |
Operation loadPersonDocument |
Name: |
loadPersonDocument |
Signature: |
loadPersonDocument (personDocId {xs:string}) => personDocument {kernel:PersonDocument} |
Java signature: |
org.matrix.kernel.PersonDocument loadPersonDocument(String personDocId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personDocId |
xs:string |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonDocument xmlns:ns2="http://kernel.matrix.org/">
<personDocId>{xs:string}</personDocId>
</ns2:loadPersonDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadPersonDocumentResponse xmlns:ns2="http://kernel.matrix.org/">
<personDocument>
<personDocId>{xs:string}</personDocId>
<docId>{xs:string}</docId>
<version>{xs:int}</version>
<personId>{xs:string}</personId>
<personDocTypeId>{xs:string}</personDocTypeId>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</personDocument>
</ns2:loadPersonDocumentResponse>
</S:Body>
</S:Envelope> |
Operation storePersonDocument |
Name: |
storePersonDocument |
Signature: |
storePersonDocument (personDocument {kernel:PersonDocument}) => storedPersonDocument {kernel:PersonDocument} |
Java signature: |
org.matrix.kernel.PersonDocument storePersonDocument(org.matrix.kernel.PersonDocument personDocument) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedPersonDocument |
kernel:PersonDocument |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonDocument xmlns:ns2="http://kernel.matrix.org/">
<personDocument>
<personDocId>{xs:string}</personDocId>
<docId>{xs:string}</docId>
<version>{xs:int}</version>
<personId>{xs:string}</personId>
<personDocTypeId>{xs:string}</personDocTypeId>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</personDocument>
</ns2:storePersonDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storePersonDocumentResponse xmlns:ns2="http://kernel.matrix.org/">
<storedPersonDocument>
<personDocId>{xs:string}</personDocId>
<docId>{xs:string}</docId>
<version>{xs:int}</version>
<personId>{xs:string}</personId>
<personDocTypeId>{xs:string}</personDocTypeId>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</storedPersonDocument>
</ns2:storePersonDocumentResponse>
</S:Body>
</S:Envelope> |
Operation removePersonDocument |
Name: |
removePersonDocument |
Signature: |
removePersonDocument (personDocId {xs:string}) => removed {xs:boolean} |
Java signature: |
boolean removePersonDocument(String personDocId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
personDocId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
removed |
xs:boolean |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonDocument xmlns:ns2="http://kernel.matrix.org/">
<personDocId>{xs:string}</personDocId>
</ns2:removePersonDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removePersonDocumentResponse xmlns:ns2="http://kernel.matrix.org/">
<removed>{xs:boolean}</removed>
</ns2:removePersonDocumentResponse>
</S:Body>
</S:Envelope> |
Operation findPersonDocumentViews |
Name: |
findPersonDocumentViews |
Signature: |
findPersonDocumentViews (filter {kernel:PersonDocumentFilter}) => personDocumentView {kernel:PersonDocumentView}* |
Java signature: |
List<org.matrix.kernel.PersonDocumentView> findPersonDocumentViews(org.matrix.kernel.PersonDocumentFilter filter) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonDocumentViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<docId>{xs:string}</docId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
<personId>{xs:string}</personId>
<version>{xs:int}</version>
</filter>
</ns2:findPersonDocumentViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findPersonDocumentViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<personDocumentView>
<personDocId>{xs:string}</personDocId>
<document incremental="{xs:boolean}">
<docId>{xs:string}</docId>
<version>{xs:int}</version>
<title>{xs:string}</title>
<docTypeId>{xs:string}</docTypeId>
<state>{doc:State}</state>
<language>{xs:string}</language>
<authorId>{xs:string}</authorId>
<captureDateTime>{mx:dateTime}</captureDateTime>
<captureUserId>{xs:string}</captureUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
<creationDate>{mx:date}</creationDate>
<classId>{xs:string}</classId>
<caseId>{xs:string}</caseId>
<summary>{xs:string}</summary>
<content>
<contentId>{xs:string}</contentId>
<contentType>{xs:string}</contentType>
<formatId>{xs:string}</formatId>
<formatDescription>{xs:string}</formatDescription>
<language>{xs:string}</language>
<creationDate>{mx:date}</creationDate>
<captureDateTime>{mx:dateTime}</captureDateTime>
<captureUserId>{xs:string}</captureUserId>
<size>{xs:long}</size>
<data>{xs:base64Binary}</data>
<url>{xs:string}</url>
</content>
<lockUserId>{xs:string}</lockUserId>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
<relatedDocument>
<relationType>{doc:RelationType}</relationType>
<name>{xs:string}</name>
<docId>{xs:string}</docId>
<version>{xs:int}</version>
<captureDateTime>{mx:dateTime}</captureDateTime>
<captureUserId>{xs:string}</captureUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</relatedDocument>
<accessControl>
<action>{xs:string}</action>
<roleId>{xs:string}</roleId>
</accessControl>
</document>
<personDocTypeId>{xs:string}</personDocTypeId>
<personView>
<personId>{xs:string}</personId>
<fullName>{xs:string}</fullName>
<nif>{xs:string}</nif>
<passport>{xs:string}</passport>
<personTypeId>{xs:string}</personTypeId>
</personView>
</personDocumentView>
</ns2:findPersonDocumentViewsResponse>
</S:Body>
</S:Envelope> |
Operation loadAddressDocument |
Name: |
loadAddressDocument |
Signature: |
loadAddressDocument (addressDocId {xs:string}) => addressDocument {kernel:AddressDocument} |
Java signature: |
org.matrix.kernel.AddressDocument loadAddressDocument(String addressDocId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
addressDocId |
xs:string |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadAddressDocument xmlns:ns2="http://kernel.matrix.org/">
<addressDocId>{xs:string}</addressDocId>
</ns2:loadAddressDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadAddressDocumentResponse xmlns:ns2="http://kernel.matrix.org/">
<addressDocument>
<addressDocId>{xs:string}</addressDocId>
<addressId>{xs:string}</addressId>
<docId>{xs:string}</docId>
<addressDocTypeId>{xs:string}</addressDocTypeId>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</addressDocument>
</ns2:loadAddressDocumentResponse>
</S:Body>
</S:Envelope> |
Operation storeAddressDocument |
Name: |
storeAddressDocument |
Signature: |
storeAddressDocument (addressDocument {kernel:AddressDocument}) => storedAddressDocument {kernel:AddressDocument} |
Java signature: |
org.matrix.kernel.AddressDocument storeAddressDocument(org.matrix.kernel.AddressDocument addressDocument) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeAddressDocument xmlns:ns2="http://kernel.matrix.org/">
<addressDocument>
<addressDocId>{xs:string}</addressDocId>
<addressId>{xs:string}</addressId>
<docId>{xs:string}</docId>
<addressDocTypeId>{xs:string}</addressDocTypeId>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</addressDocument>
</ns2:storeAddressDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeAddressDocumentResponse xmlns:ns2="http://kernel.matrix.org/">
<storedAddressDocument>
<addressDocId>{xs:string}</addressDocId>
<addressId>{xs:string}</addressId>
<docId>{xs:string}</docId>
<addressDocTypeId>{xs:string}</addressDocTypeId>
<comments>{xs:string}</comments>
<creationDateTime>{mx:dateTime}</creationDateTime>
<creationUserId>{xs:string}</creationUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</storedAddressDocument>
</ns2:storeAddressDocumentResponse>
</S:Body>
</S:Envelope> |
Operation removeAddressDocument |
Name: |
removeAddressDocument |
Signature: |
removeAddressDocument (addressDocId {xs:string}) => removed {xs:boolean} |
Java signature: |
boolean removeAddressDocument(String addressDocId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
addressDocId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
removed |
xs:boolean |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeAddressDocument xmlns:ns2="http://kernel.matrix.org/">
<addressDocId>{xs:string}</addressDocId>
</ns2:removeAddressDocument>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeAddressDocumentResponse xmlns:ns2="http://kernel.matrix.org/">
<removed>{xs:boolean}</removed>
</ns2:removeAddressDocumentResponse>
</S:Body>
</S:Envelope> |
Operation findAddressDocumentViews |
Name: |
findAddressDocumentViews |
Signature: |
findAddressDocumentViews (filter {kernel:AddressDocumentFilter}) => addressDocumentView {kernel:AddressDocumentView}* |
Java signature: |
List<org.matrix.kernel.AddressDocumentView> findAddressDocumentViews(org.matrix.kernel.AddressDocumentFilter filter) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findAddressDocumentViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<docId>{xs:string}</docId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
<addressId>{xs:string}</addressId>
<version>{xs:int}</version>
</filter>
</ns2:findAddressDocumentViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findAddressDocumentViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<addressDocumentView>
<addressDocId>{xs:string}</addressDocId>
<document incremental="{xs:boolean}">
<docId>{xs:string}</docId>
<version>{xs:int}</version>
<title>{xs:string}</title>
<docTypeId>{xs:string}</docTypeId>
<state>{doc:State}</state>
<language>{xs:string}</language>
<authorId>{xs:string}</authorId>
<captureDateTime>{mx:dateTime}</captureDateTime>
<captureUserId>{xs:string}</captureUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
<creationDate>{mx:date}</creationDate>
<classId>{xs:string}</classId>
<caseId>{xs:string}</caseId>
<summary>{xs:string}</summary>
<content>
<contentId>{xs:string}</contentId>
<contentType>{xs:string}</contentType>
<formatId>{xs:string}</formatId>
<formatDescription>{xs:string}</formatDescription>
<language>{xs:string}</language>
<creationDate>{mx:date}</creationDate>
<captureDateTime>{mx:dateTime}</captureDateTime>
<captureUserId>{xs:string}</captureUserId>
<size>{xs:long}</size>
<data>{xs:base64Binary}</data>
<url>{xs:string}</url>
</content>
<lockUserId>{xs:string}</lockUserId>
<property>
<name>{xs:string}</name>
<value>{xs:string}</value>
</property>
<relatedDocument>
<relationType>{doc:RelationType}</relationType>
<name>{xs:string}</name>
<docId>{xs:string}</docId>
<version>{xs:int}</version>
<captureDateTime>{mx:dateTime}</captureDateTime>
<captureUserId>{xs:string}</captureUserId>
<changeDateTime>{mx:dateTime}</changeDateTime>
<changeUserId>{xs:string}</changeUserId>
</relatedDocument>
<accessControl>
<action>{xs:string}</action>
<roleId>{xs:string}</roleId>
</accessControl>
</document>
<addressDocTypeId>{xs:string}</addressDocTypeId>
<addressView>
<addressId>{xs:string}</addressId>
<description>{xs:string}</description>
<city>{xs:string}</city>
<province>{xs:string}</province>
<country>{xs:string}</country>
<addressTypeId>{xs:string}</addressTypeId>
</addressView>
</addressDocumentView>
</ns2:findAddressDocumentViewsResponse>
</S:Body>
</S:Envelope> |
Operation storeRoom |
Name: |
storeRoom |
Signature: |
storeRoom (room {kernel:Room}) => storedRoom {kernel:Room} |
Java signature: |
org.matrix.kernel.Room storeRoom(org.matrix.kernel.Room room) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
room |
kernel:Room |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedRoom |
kernel:Room |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeRoom xmlns:ns2="http://kernel.matrix.org/">
<room>
<roomId>{xs:string}</roomId>
<addressId>{xs:string}</addressId>
<name>{xs:string}</name>
<capacity>{xs:int}</capacity>
<roomTypeId>{xs:string}</roomTypeId>
<area>{xs:int}</area>
<phone>{xs:string}</phone>
<fax>{xs:string}</fax>
<email>{xs:string}</email>
<schedule>{xs:string}</schedule>
<comments>{xs:string}</comments>
<spaceId>{xs:string}</spaceId>
</room>
</ns2:storeRoom>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeRoomResponse xmlns:ns2="http://kernel.matrix.org/">
<storedRoom>
<roomId>{xs:string}</roomId>
<addressId>{xs:string}</addressId>
<name>{xs:string}</name>
<capacity>{xs:int}</capacity>
<roomTypeId>{xs:string}</roomTypeId>
<area>{xs:int}</area>
<phone>{xs:string}</phone>
<fax>{xs:string}</fax>
<email>{xs:string}</email>
<schedule>{xs:string}</schedule>
<comments>{xs:string}</comments>
<spaceId>{xs:string}</spaceId>
</storedRoom>
</ns2:storeRoomResponse>
</S:Body>
</S:Envelope> |
Operation findRooms |
Name: |
findRooms |
Signature: |
findRooms (filter {kernel:RoomFilter}) => room {kernel:Room}* |
Java signature: |
List<org.matrix.kernel.Room> findRooms(org.matrix.kernel.RoomFilter filter) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
filter |
kernel:RoomFilter |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
room |
kernel:Room |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findRooms xmlns:ns2="http://kernel.matrix.org/">
<filter>
<roomIdList>{xs:string}</roomIdList>
<addressId>{xs:string}</addressId>
<roomName>{xs:string}</roomName>
<roomTypeId>{xs:string}</roomTypeId>
<capacity>{xs:int}</capacity>
<comments>{xs:string}</comments>
<spaceId>{xs:string}</spaceId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findRooms>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findRoomsResponse xmlns:ns2="http://kernel.matrix.org/">
<room>
<roomId>{xs:string}</roomId>
<addressId>{xs:string}</addressId>
<name>{xs:string}</name>
<capacity>{xs:int}</capacity>
<roomTypeId>{xs:string}</roomTypeId>
<area>{xs:int}</area>
<phone>{xs:string}</phone>
<fax>{xs:string}</fax>
<email>{xs:string}</email>
<schedule>{xs:string}</schedule>
<comments>{xs:string}</comments>
<spaceId>{xs:string}</spaceId>
</room>
</ns2:findRoomsResponse>
</S:Body>
</S:Envelope> |
Operation findRoomViews |
Name: |
findRoomViews |
Signature: |
findRoomViews (filter {kernel:RoomFilter}) => roomView {kernel:RoomView}* |
Java signature: |
List<org.matrix.kernel.RoomView> findRoomViews(org.matrix.kernel.RoomFilter filter) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
filter |
kernel:RoomFilter |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
roomView |
kernel:RoomView |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findRoomViews xmlns:ns2="http://kernel.matrix.org/">
<filter>
<roomIdList>{xs:string}</roomIdList>
<addressId>{xs:string}</addressId>
<roomName>{xs:string}</roomName>
<roomTypeId>{xs:string}</roomTypeId>
<capacity>{xs:int}</capacity>
<comments>{xs:string}</comments>
<spaceId>{xs:string}</spaceId>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findRoomViews>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findRoomViewsResponse xmlns:ns2="http://kernel.matrix.org/">
<roomView>
<roomId>{xs:string}</roomId>
<roomTypeId>{xs:string}</roomTypeId>
<description>{xs:string}</description>
<addressView>
<addressId>{xs:string}</addressId>
<description>{xs:string}</description>
<city>{xs:string}</city>
<province>{xs:string}</province>
<country>{xs:string}</country>
<addressTypeId>{xs:string}</addressTypeId>
</addressView>
</roomView>
</ns2:findRoomViewsResponse>
</S:Body>
</S:Envelope> |
Operation storeCountry |
Name: |
storeCountry |
Signature: |
storeCountry (country {kernel:Country}) => storedCountry {kernel:Country} |
Java signature: |
org.matrix.kernel.Country storeCountry(org.matrix.kernel.Country country) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
country |
kernel:Country |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedCountry |
kernel:Country |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeCountry xmlns:ns2="http://kernel.matrix.org/">
<country>
<countryId>{xs:string}</countryId>
<name>{xs:string}</name>
<ISOCode>{xs:string}</ISOCode>
<language>{xs:string}</language>
</country>
</ns2:storeCountry>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeCountryResponse xmlns:ns2="http://kernel.matrix.org/">
<storedCountry>
<countryId>{xs:string}</countryId>
<name>{xs:string}</name>
<ISOCode>{xs:string}</ISOCode>
<language>{xs:string}</language>
</storedCountry>
</ns2:storeCountryResponse>
</S:Body>
</S:Envelope> |
Operation countCountries |
Name: |
countCountries |
Signature: |
countCountries (filter {kernel:CountryFilter}) => countryCount {xs:int} |
Java signature: |
int countCountries(org.matrix.kernel.CountryFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
countryCount |
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:countCountries xmlns:ns2="http://kernel.matrix.org/">
<filter>
<countryName>{xs:string}</countryName>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countCountries>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countCountriesResponse xmlns:ns2="http://kernel.matrix.org/">
<countryCount>{xs:int}</countryCount>
</ns2:countCountriesResponse>
</S:Body>
</S:Envelope> |
Operation findCountries |
Name: |
findCountries |
Signature: |
findCountries (filter {kernel:CountryFilter}) => country {kernel:Country}* |
Java signature: |
List<org.matrix.kernel.Country> findCountries(org.matrix.kernel.CountryFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
country |
kernel:Country |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findCountries xmlns:ns2="http://kernel.matrix.org/">
<filter>
<countryName>{xs:string}</countryName>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findCountries>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findCountriesResponse xmlns:ns2="http://kernel.matrix.org/">
<country>
<countryId>{xs:string}</countryId>
<name>{xs:string}</name>
<ISOCode>{xs:string}</ISOCode>
<language>{xs:string}</language>
</country>
</ns2:findCountriesResponse>
</S:Body>
</S:Envelope> |
Operation loadProvince |
Name: |
loadProvince |
Signature: |
loadProvince (provinceId {xs:string}) => province {kernel:Province} |
Java signature: |
org.matrix.kernel.Province loadProvince(String provinceId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
provinceId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
province |
kernel:Province |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadProvince xmlns:ns2="http://kernel.matrix.org/">
<provinceId>{xs:string}</provinceId>
</ns2:loadProvince>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadProvinceResponse xmlns:ns2="http://kernel.matrix.org/">
<province>
<provinceId>{xs:string}</provinceId>
<countryId>{xs:string}</countryId>
<name>{xs:string}</name>
</province>
</ns2:loadProvinceResponse>
</S:Body>
</S:Envelope> |
Operation storeProvince |
Name: |
storeProvince |
Signature: |
storeProvince (province {kernel:Province}) => storedProvince {kernel:Province} |
Java signature: |
org.matrix.kernel.Province storeProvince(org.matrix.kernel.Province province) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
province |
kernel:Province |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedProvince |
kernel:Province |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeProvince xmlns:ns2="http://kernel.matrix.org/">
<province>
<provinceId>{xs:string}</provinceId>
<countryId>{xs:string}</countryId>
<name>{xs:string}</name>
</province>
</ns2:storeProvince>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeProvinceResponse xmlns:ns2="http://kernel.matrix.org/">
<storedProvince>
<provinceId>{xs:string}</provinceId>
<countryId>{xs:string}</countryId>
<name>{xs:string}</name>
</storedProvince>
</ns2:storeProvinceResponse>
</S:Body>
</S:Envelope> |
Operation countProvinces |
Name: |
countProvinces |
Signature: |
countProvinces (filter {kernel:ProvinceFilter}) => provinceCount {xs:int} |
Java signature: |
int countProvinces(org.matrix.kernel.ProvinceFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
provinceCount |
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:countProvinces xmlns:ns2="http://kernel.matrix.org/">
<filter>
<countryId>{xs:string}</countryId>
<provinceName>{xs:string}</provinceName>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countProvinces>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countProvincesResponse xmlns:ns2="http://kernel.matrix.org/">
<provinceCount>{xs:int}</provinceCount>
</ns2:countProvincesResponse>
</S:Body>
</S:Envelope> |
Operation findProvinces |
Name: |
findProvinces |
Signature: |
findProvinces (filter {kernel:ProvinceFilter}) => province {kernel:Province}* |
Java signature: |
List<org.matrix.kernel.Province> findProvinces(org.matrix.kernel.ProvinceFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
province |
kernel:Province |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findProvinces xmlns:ns2="http://kernel.matrix.org/">
<filter>
<countryId>{xs:string}</countryId>
<provinceName>{xs:string}</provinceName>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findProvinces>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findProvincesResponse xmlns:ns2="http://kernel.matrix.org/">
<province>
<provinceId>{xs:string}</provinceId>
<countryId>{xs:string}</countryId>
<name>{xs:string}</name>
</province>
</ns2:findProvincesResponse>
</S:Body>
</S:Envelope> |
Operation storeCity |
Name: |
storeCity |
Signature: |
storeCity (city {kernel:City}) => storedCity {kernel:City} |
Java signature: |
org.matrix.kernel.City storeCity(org.matrix.kernel.City city) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
city |
kernel:City |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedCity |
kernel:City |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeCity xmlns:ns2="http://kernel.matrix.org/">
<city>
<cityId>{xs:string}</cityId>
<provinceId>{xs:string}</provinceId>
<name>{xs:string}</name>
</city>
</ns2:storeCity>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeCityResponse xmlns:ns2="http://kernel.matrix.org/">
<storedCity>
<cityId>{xs:string}</cityId>
<provinceId>{xs:string}</provinceId>
<name>{xs:string}</name>
</storedCity>
</ns2:storeCityResponse>
</S:Body>
</S:Envelope> |
Operation findCities |
Name: |
findCities |
Signature: |
findCities (filter {kernel:CityFilter}) => city {kernel:City}* |
Java signature: |
List<org.matrix.kernel.City> findCities(org.matrix.kernel.CityFilter filter) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
filter |
kernel:CityFilter |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
city |
kernel:City |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findCities xmlns:ns2="http://kernel.matrix.org/">
<filter>
<countryId>{xs:string}</countryId>
<provinceId>{xs:string}</provinceId>
<cityName>{xs:string}</cityName>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findCities>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findCitiesResponse xmlns:ns2="http://kernel.matrix.org/">
<city>
<cityId>{xs:string}</cityId>
<provinceId>{xs:string}</provinceId>
<name>{xs:string}</name>
</city>
</ns2:findCitiesResponse>
</S:Body>
</S:Envelope> |
Operation storeStreet |
Name: |
storeStreet |
Signature: |
storeStreet (street {kernel:Street}) => storedStreet {kernel:Street} |
Java signature: |
org.matrix.kernel.Street storeStreet(org.matrix.kernel.Street street) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
street |
kernel:Street |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
storedStreet |
kernel:Street |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeStreet xmlns:ns2="http://kernel.matrix.org/">
<street>
<streetId>{xs:string}</streetId>
<cityId>{xs:string}</cityId>
<streetTypeId>{xs:string}</streetTypeId>
<particle>{xs:string}</particle>
<name>{xs:string}</name>
</street>
</ns2:storeStreet>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeStreetResponse xmlns:ns2="http://kernel.matrix.org/">
<storedStreet>
<streetId>{xs:string}</streetId>
<cityId>{xs:string}</cityId>
<streetTypeId>{xs:string}</streetTypeId>
<particle>{xs:string}</particle>
<name>{xs:string}</name>
</storedStreet>
</ns2:storeStreetResponse>
</S:Body>
</S:Envelope> |
Operation countStreets |
Name: |
countStreets |
Signature: |
countStreets (filter {kernel:StreetFilter}) => streetCount {xs:int} |
Java signature: |
int countStreets(org.matrix.kernel.StreetFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
streetCount |
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:countStreets xmlns:ns2="http://kernel.matrix.org/">
<filter>
<countryId>{xs:string}</countryId>
<provinceId>{xs:string}</provinceId>
<cityId>{xs:string}</cityId>
<streetTypeId>{xs:string}</streetTypeId>
<streetName>{xs:string}</streetName>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:countStreets>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:countStreetsResponse xmlns:ns2="http://kernel.matrix.org/">
<streetCount>{xs:int}</streetCount>
</ns2:countStreetsResponse>
</S:Body>
</S:Envelope> |
Operation findStreets |
Name: |
findStreets |
Signature: |
findStreets (filter {kernel:StreetFilter}) => street {kernel:Street}* |
Java signature: |
List<org.matrix.kernel.Street> findStreets(org.matrix.kernel.StreetFilter filter) |
Parameters: |
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
street |
kernel:Street |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findStreets xmlns:ns2="http://kernel.matrix.org/">
<filter>
<countryId>{xs:string}</countryId>
<provinceId>{xs:string}</provinceId>
<cityId>{xs:string}</cityId>
<streetTypeId>{xs:string}</streetTypeId>
<streetName>{xs:string}</streetName>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findStreets>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findStreetsResponse xmlns:ns2="http://kernel.matrix.org/">
<street>
<streetId>{xs:string}</streetId>
<cityId>{xs:string}</cityId>
<streetTypeId>{xs:string}</streetTypeId>
<particle>{xs:string}</particle>
<name>{xs:string}</name>
</street>
</ns2:findStreetsResponse>
</S:Body>
</S:Envelope> |
Operation loadKernelListItem |
Name: |
loadKernelListItem |
Signature: |
loadKernelListItem (list {kernel:KernelList}, itemId {xs:string}) => listItem {kernel:KernelListItem} |
Java signature: |
org.matrix.kernel.KernelListItem loadKernelListItem(org.matrix.kernel.KernelList list, String itemId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
list |
kernel:KernelList |
1 |
false |
false |
|
itemId |
xs:string |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadKernelListItem xmlns:ns2="http://kernel.matrix.org/">
<list>{kernel:KernelList}</list>
<itemId>{xs:string}</itemId>
</ns2:loadKernelListItem>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loadKernelListItemResponse xmlns:ns2="http://kernel.matrix.org/">
<listItem>
<itemId>{xs:string}</itemId>
<label>{xs:string}</label>
<description>{xs:string}</description>
</listItem>
</ns2:loadKernelListItemResponse>
</S:Body>
</S:Envelope> |
Operation storeKernelListItem |
Name: |
storeKernelListItem |
Signature: |
storeKernelListItem (list {kernel:KernelList}, item {kernel:KernelListItem}) => storedListItem {kernel:KernelListItem} |
Java signature: |
org.matrix.kernel.KernelListItem storeKernelListItem(org.matrix.kernel.KernelList list, org.matrix.kernel.KernelListItem item) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeKernelListItem xmlns:ns2="http://kernel.matrix.org/">
<list>{kernel:KernelList}</list>
<item>
<itemId>{xs:string}</itemId>
<label>{xs:string}</label>
<description>{xs:string}</description>
</item>
</ns2:storeKernelListItem>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:storeKernelListItemResponse xmlns:ns2="http://kernel.matrix.org/">
<storedListItem>
<itemId>{xs:string}</itemId>
<label>{xs:string}</label>
<description>{xs:string}</description>
</storedListItem>
</ns2:storeKernelListItemResponse>
</S:Body>
</S:Envelope> |
Operation removeKernelListItem |
Name: |
removeKernelListItem |
Signature: |
removeKernelListItem (list {kernel:KernelList}, itemId {xs:string}) => removed {xs:boolean} |
Java signature: |
boolean removeKernelListItem(org.matrix.kernel.KernelList list, String itemId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
list |
kernel:KernelList |
1 |
false |
false |
|
itemId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
removed |
xs:boolean |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeKernelListItem xmlns:ns2="http://kernel.matrix.org/">
<list>{kernel:KernelList}</list>
<itemId>{xs:string}</itemId>
</ns2:removeKernelListItem>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeKernelListItemResponse xmlns:ns2="http://kernel.matrix.org/">
<removed>{xs:boolean}</removed>
</ns2:removeKernelListItemResponse>
</S:Body>
</S:Envelope> |
Operation listKernelListItems |
Name: |
listKernelListItems |
Signature: |
listKernelListItems (list {kernel:KernelList}) => listItem {kernel:KernelListItem}* |
Java signature: |
List<org.matrix.kernel.KernelListItem> listKernelListItems(org.matrix.kernel.KernelList list) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
list |
kernel:KernelList |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listKernelListItems xmlns:ns2="http://kernel.matrix.org/">
<list>{kernel:KernelList}</list>
</ns2:listKernelListItems>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listKernelListItemsResponse xmlns:ns2="http://kernel.matrix.org/">
<listItem>
<itemId>{xs:string}</itemId>
<label>{xs:string}</label>
<description>{xs:string}</description>
</listItem>
</ns2:listKernelListItemsResponse>
</S:Body>
</S:Envelope> |