Die Response ist das Ergebnis einer REST-Anfrage. Sie kann entweder als XML oder (standardmäßig) als JSON übersendet werden. Hier soll der prinzipielle Aufbau einer solchen Response erläutert werden.

Eine Response hat immer die drei Attribute statusCode, totalResultCount, page und maxPage. statusCode stellt dabei den StatusCode dar, den diese Response hat. totalResultCount gibt an, wie viele Ergebnisse die Anfrage insgesamt hat, während page angibt welche Seite der Ergebnissse momentan dargestellt wird. maxPage gibt an, wieviele Ergebnisseiten insgesamt verfügbar sind.

Im Folgenden sind einige Beispiele jeweils als JSON und als XML dargestellt. Zeilenumbrücke sowie Tabstops sind nur zur besseren Übersicht eingefügt.

JSON

Erfolgreicher Login:
{
   "response":{"@totalResultCount":"1","@statusCode":"PASSWORD_ACCEPTED","@page":"0","@maxPage":"0",
      "content":{
         "item":{"@type":"xmlToken",
            "expires":1281886866359,
            "user":{
               "created":1281721957000,
               "firstName":"Jonas",
               "gender":"NA",
               "id":1,
               "lastName":"Hartmann",
               "lang":"en",
               "nick":"user1"
            },
            "value":"7ec2972d-d678-4022-ad41-e665a75d15d3"
}   }   }   }
Fehlgeschlagener Login
{
   "response":{"@totalResultCount":"0","@statusCode":"ILLEGAL_PASS_OR_USER","@page":"0","@maxPage":"0",
      "content":{"@nil":"true"}
}   }
Suche mit zwei Ergebnissen:
{
   "response":{"@totalResultCount":"2","@statusCode":"OK","@page":"0","@maxPage":"0",
      "content":{
         "item":[
            {"@type":"xmlMediaItem",
               "id":14,
               "name":"Das Mamut-Buch der Technik",
               "shortDescription":"DAS Standard nachschlagewerk für kleine und große Technikbegeisterte, das die Fragen des Alltags vorzüglich erklärt",
               "tags":{
                  "tag":[
                     {"name":"technical"},
                     {"name":"book"},
                     {"name":"mammut"}
                  ]
               },
               "type":"book"
            },
            {"@type":"xmlMediaItem",
               "duration":8280000,
               "id":15,
               "name":"Ein Königreich für ein Lama",
               "tags":{
                  "tag":[
                     {"name":"movie"},
                     {"name":"disney"},
                     {"name":"funny"},
                     {"name":"nice"}
                  ]
               },
               "type":"movie"
}   ]   }   }   }

XML

Erfolgreicher Login:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response totalResultCount="1" statusCode="PASSWORD_ACCEPTED" page="0" maxPage="0">
   <content>
      <item xsi:type="xmlToken">
         <expires>1281899405549</expires>
         <user>
            <created>1281721957000</created>
            <firstName>Hansi</firstName>
            <gender>M</gender>
            <id>19832</id>
            <lastName>Hinterseer</lastName>
            <lang>de</lang>
            <nick>Hansi</nick>
         </user>
         <value>7ec2972d-d678-4022-ad41-e665a75d15d3</value>
      </item>
   </content>
</response>
Fehlgeschlagener Login
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response totalResultCount="0" statusCode="ILLEGAL_PASS_OR_USER" page="0" maxPage="0">
   <content/>
</response>
Suche mit zwei Ergebnissen:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response totalResultCount="2" statusCode="OK" page="0" maxPage="0">
   <content>
      <item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xmlMediaItem">
         <id>14</id>
         <name>Das Mamut-Buch der Technik</name>
         <shortDescription>DAS Standard nachschlagewerk für kleine und große Technikbegeisterte, das die Fragen des Alltags vorzüglich erklärt</shortDescription>
         <tags>
            <tag><name>mammut</name></tag>
            <tag><name>technical</name></tag>
            <tag><name>book</name></tag>
         </tags>
         <type>book</type>
      </item>
      <item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xmlMediaItem">
         <duration>8280000</duration>
         <id>15</id>
         <name>Ein Königreich für ein Lama</name>
         <tags>
            <tag><name>movie</name></tag>
            <tag><name>disney</name></tag>
            <tag><name>funny</name></tag>
            <tag><name>nice</name></tag>
         </tags>
         <type>movie</type>
      </item>
   </content>
</response>
Topic revision: r1 - 14 Aug 2010, ChristianBreil
 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Medieninformatik-Wiki? Send feedback