GET api/v1/infrastructure/tenant/xref/{xref}

Get tenant by xRef (e.g. mps-83b5f484521892640000005056843e73, nova-999992_hpcsaNo)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
xref

Unique identifier of tenant in external system

 string

Required

Body Parameters

None.

Response Information

Resource Description

Tenant object

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.TenantVo
NameDescriptionTypeAdditional information
TenantId

globally unique identifier

None.
TenantXRef

string

None.
Description

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TenantId": "35079595-7de9-4739-ac33-4e8167012f0f",
  "TenantXRef": "sample string 2",
  "Description": "sample string 3"
}

application/xml, text/xml

Sample: 
<Tenant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/platform/commondomain/v1/tenant/">
  <Description>sample string 3</Description>
  <TenantId>35079595-7de9-4739-ac33-4e8167012f0f</TenantId>
  <TenantXRef>sample string 2</TenantXRef>
</Tenant>