Jump to

• Request
• Response

v1.0

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 at least one common mode between them.

Request

Path Parameters

• associationType(required): string
  Association type in the request. Allowed values: INVESTIGATOR_INSTITUTION (investigator linked to institution), DEPOT_INSTITUTION (depot linked to institution), LAB_INSTITUTION (lab linked to institution).

  Example:

  INVESTIGATOR_INSTITUTION

Query Parameters

• limit: integer(int32)
  Maximum number of rows to return. Only non-negative integers are accepted.
• offset: integer(int32)
  Zero-based row index to start pagination. Only non-negative integers are accepted.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : VALID_TENANT_SITES_DETAILS_RESPONSE_TITLE

Type: object

Title: VALID_TENANT_SITES_DETAILS_RESPONSE_TITLE

VALID_TENANT_SITES_DETAILS_RESPONSE_DESC

Show Source

• associationId: string (uuid)
• institutionTimezone: string
  Title: VALID_TENANT_SITES_DETAILS_RESPONSE_TIMEZONE_TITLE

  VALID_TENANT_SITES_DETAILS_RESPONSE_TIMEZONE_DESC

  Example: America/New_York
• modes: array modes
• tenantFirstEntityId: string (uuid)
• tenantFirstEntityName: string
  Title: VALID_TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_TITLE

  VALID_TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_DESC

  Example: Acme Research
• tenantFirstEntityPrimaryCity: string
  Title: VALID_TENANT_SITES_DETAILS_RESPONSE_PRIMARY_CITY_TITLE

  VALID_TENANT_SITES_DETAILS_RESPONSE_PRIMARY_CITY_DESC

  Example: Metropolis
• tenantFirstEntityPrimaryCountry: string (uuid)
• tenantFirstEntityPrimaryState: string (uuid)
• tenantSecondEntityId: string (uuid)
• tenantSecondEntityName: string
  Title: VALID_TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_TITLE

  VALID_TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_DESC

  Example: Beta Institution

{
    "title":"VALID_TENANT_SITES_DETAILS_RESPONSE_TITLE",
    "type":"object",
    "properties":{
        "tenantFirstEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "tenantSecondEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "associationId":{
            "type":"string",
            "format":"uuid"
        },
        "modes":{
            "type":"array",
            "example":[
                "B1B8327AFAA6412287106192AB5984EF"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "tenantFirstEntityName":{
            "title":"VALID_TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_TITLE",
            "type":"string",
            "description":"VALID_TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_DESC",
            "example":"Acme Research"
        },
        "tenantSecondEntityName":{
            "title":"VALID_TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_TITLE",
            "type":"string",
            "description":"VALID_TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_DESC",
            "example":"Beta Institution"
        },
        "institutionTimezone":{
            "title":"VALID_TENANT_SITES_DETAILS_RESPONSE_TIMEZONE_TITLE",
            "type":"string",
            "description":"VALID_TENANT_SITES_DETAILS_RESPONSE_TIMEZONE_DESC",
            "example":"America/New_York"
        },
        "tenantFirstEntityPrimaryCity":{
            "title":"VALID_TENANT_SITES_DETAILS_RESPONSE_PRIMARY_CITY_TITLE",
            "type":"string",
            "description":"VALID_TENANT_SITES_DETAILS_RESPONSE_PRIMARY_CITY_DESC",
            "example":"Metropolis"
        },
        "tenantFirstEntityPrimaryState":{
            "type":"string",
            "format":"uuid"
        },
        "tenantFirstEntityPrimaryCountry":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"VALID_TENANT_SITES_DETAILS_RESPONSE_DESC"
}

Nested Schema : modes

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "example":[
        "B1B8327AFAA6412287106192AB5984EF"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "B1B8327AFAA6412287106192AB5984EF"
]

Examples

Select an example Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Bad Request Response

Back to Top