发布一个列表搜索请求

请求

支持接受类型

应用程序/ xml

URI

Fetch List callout将参与者信息发送到应用程序连接器的URI，该连接器可以位于每个客户机的自定义位置。标准位置是:

https:// {servername} /同意/清单/ v1.2 /取回> < /代码

控件上配置URI注册应用程序连接器页Web服务下政府．

请求头-必需

带有端点基本授权的授权头。指身份验证为更多的信息。

请求头-可选

没有一个

请求模式

请求将包含一个fetch-list-request父元素，包含以下子元素。

元素 描述
long-code> < /代码 长代码是一个连接字符串，包含由连字符(-)分隔的父列表项键。
短代码> < /代码 短代码是父列表项的键。
查询> < /代码 星号通配符可能会从Expense传递到应用程序连接器。
  • Asterisk only(*) -返回由长代码表示的列表中的所有项目。
  • 文本后跟星号(West*) -返回所有以文本开头的项目。
  • Asterisk后跟text -返回所有以text结尾的项
搜索> < /代码 指示应该搜索哪个列表项属性。支持的价值观:文本> < /代码，代码> < /代码．
请注意:为了正确处理通配符搜索，应用程序连接器必须支持这两个属性。
lang-code> < /代码 用户语言的两个字符代码。
num-to-return> < /代码 费用将指定要返回的物品数量。应用程序连接器必须使用此值，以确保返回的结果不会超过请求的结果。有一个系统限制100个项目。
protected-list-key> < /代码 内部连接器信息，不供客户使用。
列表名称> < /代码 内部连接器信息，不供客户使用。
connector-version> < /代码 内部连接器信息，不供客户使用。
配置选项> < /代码 内部连接器信息，不供客户使用。
code-by-level> < /代码 对于多级列表，指示每个级别的代码。

单级列表的XML示例请求

该示例使用Fetch List web服务搜索以Alph开头的所有项目的单个级别列表，并配置为连接到位于www.example.com的应用程序连接器。

帖子/同意/清单/ v1.2 /取回HTTPS/1．1宿主：example.com授权：基本…内容类型：应用程序/ xml;utf - 8字符集=内容长度：{内容体的长度}<？xml version = " 1.0 " ? >< fetch-list-request >< long-code > < / long-code ><短代码> < /短代码><查询>Alph *< /查询><搜索>文本< /搜索>< lang-code >在< / lang-code >< num-to-return >80< / num-to-return >< protected-list-key/><列表名称/>< connector-version/><配置选项/>< / fetch-list-request >

XML多级列表示例请求

该示例使用Fetch List web服务搜索以San开头的US-W-CA (u.s.， Western Region, California)下的所有城市的连接列表，并配置为连接到位于www.example.com的应用程序连接器。

帖子/同意/清单/ v1.2 /取回HTTPS/1．1宿主：example.com授权：基本…内容类型：应用程序/ xml;utf - 8字符集=内容长度：{内容体的长度}<？xml version = " 1.0 " ? >< fetch-list-request >< long-code >US-W-CA< / long-code ><短代码>CA< /短代码><查询>圣*< /查询><搜索>文本< /搜索>< lang-code >在< / lang-code >< num-to-return >80< / num-to-return >< protected-list-key/><列表名称/>< connector-version/><配置选项/>< code-by-level ><使>我们< /使><二级>W< /二级>< level3 >CA< / level3 >< / code-by-level >< / fetch-list-request >

响应

支持内容类型

应用程序/ xml

响应模式

应用程序连接器通过返回匹配搜索条件的所有列表项来响应Fetch列表web服务请求。

响应将包括一个fetch-list-response父元素，带有项子元素。如果没有搜索结果，则fetch-list-response元素是空的。的项子元素包含以下子元素:

元素 描述
代码> < /代码 要求列表项的长代码，由来自请求的长代码和来自响应的短代码组成，用连字符(-)分隔。
短代码> < /代码 要求列表项的短代码。
文本> < /代码 要求列表项文本。
匹配值> < /代码 要求匹配搜索项的值。

带有结果的响应的XML示例

HTTPS/1．1200好吧内容类型：应用程序/ xml内容长度：{内容体的长度}< fetch-list-response ><项目><代码>US-W-CA-SF> < /代码<短代码>科幻小说< /短代码><文本>旧金山< /文本><匹配值>旧金山< /匹配值>> < /项目<项目><代码>US-W-CA-SD> < /代码<短代码>SD< /短代码><文本>圣地亚哥< /文本><匹配值>圣地亚哥< /匹配值>> < /项目<项目><代码>US-W-CA-SJ> < /代码<短代码>SJ< /短代码><文本>圣荷西< /文本><匹配值>圣荷西< /匹配值>> < /项目< / fetch-list-response >

没有结果的响应的XML示例

HTTPS/1．1200好吧内容类型：应用程序/ xml< fetch-list-response >< / fetch-list-response >