使用RestSharp构建XML请求

时间:2015-12-30 10:45:38

标签: c# xml rest restsharp

我正在尝试使用RestSharp和C#使用REST API。 我正在使用的API文档提供了一个示例XML请求:

<?xml version='1.0' encoding='UTF-8'?>  
<messages>  
 <accountreference>EX0000000</accountreference> 
 <from>07700900654</from>
 <message>  
  <to>07700900123</to>  
  <type>SMS</type>  
  <body>Hello Mr Sands.</body>
 </message>  
 <message>  
  <to>07700900124</to>  
  <type>SMS</type>  
  <body>Hello Mr Mayo.</body>
 </message>  
</messages>

我很难理解如何以他们想要的格式构建请求(多个元素称为&#34; message&#34;)

我已经为RestSharp创建了这些类来序列化:

public class messages
{
    public string accountreference { get; set; }

    public string from { get; set; }

    public message message { get; set; }
}

public class message
{
    public string to { get; set; }

    public string body { get; set; }
}

这是我的RestSharp代码:

var client = new RestClient("http://api.url.com/v1.0")
                         {
                             Authenticator =
                                 new HttpBasicAuthenticator(
                                 UserName,
                                 Password)
                         };

var request = new RestRequest("theresource", Method.POST) { RequestFormat = DataFormat.Xml };

request.AddBody(
    new messages
        {
            accountreference = Configuration.AccountReference,
            from = Configuration.From,
            message =
                new message { to = Configuration.Message.To, body = Configuration.Message.Body }
        });

var response = client.Execute(request);

当我只有一个消息元素时,这很有用,但我不知道如何创建多个消息元素而不将它们嵌套在一个数组中,而这些数组不能与API一起使用。

2 个答案:

答案 0 :(得分:11)

默认情况下,RestSharp使用自己的序列化程序,但它也包含DotNetSerializer,因此您可以通过更改序列化程序来实现目标:

var request = new RestRequest("theresource", Method.POST) 
{ 
    RequestFormat = DataFormat.Xml, 
    XmlSerializer = new RestSharp.Serializers.DotNetXmlSerializer() 
};

然后,您可以使用消息对象列表,并使用 XmlElement 属性对其进行修饰:

public class messages
{
    public string accountreference { get; set; }

    public string from { get; set; }

    [XmlElement("message")]
    public List<message> messageList { get; set; }
}


public class message
{
    public string to { get; set; }

    public string body { get; set; }
}

然后您可以更改最后一位以添加多条消息:

request.AddBody(
    new messages
    {
        accountreference = "ref",
        from = "from",
        messageList = new List<message>() {
                new message { to = "to1", body = "body1" },
                new message { to = "to2", body = "body2" }
                }
    }); 

会产生(我通过检查request.Parameters [0] .Value得到了XML):

<?xml version="1.0" encoding="utf-8"?>
<messages>
  <accountreference>ref</accountreference>
  <from>from</from>
  <message>
    <to>to1</to>
    <body>body1</body>
  </message>
  <message>
    <to>to2</to>
    <body>body2</body>
  </message>
</messages>

我想这是您一直在寻找的XML格式。

答案 1 :(得分:0)

将消息作为列表将起作用 -

public class messages
{
    public string accountreference { get; set; }

    public string from { get; set; }

    public List<message> message { get; set; }
}

public class message
{
    public string to { get; set; }

    public string body { get; set; }
}

在这里查看最后一个答案 -

How to post an array of complex objects with JSON, jQuery to ASP.NET MVC Controller?

如果您遇到列表问题,请尝试此操作 -

Can RestSharp send a List<string> in a POST request?