Terminologieserver - ConceptAssociation - UpdateConceptAssociationStatus

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(2 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt)
Zeile 1: Zeile 1:
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
  
 +
=Beschreibung=
 +
Update the status of the given association. Look for available status in the domain lists.<br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 12: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
<tr id="row_object">
+
<tr>
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
   <td id="param_level1">LoginType</td>
+
   <td id="param_level1">loginToken</td>
  <td>LoginType</td>
+
<td></td>  <td id="cardinality_cell">0..1</td>
+
  <td>Login information</td>
+
</tr>
+
<tr>
+
  <td id="cardinality_cell">2</td>
+
  <td id="param_level2">sessionID</td>
+
 
   <td>String</td>
 
   <td>String</td>
 
   <td></td>
 
   <td></td>
   <td id="cardinality_cell">1..1</td>
+
   <td id="cardinality_cell">0..1</td>
   <td>Session-ID from user (given by system)</td>
+
   <td>Login-Token that ensures the user is logged in.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 40: Zeile 35:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
</tr>
 
<tr>
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">leftId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
  <td>Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g.  ID 1 = 12, Id 2 = 14:  12 belongs to 14, or  14 belongs to 12.
 
If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well. </td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 55: Zeile 42:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Status of the current entry. Can be taken from a domain. </td>
 
   <td>Status of the current entry. Can be taken from a domain. </td>
</tr>
 
<tr>
 
  <td id="cardinality_cell">2</td>
 
  <td id="param_level2">statusDate</td>
 
  <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
  <td>Point of time of the last change of the status.</td>
 
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 77: Zeile 57:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
   <td id="param_level1">ReturnType</td>
+
   <td id="param_level1">returnInfos</td>
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Return information</td>
 
   <td>Return information</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 105: Zeile 92:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
=Beispiele=
 +
==SOAP==
 +
===Update the status===
 +
<source lang="xml">
 +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
 +
  <soapenv:Header/>
 +
  <soapenv:Body>
 +
      <con:UpdateConceptAssociationStatus>
 +
        <!--Optional:-->
 +
        <parameter>
 +
            <codeSystemEntityVersionAssociation>
 +
              <id>1</id>
 +
              <status>2</status>
 +
            </codeSystemEntityVersionAssociation>
 +
            <loginToken>INSERT LOGIN TOKEN</loginToken>
 +
        </parameter>
 +
      </con:UpdateConceptAssociationStatus>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>
 +
</source>
 
<br><br>
 
<br><br>
  
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]

Aktuelle Version vom 30. September 2014, 12:31 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Update the status of the given association. Look for available status in the domain lists.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 0..1 Login-Token that ensures the user is logged in.
1 codeSystemEntityVersionAssociation code_system_entity_version_association 1..1 Associates two entity versions with each other.
2 id Long 1..1
2 status Integer 1..1 Status of the current entry. Can be taken from a domain.


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos ReturnType 1..1 Return information
2 count Integer 1..1 number of results
2 message String 1..1 an additional message
2 overallErrorCategory 1..1 INFO, WARN, ERROR
2 status 1..1 OK, FAILURE

Beispiele

SOAP

Update the status

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <con:UpdateConceptAssociationStatus>
         <!--Optional:-->
         <parameter>
            <codeSystemEntityVersionAssociation>
               <id>1</id>
               <status>2</status>
            </codeSystemEntityVersionAssociation>
            <loginToken>INSERT LOGIN TOKEN</loginToken>
         </parameter>
      </con:UpdateConceptAssociationStatus>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge