API docs by Redocly

Tenant integration API (0.0.1)

Tenant integration API

Get a list of tenants based on consortiumId

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 100

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "totalRecords": 0
}

Save tenant

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

query Parameters
adminUserId
string <uuid> (uuid)

The ID of adminUser

Request Body schema: application/json
required

Tenant object

id
required
string
code
required
string [ 2 .. 5 ] characters ^[a-zA-Z0-9]*$
name
required
string [ 2 .. 150 ] characters
isCentral
required
boolean
isDeleted
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "name": "string",
  • "isCentral": true,
  • "isDeleted": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "name": "string",
  • "isCentral": true,
  • "isDeleted": true
}

Update tenant name

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

tenantId
required
string

The ID of the tenant

Request Body schema: application/json
required

Tenant object

id
required
string
code
required
string [ 2 .. 5 ] characters ^[a-zA-Z0-9]*$
name
required
string [ 2 .. 150 ] characters
isCentral
required
boolean
isDeleted
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "name": "string",
  • "isCentral": true,
  • "isDeleted": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "name": "string",
  • "isCentral": true,
  • "isDeleted": true
}

Delete tenant by Id

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

tenantId
required
string

The ID of the tenant

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}

Get tenant details by Id

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

tenantId
required
string

The ID of the tenant

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "name": "string",
  • "isCentral": true,
  • "isDeleted": true,
  • "setupStatus": "IN_PROGRESS"
}

Sync Primary Affiliations

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

tenantId
required
string

The ID of the tenant

query Parameters
centralTenantId
required
string

The ID of the central tenant

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}

Create Primary Affiliations

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

tenantId
required
string

The ID of the tenant

query Parameters
centralTenantId
required
string

The ID of the central tenant

Request Body schema: application/json
required

SyncPrimaryAffiliationsRequest object

tenantId
required
string

Unique tenant id

Array of objects (SyncUser)

users

Array
id
string

User id

username
string

The name of the user

email
string

The email of the user

mobilePhoneNumber
string

The mobile phone number of the user

phoneNumber
string

The phone number of the user

externalSystemId
string

External system id of user

barcode
string

The user's barcode

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}