Intuit IPP Rest API查询字符串转义

时间:2014-03-19 20:32:07

标签: api rest intuit-partner-platform intuit

所以,对于Intuit IPP Rest API

如果我想查询姓名为ABC的客户,我可以使用这样的http获取请求

https://qb.sbfinance.intuit.com/v3/company/198445012/query?query=select Id from Customer where FullyQualifiedName%3D'ABC'

& 3D是' ='的网址转义,这没有任何问题。

现在,如果客户的名字是A& B,我尝试了这样的查询字符串

select Id from Customer where FullyQualifiedName='A&B'

在网址编码之后,它看起来像这样

https://qb.sbfinance.intuit.com/v3/company/198445012/query?query=select Id from Customer where FullyQualifiedName%3D'A%26B'

它会失败。

任何想法?

更新

我从IPP的API资源管理器中复制了以上网址。

以下是代码,我正在使用DevDefined.OAuth

        IConsumerRequest conReq = _oSession.Request();
        conReq = conReq.Get();
        conReq.AcceptsType = "application/xml";
        //conReq = conReq.ForUrl(string.Format(@"https://qb.sbfinance.intuit.com/v3/company/{0}/query?query={1}", Settings.Default.QuickBooksOnlineRealmId, @"select * from Customer where DisplayName='ABC'"));   if use this line, it works fine
        conReq = conReq.ForUrl(string.Format(@"https://qb.sbfinance.intuit.com/v3/company/{0}/query?query={1}", Settings.Default.QuickBooksOnlineRealmId, @"select * from Customer where DisplayName='A&B'"));
        try
        {                
            string str = conReq.ReadBody();

        catch (Exception ex)
        {
            //ex.Message
        }

像这样返回的xml数据

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2014-03-20T06:24:12.408-07:00">
  <Fault type="ValidationFault">
    <Error code="4000">
      <Message>Error parsing query</Message>
      <Detail>QueryParserError: Invalid content. Lexical error at line 1, column 44.  Encountered: &lt;EOF&gt; after : &quot;\'A&quot;</Detail>
    </Error>
  </Fault>
</IntuitResponse>

我不是百分百肯定,昨天当我测试时,它实际上返回的东西说oauth失败了。但这是我今天早上得到的。

实际上,您可以在IPP的API资源管理器中试用它,它会得到相同的结果。

ForUrl的devdefined代码

public static IConsumerRequest ForUrl(this IConsumerRequest request, string url)
{
    request.Context.RawUri = new Uri(url);
    return request;
}

这会将网址编码为

https://qb.sbfinance.intuit.com/v3/company/1122502005/query?query=select%20*%20from%20Customer%20where%20DisplayName='A&B'

好的,终于,发现问题:

真正的问题是Uri(url)不会逃脱&amp;在&#39; A&amp; B&#39;因为它不知道它是否是一个网址&amp;或部分数据,所以我更改了以下行

conReq = conReq.ForUrl(string.Format(@"https://qb.sbfinance.intuit.com/v3/company/{0}/query?query={1}", Settings.Default.QuickBooksOnlineRealmId, @"select * from Customer where DisplayName='A&B'"));

as

conReq = conReq.ForUrl(string.Format(@"https://qb.sbfinance.intuit.com/v3/company/{0}/query?query={1}", Settings.Default.QuickBooksOnlineRealmId, Uri.EscapeDataString(@"select * from Customer where DisplayName='A&B'")));

首先使用Uri.EscapeDataString来转义数据查询字符串。

2 个答案:

答案 0 :(得分:2)

如果您创建名为“A&amp; B”的客户,则V3服务会返回该客户对象,如下所示 -

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IntuitResponse xmlns="http://schema.intuit.com/finance/v3" time="2014-03-20T01:54:46.834-07:00">
    <Customer domain="QBO" sparse="false">
        <Id>10</Id>
        <SyncToken>0</SyncToken>
        <MetaData>
            <CreateTime>2014-03-20T01:54:46-07:00</CreateTime>
            <LastUpdatedTime>2014-03-20T01:54:47-07:00</LastUpdatedTime>
        </MetaData>
        <FullyQualifiedName>A&amp;B</FullyQualifiedName>
        <DisplayName>A&amp;B</DisplayName>
        <PrintOnCheckName>A&amp;B</PrintOnCheckName>
        <Active>true</Active>
        <Taxable>true</Taxable>
        <Job>false</Job>
        <BillWithParent>false</BillWithParent>
        <Balance>100.00</Balance>
        <BalanceWithJobs>100.00</BalanceWithJobs>
        <PreferredDeliveryMethod>Email</PreferredDeliveryMethod>
    </Customer>
</IntuitResponse>

要按名称检索此对象,您需要使用以下查询

SELECT * FROM Customer WHERE DisplayName = 'A&B'

它需要像以下

一样进行网址编码
SELECT+*+FROM+Customer+WHERE+DisplayName+%3D+%27A%26B%27

实现此目的的Java代码 -

Customer customer = GenerateQuery.createQueryEntity(Customer.class);
String query = select($(customer)).where($(customer.getDisplayName()).eq("A&B")).generate();
// Query output - SELECT * FROM Customer WHERE DisplayName = 'A&B'
String encodedUrl = URLEncoder.encode(query, "UTF-8");

完美无缺。 (Devkit非常好地处理所有这些)

希望这能回答你的问题。

由于

答案 1 :(得分:1)

请在此处查看示例以逃避特殊字符 -

using Intuit.Ipp.Core;
using Intuit.Ipp.Data;
using Intuit.Ipp.LinqExtender;
using Intuit.Ipp.QueryFilter;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;


static class SampleCalls
{
public static Customer QueryCustomerByDisplayName(ServiceContext context, string     displayName)     {
displayName = displayName.Replace("'", "\\'"); //Escape special characters
QueryService<Customer> customerQueryService = new QueryService<Customer>(context);
return customerQueryService.Where(m => m.DisplayName == displayName).FirstOrDefault();
}
}