Jump to

• Request
• Response

Get all valid associations by Association Type

get

/ec-site-svc/rest/v1.0/tenantsite/{associationType}/associations

Get all valid associations by Association Type. Associations are marked valid. if both associated entities are in active status and have atleast one common mode between them.

Request

Path Parameters

• associationType(required): string
  Association type of entities in request. Allowed values are INVESTIGATOR_INSTITUTION, DEPOT_INSTITUTION, LAB_INSTITUTION

Query Parameters

• limit: integer(int32)
  Number of rows to return.
• offset: integer(int32)
  Row number to start from.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : ValidTenantSitesDetailsResponse

Type: object

Show Source

• associationId: string (uuid)
• institutionTimezone: string
• modes: array modes
• tenantFirstEntityId: string (uuid)
• tenantFirstEntityName: string
• tenantFirstEntityPrimaryCity: string
• tenantFirstEntityPrimaryCountry: string (uuid)
• tenantFirstEntityPrimaryState: string (uuid)
• tenantSecondEntityId: string (uuid)
• tenantSecondEntityName: string

{
    "type":"object",
    "properties":{
        "tenantFirstEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "tenantSecondEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "associationId":{
            "type":"string",
            "format":"uuid"
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "tenantFirstEntityName":{
            "type":"string"
        },
        "tenantSecondEntityName":{
            "type":"string"
        },
        "institutionTimezone":{
            "type":"string"
        },
        "tenantFirstEntityPrimaryCity":{
            "type":"string"
        },
        "tenantFirstEntityPrimaryState":{
            "type":"string",
            "format":"uuid"
        },
        "tenantFirstEntityPrimaryCountry":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : modes

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top