GET PlanCare2Api/ExternalConnectionData/{connectionId}/Client?clientId={clientId}&organizationEntityId={organizationEntityId}

Retrieve context for an external connection. Usage of this call is exclusively restricted to certain partners. The guid of the connection for which to retrieve data.The id of the client for which to retrieve data.The network relation OeId.

Request Information

URI Parameters

Name	Type	Additional information
connectionId	globally unique identifier	Required
clientId	integer	Required
organizationEntityId	integer	Nullable

Body Parameters

None.

Response Information

Resource Description

ExternalConnectionInfo

Name	Description	Type	Additional information
dhs.OrganizationIdentifier	OrganizationIdentifier	string	-
dhs.EnvironmentId	Plancare2 Environment identifier	string	-
dhs.PlancareVersion	PlancareVersion	string	-
ebMS-AgreementRef	ebMS-AgreementReference	string	-
ebMS-ServiceId	ebMS-ServiceId	string	-
ebMS-Action	ebMS-Action	string	-
ebMS-PartyFrom	ebMS-PartyFrom	string	-
Data	Connection specific data	Collection of Pair of string [key] and string [value]	-

Response Formats

application/json, text/json

Sample:

{
  "dhs.OrganizationIdentifier": "sample string 1",
  "dhs.EnvironmentId": "sample string 2",
  "dhs.PlancareVersion": "sample string 3",
  "ebMS-AgreementRef": "sample string 4",
  "ebMS-ServiceId": "sample string 5",
  "ebMS-Action": "sample string 6",
  "ebMS-PartyFrom": "sample string 7",
  "Data": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ExternalConnectionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ExternalConnectionData">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Data>
  <EbMsAction>sample string 6</EbMsAction>
  <EbMsAgreementRef>sample string 4</EbMsAgreementRef>
  <EbMsPartyFrom>sample string 7</EbMsPartyFrom>
  <EbMsServiceId>sample string 5</EbMsServiceId>
  <EnvironmentId>sample string 2</EnvironmentId>
  <OrganizationIdentifier>sample string 1</OrganizationIdentifier>
  <PlancareVersion>sample string 3</PlancareVersion>
</ExternalConnectionInfo>