你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Prescriptions - List By Farmer Id

返回特定农民下处方资源的分页列表。

GET /farmers/{farmerId}/prescriptions?api-version=2021-07-31-preview
GET /farmers/{farmerId}/prescriptions?prescriptionMapIds={prescriptionMapIds}&types={types}&productCodes={productCodes}&productNames={productNames}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-07-31-preview

URI 参数

名称 必需 类型 说明
farmerId
path True

string

关联农民的 ID。

api-version
query True

string

请求的 API 版本

$maxPageSize
query

integer

int32

(非独占) 所需的项目数上限。 最小值 = 10,最大值 = 1000,默认值 = 50。

$skipToken
query

string

跳过用于获取下一组结果的令牌。

ids
query

string[]

资源的 ID。

maxCreatedDateTime
query

string

date-time

资源的最大创建日期 (非独占) 。

maxLastModifiedDateTime
query

string

date-time

资源的上次修改日期上限 (非独占) 。

minCreatedDateTime
query

string

date-time

资源的最小创建日期 (非独占) 。

minLastModifiedDateTime
query

string

date-time

资源的上次修改日期的最小 ((含) )。

names
query

string[]

资源的名称。

prescriptionMapIds
query

string[]

资源的处方映射 ID。

productCodes
query

string[]

资源的产品代码。

productNames
query

string[]

资源的产品名称。

propertyFilters
query

string[]

筛选 Properties 对象中的键值对。 例如 “{testKey} eq {testValue}”。

sources
query

string[]

资源的源。

statuses
query

string[]

资源的状态。

types
query

string[]

资源的类型。

请求头

名称 必需 类型 说明
Authorization True

string

请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。

响应

名称 类型 说明
200 OK

PrescriptionListResponse

Success

Other Status Codes

ErrorResponse

错误

标头

x-ms-error-code: string

安全性

Authorization

请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。

类型: apiKey
在: header

示例

Prescriptions_ListByFarmerId

示例请求

GET /farmers/FARMER123/prescriptions?api-version=2021-07-31-preview

示例响应

{
  "value": [
    {
      "id": "PRESCRIPTION123",
      "farmerId": "FARMER123",
      "prescriptionMapId": "PRESCRIPTINMAP123",
      "productCode": "PRODUCTCODE123",
      "productName": "Some name",
      "type": "Planting",
      "source": "TestLab123",
      "measures": {
        "total material": {
          "value": 12,
          "unit": "pounds"
        },
        "rate": {
          "value": 13,
          "unit": "Km/hr"
        }
      },
      "name": "John Smith's Prescription",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "$skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/prescriptions?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

定义

名称 说明
Error

Azure AgPlatform 服务出错。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。 ErrorResponse reference document..

InnerError

包含错误列表的内部错误。 InnerError 引用文档。

Measure

用于存储度量读数和单位的架构。

Prescription

Api Model for Prescription 对象。

PrescriptionListResponse

分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。

Error

Azure AgPlatform 服务出错。

名称 类型 说明
code

string

服务器定义的错误代码集。

details

Error[]

有关导致此报告错误的特定错误的详细信息数组。

innererror

InnerError

包含错误列表的内部错误。 InnerError 引用文档。

message

string

错误的用户可读表示形式。

target

string

错误的目标。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。 ErrorResponse reference document..

名称 类型 说明
error

Error

Azure AgPlatform 服务出错。

traceId

string

唯一跟踪 ID。

InnerError

包含错误列表的内部错误。 InnerError 引用文档。

名称 类型 说明
code

string

包含的错误提供的特定错误代码。

innererror

InnerError

包含错误列表的内部错误。 InnerError 引用文档。

Measure

用于存储度量读数和单位的架构。

名称 类型 说明
unit

string

数据单位。

value

number

数据值。

Prescription

Api Model for Prescription 对象。

名称 类型 说明
createdDateTime

string

创建资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。

description

string

资源的文本说明。

eTag

string

实现乐观并发的 ETag 值。

farmerId

string

农民 ID。

id

string

唯一资源 ID。

measures

<string,  Measure>

措施。

modifiedDateTime

string

上次修改资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。

name

string

用于标识资源的名称。

prescriptionMapId

string

处方映射 ID。

productCode

string

产品代码。

productName

string

产品名称。

properties

属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。

source

string

资源的源。

status

string

资源的状态。

type

string

处方类型。

PrescriptionListResponse

分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。

名称 类型 说明
$skipToken

string

用于检索下一页的令牌。 如果为 null,则没有其他页。

nextLink

string

列表中下一页结果的继续链接(绝对 URI)。

value

Prescription[]

请求的对象列表。