Jump to

• Request
• Response

Get facilities

get

/ec-site-svc/rest/v1.0/facilities/{InstitutionId}

Retrieves facilities or departments for an institution.

Request

Path Parameters

• InstitutionId(required): string
  Institution ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : FacilityModelResponseList

Type: object

Show Source

• facilityModels: array facilityModels

{
    "type":"object",
    "properties":{
        "facilityModels":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FacilityModelResponse"
            }
        }
    }
}

Nested Schema : facilityModels

Type: array

Show Source

• Array of: object FacilityModelResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FacilityModelResponse"
    }
}

Nested Schema : FacilityModelResponse

Type: object

Show Source

• facilityDto: object FacilityDto
• properties: array properties
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "facilityDto":{
            "$ref":"#/components/schemas/FacilityDto"
        },
        "properties":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        }
    }
}

Nested Schema : FacilityDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId(required): string (uuid)
• entityType(required): string
  Minimum Length: 0

  Maximum Length: 50
• facilityName(required): string
  Minimum Length: 0

  Maximum Length: 100
• id: string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• versionStart: string (date-time)

{
    "required":[
        "entityId",
        "entityType",
        "facilityName"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "facilityName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        }
    }
}

Nested Schema : properties

Type: array

Unique Items Required: true

Show Source

• Array of: object PropertyDto
  CTMS Property DTO

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PropertyDto"
    }
}

Nested Schema : PropertyDto

Type: object

CTMS Property DTO

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Minimum Length: 0

  Maximum Length: 50

  Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Unique key name of the property.

  Example: LabId
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 500

  Value of the property.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Minimum Length: 0

  Maximum Length: 255

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Unique key name of the property.",
            "example":"LabId"
        },
        "propertyValue":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":" Value of the property.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"CTMS Property DTO"
}

400 Response

Bad request.

Body ()

Root Schema : FacilityModelResponseList

Type: object

Show Source

• facilityModels: array facilityModels

{
    "type":"object",
    "properties":{
        "facilityModels":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FacilityModelResponse"
            }
        }
    }
}

Nested Schema : facilityModels

Type: array

Show Source

• Array of: object FacilityModelResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FacilityModelResponse"
    }
}

Nested Schema : FacilityModelResponse

Type: object

Show Source

• facilityDto: object FacilityDto
• properties: array properties
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "facilityDto":{
            "$ref":"#/components/schemas/FacilityDto"
        },
        "properties":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        }
    }
}

Nested Schema : FacilityDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId(required): string (uuid)
• entityType(required): string
  Minimum Length: 0

  Maximum Length: 50
• facilityName(required): string
  Minimum Length: 0

  Maximum Length: 100
• id: string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• versionStart: string (date-time)

{
    "required":[
        "entityId",
        "entityType",
        "facilityName"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "facilityName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        }
    }
}

Nested Schema : properties

Type: array

Unique Items Required: true

Show Source

• Array of: object PropertyDto
  CTMS Property DTO

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PropertyDto"
    }
}

Nested Schema : PropertyDto

Type: object

CTMS Property DTO

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Minimum Length: 0

  Maximum Length: 50

  Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Unique key name of the property.

  Example: LabId
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 500

  Value of the property.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Minimum Length: 0

  Maximum Length: 255

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Unique key name of the property.",
            "example":"LabId"
        },
        "propertyValue":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":" Value of the property.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"CTMS Property DTO"
}

Back to Top