REST API for Clinical One Platform

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.

Response

Supported Media Types

application/json

200 Response

Successful operation.

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)
objectVersionNumber: number
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"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "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

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

Nested Schema : PropertyDto

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
entityId: string (uuid)
entityType: string

Minimum Length: 0

Maximum Length: 50
id: string (uuid)
objectVersionNumber: number
propertyName(required): string

Minimum Length: 0

Maximum Length: 100
propertyValue(required): string

Minimum Length: 0

Maximum Length: 500
reason: string

Minimum Length: 0

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

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

400 Response

Bad request.

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)
objectVersionNumber: number
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"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "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

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

Nested Schema : PropertyDto

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
entityId: string (uuid)
entityType: string

Minimum Length: 0

Maximum Length: 50
id: string (uuid)
objectVersionNumber: number
propertyName(required): string

Minimum Length: 0

Maximum Length: 100
propertyValue(required): string

Minimum Length: 0

Maximum Length: 500
reason: string

Minimum Length: 0

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

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