GET PlanCare2Api/CareRegistration/TransferAdvices?clientId={clientId}&includeImages={includeImages}

Gets the Transfer advices for the specified client

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The clientId to obtain the Transfer advices for.	integer	Required
includeImages	Optional parameter indicating the image should be included in the TransferAdviceLine records. The default value is false.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

The list of requested Transfer advices

Collection of TransferAdvice

Name	Description	Type	Additional information
Lines	Transfer advice lines	Collection of TransferAdviceLine	None
Id	The internal id of the registration. Should be 0 for new instance.	integer	Required
EmployeeId	The internal id of the employee who has done the registration. When the EmployeeId is not the same as the logged on employee, then the logged on employee must be authorized in Plancare2 to store information on behalf of the given EmployeeId.	integer	Required
EmployeeName	The name of the employee. This property is for reading purposes only.	string	None
ClientId	The internal id of the client.	integer	Required
ClientName	The name of the client. This property is for reading purposes only.	string	None
CreationDate	The date when the registration is created. This property is for reading purposes only.	date	None
RegistrationDate	The registration date.	date	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Lines": [
      {
        "$id": "2",
        "Id": 1,
        "TypeId": 2,
        "Type": "sample string 3",
        "TransferId": 4,
        "TransferText": "sample string 5",
        "Remarks": "sample string 6",
        "ImageId": 1,
        "Image": "sample string 7"
      },
      {
        "$ref": "2"
      }
    ],
    "Id": 1,
    "EmployeeId": 2,
    "EmployeeName": "sample string 3",
    "ClientId": 4,
    "ClientName": "sample string 5",
    "CreationDate": "2026-05-26T21:10:50.6654572+02:00",
    "RegistrationDate": "2026-05-26T21:10:50.6654572+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfTransferAdvice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.CareRegistration">
  <TransferAdvice>
    <ClientId>4</ClientId>
    <ClientName>sample string 5</ClientName>
    <CreationDate>2026-05-26T21:10:50.6654572+02:00</CreationDate>
    <EmployeeId>2</EmployeeId>
    <EmployeeName>sample string 3</EmployeeName>
    <Id>1</Id>
    <RegistrationDate>2026-05-26T21:10:50.6654572+02:00</RegistrationDate>
    <Lines>
      <TransferAdviceLine>
        <Id>1</Id>
        <Image>sample string 7</Image>
        <ImageId>1</ImageId>
        <Remarks>sample string 6</Remarks>
        <TransferId>4</TransferId>
        <TransferText>sample string 5</TransferText>
        <Type>sample string 3</Type>
        <TypeId>2</TypeId>
      </TransferAdviceLine>
      <TransferAdviceLine>
        <Id>1</Id>
        <Image>sample string 7</Image>
        <ImageId>1</ImageId>
        <Remarks>sample string 6</Remarks>
        <TransferId>4</TransferId>
        <TransferText>sample string 5</TransferText>
        <Type>sample string 3</Type>
        <TypeId>2</TypeId>
      </TransferAdviceLine>
    </Lines>
  </TransferAdvice>
  <TransferAdvice>
    <ClientId>4</ClientId>
    <ClientName>sample string 5</ClientName>
    <CreationDate>2026-05-26T21:10:50.6654572+02:00</CreationDate>
    <EmployeeId>2</EmployeeId>
    <EmployeeName>sample string 3</EmployeeName>
    <Id>1</Id>
    <RegistrationDate>2026-05-26T21:10:50.6654572+02:00</RegistrationDate>
    <Lines>
      <TransferAdviceLine>
        <Id>1</Id>
        <Image>sample string 7</Image>
        <ImageId>1</ImageId>
        <Remarks>sample string 6</Remarks>
        <TransferId>4</TransferId>
        <TransferText>sample string 5</TransferText>
        <Type>sample string 3</Type>
        <TypeId>2</TypeId>
      </TransferAdviceLine>
      <TransferAdviceLine>
        <Id>1</Id>
        <Image>sample string 7</Image>
        <ImageId>1</ImageId>
        <Remarks>sample string 6</Remarks>
        <TransferId>4</TransferId>
        <TransferText>sample string 5</TransferText>
        <Type>sample string 3</Type>
        <TypeId>2</TypeId>
      </TransferAdviceLine>
    </Lines>
  </TransferAdvice>
</ArrayOfTransferAdvice>