GET PlanCare2Api/VisionModels?clientId={clientId}

Retrieve all visionmodels for the selected client.

At least one of these modules is required: ICP

Request Information

URI Parameters

Name Description Type Additional information
clientId

The client for whom to fetch the visionmodels.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of visionmodels including visionmodel items.

Collection of VisionModel
Name Description Type Additional information
Id

The internal id of the VisionModel

integer

-

Name

The name of the visionModel

string

-

Items

A list of VisionModelItems

Collection of VisionModelItem

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "Items": [
      {
        "$id": "2",
        "Id": 1,
        "Name": "sample string 2"
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfVisionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <VisionModel>
    <Id>1</Id>
    <Items>
      <VisionModelItem>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </VisionModelItem>
      <VisionModelItem>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </VisionModelItem>
    </Items>
    <Name>sample string 2</Name>
  </VisionModel>
  <VisionModel>
    <Id>1</Id>
    <Items>
      <VisionModelItem>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </VisionModelItem>
      <VisionModelItem>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </VisionModelItem>
    </Items>
    <Name>sample string 2</Name>
  </VisionModel>
</ArrayOfVisionModel>