Parsing REST Services JSON Responses (C#)

最新推荐文章于 2024-02-29 11:08:52 发布
最新推荐文章于 2024-02-29 11:08:52 发布
阅读量884 收藏
点赞数
分类专栏： .net 文章标签： rest json c# parsing string exception

This tutorial shows you how to parse a Bing Maps REST Services JSON request using C# and includes basic sample code. The process is described in three steps:

  • Create the basic program

  • Create the data contract

  • Create the Request

  • Make the request

  • Process the response

Create the basic program

Start Visual Studio and create a C# .NET console application named RESTServicesJSONParserExample. Replace the default template with the following sample code, and insert your Bing Maps Key in place of the placeholder insertYourBingMapsKey. If you do not have a Bing Maps Key, see Getting a Bing Maps Key.

using System;
using System.Net;
using System.Runtime.Serialization.Json;

namespace RESTServicesJSONParserExample

{
    class Program
    {
        static string BingMapsKey = "InsertYourBingMapsKeyHere"; 
        static void Main(string[] args)
        {           
            try
            {
                 string locationsRequest = CreateRequest("New%20York"); 
                Response locationsResponse = MakeRequest(locationsRequest);
                ProcessResponse(locationsResponse);
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
                Console.Read();
            }

        }
}

Create the REST Services request

Insert the following method into your program. This method creates a simple location query for “New York”. This type of Bing Maps REST Services Locations API request is described in Find a Location by Query. 

public static string CreateRequest(string queryString)
{
    string UrlRequest = "http://dev.virtualearth.net/REST/v1/Locations/" +
                         queryString +
                         "?output=xml" +
                         " &key=" + BingMapsKey;
    return (UrlRequest);
}

Create the REST Services request

Insert the following method into your program. This method creates a simple location query for “New York”. This type of Bing Maps REST Services Locations API request is described in Find a Location by Query. 

public static string CreateRequest(string queryString)
{
    string UrlRequest = "http://dev.virtualearth.net/REST/v1/Locations/" +
                         queryString +
                         "?output=xml" +
                         " &key=" + BingMapsKey;
    return (UrlRequest);
}

Make the request

Insert the following code to make REST Services HTTP requests and return the response. 

public static Response MakeRequest(string requestUrl)
{
    try
    {
        HttpWebRequest request = WebRequest.Create(requestUrl) as HttpWebRequest;
        using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)
        {
            if (response.StatusCode != HttpStatusCode.OK)
                throw new Exception(String.Format(
                "Server error (HTTP {0}: {1}).",
                response.StatusCode,
                response.StatusDescription));
            DataContractJsonSerializer jsonSerializer = new DataContractJsonSerializer(typeof(Response));
            object objResponse = jsonSerializer.ReadObject(response.GetResponseStream());
            Response jsonResponse
            = objResponse as Response;
            return jsonResponse;
        }
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
        return null;
    }
}

Create the data contract

Add a new C# class to your project and replace the template content with the data contract classes below. These data contracts describe location data that is returned in the JSON response when you make a Locations API geocode request. You can compare the class structure with the example response at the end of this article. You can also create similar contracts for the JSON responses to other REST Services requests. 

using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;

namespace RESTServicesJSONParserExample
{
    [DataContract]
    public class Response
    {
        [DataMember(Name = "copyright")]
        public string Copyright { get; set; }
        [DataMember(Name = "brandLogoUri")]
        public string BrandLogoUri { get; set; }
        [DataMember(Name = "statusCode")]
        public int StatusCode { get; set; }
        [DataMember(Name = "statusDescription")]
        public string StatusDescription { get; set; }
        [DataMember(Name = "authenticationResultCode")]
        public string AuthenticationResultCode { get; set; }
        [DataMember(Name = "errorDetails")]
        public string[] errorDetails { get; set; }
        [DataMember(Name = "traceId")]
        public string TraceId { get; set; }
        [DataMember(Name = "resourceSets")]
        public ResourceSet[] ResourceSets { get; set; }
    }


    [DataContract]
    public class ResourceSet
    {
        [DataMember(Name = "estimatedTotal")]

        public long EstimatedTotal { get; set; }
        [DataMember(Name = "resources")]
        public Location[] Resources { get; set; }
    }

    [DataContract]
    public class Point
    {
        /// <summary>
        /// Latitude,Longitude
        /// </summary>
        [DataMember(Name = "coordinates")]
        public double[] Coordinates { get; set; }
    }


    [DataContract]
    public class BoundingBox
    {
        [DataMember(Name = "southLatitude")]
        public double SouthLatitude { get; set; }
        [DataMember(Name = "westLongitude")]
        public double WestLongitude { get; set; }
        [DataMember(Name = "northLatitude")]
        public double NorthLatitude { get; set; }
        [DataMember(Name = "eastLongitude")]
        public double EastLongitude { get; set; }
    }

    [DataContract]
    public class GeocodePoint: Point
    {
        [DataMember(Name = "calculationMethod")]
        public string CalculationMethod { get; set; }
        [DataMember(Name = "usageTypes")]
        public string[] UsageTypes { get; set; }
    }

    [DataContract(Namespace = "http://schemas.microsoft.com/search/local/ws/rest/v1")]
    public class Location
    {
        [DataMember(Name = "boundingBox")]
        public BoundingBox BoundingBox { get; set; }
        [DataMember(Name = "name")]
        public string Name { get; set; }
        [DataMember(Name = "point")]
        public Point Point { get; set; }
        [DataMember(Name = "entityType")]
        public string EntityType { get; set; }
        [DataMember(Name = "address")]
        public Address Address { get; set; }
        [DataMember(Name = "confidence")]
        public string Confidence { get; set; }
        [DataMember(Name = "geocodePoints")]
        public GeocodePoint[] GeocodePoints { get; set; }
        [DataMember(Name = "matchCodes")]
        public string[] MatchCodes { get; set; }
    }

    [DataContract]
    public class Address
    {
        [DataMember(Name = "addressLine")]
        public string AddressLine { get; set; }
        [DataMember(Name = "adminDistrict")]
        public string AdminDistrict { get; set; }
        [DataMember(Name = "adminDistrict2")]
        public string AdminDistrict2 { get; set; }
        [DataMember(Name = "countryRegion")]
        public string CountryRegion { get; set; }
        [DataMember(Name = "formattedAddress")]
        public string FormattedAddress { get; set; }
        [DataMember(Name = "locality")]
        public string Locality { get; set; }
        [DataMember(Name = "postalCode")]
        public string PostalCode { get; set; }
    }
}

Process the request

Insert the following code in the original file. This code extracts data from the response using the data contract classes. 

static public void ProcessResponse(Response locationsResponse)
{
    int locNum = locationsResponse.ResourceSets[0].Resources.Length;

    //Get formatted addresses
    //Get all locations in the response and then extract the formatted address for each location
    Console.WriteLine("Show all formatted addresses");
    for (int i = 0; i < locNum; i++)
    {
        Location location = (Location)locationsResponse.ResourceSets[0].Resources[i];
        Console.WriteLine(location.Address.FormattedAddress);
    }
    Console.WriteLine();
            
    //Get the Geocode Points for each Location
    for (int i = 0; i < locNum; i++)
    {
        Location location = (Location)locationsResponse.ResourceSets[0].Resources[i];
        Console.WriteLine("Geocode Points for "+location.Address.FormattedAddress);               
        int geocodePointNum = location.GeocodePoints.Length;
        for (int j = 0; j < geocodePointNum; j++)
        {
            Console.WriteLine("    Point: "+location.GeocodePoints[j].Coordinates[0].ToString()+","+
                                        location.GeocodePoints[j].Coordinates[1].ToString());
            double test = location.GeocodePoints[j].Coordinates[1];
            Console.Write("    Usage: ");              
            for (int k = 0; k < location.GeocodePoints[j].UsageTypes.Length; k++)
            {                                                     
                Console.Write(location.GeocodePoints[j].UsageTypes[k].ToString()+" ");
            }
            Console.WriteLine("\n\n");
        }
    }
    Console.WriteLine();

    //Get all locations that have a MatchCode=Good and Confidence=High
    Console.WriteLine("Locations that have a Confidence=High");
    for (int i = 0; i < locNum; i++)
    {
        Location location = (Location)locationsResponse.ResourceSets[0].Resources[i];
        if (location.Confidence == "High")
            Console.WriteLine(location.Address.FormattedAddress);
    }
                Console.WriteLine();

    Console.WriteLine("Press any key to exit");
    Console.ReadKey();
}

Request and Response

This sample code below creates the following request and extracts information from the response.

http://dev.virtualearth.net/REST/v1/Locations/New%20York?output=xml&key=insertYourBingMapsKey

{
   "authenticationResultCode":"ValidCredentials",
   "brandLogoUri":"http:\/\/dev.virtualearth.net\/Branding\/logo_powered_by.png",
   "copyright":"Copyright © 2011 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",
   "resourceSets":[
      {
         "estimatedTotal":3,
         "resources":[
            {
               "__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1",
               "bbox":[
                  40.36376953125,
                  -74.745925903320312,
                  41.056510925292969,
                  -73.267219543457031
               ],
               "name":"New York, NY",
               "point":{
                  "type":"Point",
                  "coordinates":[
                     40.714550018310547,
                     -74.007118225097656
                  ]
               },
               "address":{
                  "adminDistrict":"NY",
                  "countryRegion":"United States",
                  "formattedAddress":"New York, NY",
                  "locality":"New York"
               },
               "confidence":"High",
               "entityType":"PopulatedPlace",
               "geocodePoints":[
                  {
                     "type":"Point",
                     "coordinates":[
                        40.714550018310547,
                        -74.007118225097656
                     ],
                     "calculationMethod":"Rooftop",
                     "usageTypes":[
                        "Display"
                     ]
                  }
               ],
               "matchCodes":[
                  "Good"
               ]
            },
            {
               "__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1",
               "bbox":[
                  53.049841262515258,
                  -0.204358685176537,
                  53.107782028500367,
                  -0.075841319401099713
               ],
               "name":"New York, Lincs, United Kingdom",
               "point":{
                  "type":"Point",
                  "coordinates":[
                     53.078811645507812,
                     -0.14010000228881836
                  ]
               },
               "address":{
                  "adminDistrict":"England",
                  "adminDistrict2":"Lincs",
                  "countryRegion":"United Kingdom",
                  "formattedAddress":"New York, Lincs, United Kingdom",
                  "locality":"New York"
               },
               "confidence":"High",
               "entityType":"PopulatedPlace",
               "geocodePoints":[
                  {
                     "type":"Point",
                     "coordinates":[
                        53.078811645507812,
                        -0.14010000228881836
                     ],
                     "calculationMethod":"Rooftop",
                     "usageTypes":[
                        "Display"
                     ]
                  }
               ],
               "matchCodes":[
                  "Good"
               ]
            },
            {
               "__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1",
               "bbox":[
                  39.655889846499633,
                  -93.968102868870432,
                  39.713830612484742,
                  -93.867758337184256
               ],
               "name":"New York, MO",
               "point":{
                  "type":"Point",
                  "coordinates":[
                     39.684860229492188,
                     -93.917930603027344
                  ]
               },
               "address":{
                  "adminDistrict":"MO",
                  "adminDistrict2":"Caldwell Co.",
                  "countryRegion":"United States",
                  "formattedAddress":"New York, MO",
                  "locality":"New York"
               },
               "confidence":"High",
               "entityType":"PopulatedPlace",
               "geocodePoints":[
                  {
                     "type":"Point",
                     "coordinates":[
                        39.684860229492188,
                        -93.917930603027344
                     ],
                     "calculationMethod":"Rooftop",
                     "usageTypes":[
                        "Display"
                     ]
                  }
               ],
               "matchCodes":[
                  "Good"
               ]
            }
         ]
      }
   ],
   "statusCode":200,
   "statusDescription":"OK",
   "traceId":"4655cb7ebc1d4b0bb91ef3c047217bbd"
}

Complete Sample Code

The following is the complete sample C# code. You must insert your Bing Maps Key.

using System;
using System.Net;
using System.Runtime.Serialization.Json;

namespace RESTServicesJSONParserExample

{
    class Program
    {
        static string BingMapsKey = "insertYourBingMapsKey"; 
        static void Main(string[] args)
        {           
            try
            {
                 string locationsRequest = CreateRequest("New%20York"); 
                Response locationsResponse = MakeRequest(locationsRequest);
                ProcessResponse(locationsResponse);
  }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
                Console.Read();
            }

        }

        //Create the request URL
        public static string CreateRequest(string queryString)
        {
            string UrlRequest = "http://dev.virtualearth.net/REST/v1/Locations/" +
                                           queryString +
                                           "?key=" + BingMapsKey;
            return (UrlRequest);
        }

        public static Response MakeRequest(string requestUrl)
        {
            try
            {
                HttpWebRequest request = WebRequest.Create(requestUrl) as HttpWebRequest;
                using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)
                {
                    if (response.StatusCode != HttpStatusCode.OK)
                        throw new Exception(String.Format(
                        "Server error (HTTP {0}: {1}).",
                        response.StatusCode,
                        response.StatusDescription));
                    DataContractJsonSerializer jsonSerializer = new DataContractJsonSerializer(typeof(Response));
                    object objResponse = jsonSerializer.ReadObject(response.GetResponseStream());
                    Response jsonResponse
                    = objResponse as Response;
                    return jsonResponse;
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
                return null;
            }

        }

        static public void ProcessResponse(Response locationsResponse)
        {

            int locNum = locationsResponse.ResourceSets[0].Resources.Length;

            //Get formatted addresses: Option 1
            //Get all locations in the response and then extract the formatted address for each location
            Console.WriteLine("Show all formatted addresses");
            for (int i = 0; i < locNum; i++)
            {
                Location location = (Location)locationsResponse.ResourceSets[0].Resources[i];
                Console.WriteLine(location.Address.FormattedAddress);
            }
            Console.WriteLine();
            
            //Get the Geocode Points for each Location
            for (int i = 0; i < locNum; i++)
            {
               Location location = (Location)locationsResponse.ResourceSets[0].Resources[i];
               Console.WriteLine("Geocode Points for "+location.Address.FormattedAddress);               
               int geocodePointNum = location.GeocodePoints.Length;
               for (int j = 0; j < geocodePointNum; j++)
               {
                   Console.WriteLine("    Point: "+location.GeocodePoints[j].Coordinates[0].ToString()+","+
                                                location.GeocodePoints[j].Coordinates[1].ToString());
                   double test = location.GeocodePoints[j].Coordinates[1];
                   Console.Write("    Usage: ");              
                   for (int k = 0; k < location.GeocodePoints[j].UsageTypes.Length; k++)
                   {                                                     
                      Console.Write(location.GeocodePoints[j].UsageTypes[k].ToString()+" ");
                   }
                   Console.WriteLine("\n\n");
               }
            }
            Console.WriteLine();


            //Get all locations that have a MatchCode=Good and Confidence=High
            Console.WriteLine("Locations that have a Confidence=High");
            for (int i = 0; i < locNum; i++)
            {
                Location location = (Location)locationsResponse.ResourceSets[0].Resources[i];
                if (location.Confidence == "High")
                    Console.WriteLine(location.Address.FormattedAddress);
            }
                        Console.WriteLine();

            Console.WriteLine("Press any key to exit");
            Console.ReadKey();


        }
    }
}

