GET PlanCare2Api/MedicalWeight?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalWeightSummary of the specified relation.

Relation(s) can be of the following types: Client, Prospect

Requires 'Read' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

Request Information

URI Parameters

Name Description Type Additional information
relationId

The id of the relation.

integer

Required

registrationDateTimeFrom

RegistrationDateTime filter from.

date

Nullable

registrationDateTimeUntil

RegistrationDateTime filter until.

date

Nullable

Body Parameters

None.

Response Information

Resource Description

List of MedicalWeightSummary.

Collection of MedicalWeightSummary
Name Description Type Additional information
Weight

Weight in kilograms.

decimal number

-

MedicalCodeContextClothingDescription

Description of MedicalCodeContextClothing.

string

-

Remarks

Remarks.

string

-

Id

Id of the registration.

integer

-

RegistrationDateTime

DateTime of measurement.

date

-

Source

Source of registration (example: name of the questionnaire).

string

-

ChangedOn

DateTime when registration is last changed (read-only).

date

-

ChangedByRelationLookupName

LookupName of the relation who made the change (read-only).

string

-

TextValue

The compound value of the registration (read-only).

string

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Weight": 1.0,
    "MedicalCodeContextClothingDescription": "sample string 2",
    "Remarks": "sample string 3",
    "Id": 4,
    "RegistrationDateTime": "2026-05-26T22:08:01.3457936+02:00",
    "Source": "sample string 6",
    "ChangedOn": "2026-05-26T22:08:01.3457936+02:00",
    "ChangedByRelationLookupName": "sample string 8",
    "TextValue": "sample string 9"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMedicalWeightSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Medical">
  <MedicalWeightSummary>
    <ChangedByRelationLookupName>sample string 8</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T22:08:01.3457936+02:00</ChangedOn>
    <Id>4</Id>
    <RegistrationDateTime>2026-05-26T22:08:01.3457936+02:00</RegistrationDateTime>
    <Source>sample string 6</Source>
    <TextValue>sample string 9</TextValue>
    <MedicalCodeContextClothingDescription>sample string 2</MedicalCodeContextClothingDescription>
    <Remarks>sample string 3</Remarks>
    <Weight>1</Weight>
  </MedicalWeightSummary>
  <MedicalWeightSummary>
    <ChangedByRelationLookupName>sample string 8</ChangedByRelationLookupName>
    <ChangedOn>2026-05-26T22:08:01.3457936+02:00</ChangedOn>
    <Id>4</Id>
    <RegistrationDateTime>2026-05-26T22:08:01.3457936+02:00</RegistrationDateTime>
    <Source>sample string 6</Source>
    <TextValue>sample string 9</TextValue>
    <MedicalCodeContextClothingDescription>sample string 2</MedicalCodeContextClothingDescription>
    <Remarks>sample string 3</Remarks>
    <Weight>1</Weight>
  </MedicalWeightSummary>
</ArrayOfMedicalWeightSummary>