在 C# .NET 中驾驭 JSON：使用 Newtonsoft.Json 进行解析与 POST 请求实战
码觉客的博客
04-28 1102
是一个强大而灵活的库，为 C# 开发者提供了完整的 JSON 处理能力。无论是将复杂的 JSON 数据映射到强类型 C# 对象进行安全可靠的访问，还是使用JToken系列进行动态探索和操作未知结构的 JSON，它都能胜任。结合HttpClient发送类型的 POST 请求，是现代 C# 应用与 Web API 交互的基石。虽然 .NET Core 3.0 以后引入了内置的，它在某些场景下提供更好的性能，并且是微软官方在新的 .NET 版本中推荐的内置 JSON 库。然而，
Json解析C#的四个库
Yao_2333的博客
10-02 5518
       目前我用得较多的是Newtonsoft ，后面了解到还有轻量的MiniJSON，SimpleJson以及litjson。        这里MiniJSON最精简，是一个class文件，通过对string进行简单字符串的处理来解析。        然后就是SimpleJson，也是一个class文件，不过代码量超级多，功能相对比较全面。看其他博客对这个评价蛮高的，不过我没使用过，...
接口测试报错“REQUEST JSON PARSING FAILED”
最新发布
m0_66501929的博客
02-29 621
接口测试报错“REQUEST JSON PARSING FAILED”。json文本通过微信发送会自动添加空格，复制粘贴的时候需要注意。
http request 获取复杂json数据时出现异常解决额
lingfeng2008w的博客
12-24 3250
昨天遇到一个很有意思的问题，今天写下来跟大家分享一下，瞬间加深自己的印象，不对的地方希望大家指出。 是这样的。 用java servlet写了一个url连接用于外部调用，在dopost()方法中获取获取传递过来的json格式参数，起初我使用的方法是 String para = request.getParameter("para"); 然后通过 System.out.println
json Parsing failed，JSON解析失败问题解决方法
szy_fasheng的博客
04-18 8840
本人在使用js ajax调用某私有接口时遇到了该问题，请求返回值为{“data”:"",“info”:“json Parsing failed”,“status”:5146}，该私有接口对请求的Header和传入数据的格式要求非常严格，期初我认为是对请求返回的数据解析错误，之后发现是在传入数据时{、“都存在转义现象，有可能导致解析错误，这里附上改过之前与之后的代码，记录一下该问题： 1）改过之前： //向服务器发送请求 $.ajax({ url: "url", dataType: "json",
JSONException（JSON解析异常）可能的原因和解决方法
Java开源程序猿
12-29 1万+
时，适当地检查异常的类型，并采取适当的处理措施。详细的错误日志和异常堆栈信息对于定位和解决问题非常有帮助。时，适当地检查异常的类型，并采取适当的处理措施。详细的错误日志和异常堆栈信息对于定位和解决问题非常有帮助。表示在 JSON 解析过程中发生异常。
使用 IDEA 创建 SpringBoot 项目时报错 Error parsing JSON response 解决方案【全】
qq_44153697的博客
06-01 7559
环境 IDEA 2020.1 macOS 10.15.3 JDK 1.8 问题 在使用 IDEA 创建 Springboot 项目或模块时，报如下错误： 或 测试访问 https://start.spring.io/ 网址可以正常访问，网络无异常。 将 IDEA 19.1 卸载后重新安装 IDEA 20.1 还是有该问题。 之后通过 Google 得到两种解决方案均不能解决我的问题，其他人可以尝试使用前两种解决此问题。 解决方案 有以下三种解决方案，个人使用第三种成功解决此问题 前两者来自于sta
Parsing Gigabytes of JSON per Second - 25 Feb 2019 (1902.08318)-计算机科学
04-22
Parsing Gigabytes of JSON per SecondGeoff Langdale · Daniel LemireAbstract JavaScript Object Notation or JSON is aubiquitous data exchange format on the Web. IngestingJSON documents can become a ...
Parsing JSON in Swift
07-22
Parsing JSON in Swift will teach you to harness the power of Swift and give you confidence that your app can gracefully handle any JSON that comes its way. You'll learn: - How to use ...
WSAM-06-Parsing_C#_sectionbke_
10-02
标题“WSAM-06-Parsing_C#_sectionbke_”表明这是一份关于C#解析技术的文档，特别关注“sectionbke”部分。虽然描述“hasjdfhlajs hsjkd fa sjd ksjdfh lsjdf jds jksdhf lsd jshd sdjh”似乎没有提供任何实质信息，...
IDEA无法创建springboot项目、初始化失败、连接超时、Error parsing JSON response（错误解析json数据）
Cruel_xu的博客
06-08 3053
IDEA无法创建springboot项目状况： 出现问题原因 具体情况不明，经测试，idea可以正常链接https://start.spring.io ，按照之前，可以用开启手机热点解决该问题，但此时不能解决。 解决方案： 去官网手动创建，然后拷贝到项目中即可 使用阿里云的镜像网址创建https://start.aliyun.com/ ...
JSON.parse解析失败(报错，出错)
PUBGA的博客
10-13 4370
今天项目当中后台返回json格式的数据,报错是这个错误 后台返回的格式是这样的："[{“url”:“https://xxxxx.oss-cn-zhaxxxu.aliyuncs.com/xxxx/tmp_df565eexxxf0ff8f0673.jpg”}]" 我转换的时候是这样写的报了上边那个错，[0].url不能写道()里边 如果返回的数组里有对象，转换时候要这样写JSON.parse(this.form.license)[0].url 这才是正确的 ...
[flask小坑] request.json 无法获取请求body的json数据
热门推荐
orangleliu 笔记本
04-28 2万+
写接口自动化测试的时候，发现用httpie发送带有put请求，flask后端api可以获取到json数据，而我用robotframework发送的请求就不行，flask的 request.json 获取到的数据为 None 怎么办？查文档，看代码呗 代码 https://github.com/pallets/flask/blob/master/flask/wrappers.py#L53...
java无法解析类型数据_解析数据时出错org.json.JSONException：java.lang.String类型的值...
weixin_29957793的博客
02-25 1223
一直在尝试这些代码，我想发送一个电子邮件，它会自动生成密码，然后随机密码将更新在我的数据库列中，这是encrypted_pa​​ssword。我真的不知道我的代码有什么问题。我是这个android应用程序的新手，也使用php。而且我确实看到了一些与我的链接的其他问题，但是，我仍然无法解决它。谁能帮帮我吗？我最后一年的项目真的需要帮助。另一件事是在发送带有随机生成的密码的电子邮件之后，随机生成的密码...
ERR! registry error parsing json
不营养、的博客
07-26 5166
报错日志： ERR! registry error parsing json ERR! registry error parsing json 解决过程： 从github上克隆一个项目，在npm i的时候，一直报npm err! registry error parsing json。请注意，在这儿有【registry】这个关键字哦，所以猜测是registry的问题，而公司用的网dow...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值