Jump to

• Request
• Response

Get organization by ID

get

/ec-site-svc/rest/v1.0/organizations/{id}

Retrieves an organization based on the organization ID.

Request

Path Parameters

• id(required): string
  ID of an organization.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : Contacts

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• contactId: string
  Minimum Length: 0

  Maximum Length: 50
• contactType(required): string (uuid)
• degree: string
  Minimum Length: 0

  Maximum Length: 200
• disbarmentEnd: string (date-time)
• disbarmentStart: string (date-time)
• firstName(required): string
  Minimum Length: 0

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

  Maximum Length: 100
• middleName: string
  Minimum Length: 0

  Maximum Length: 100
• prefix: string (uuid)
• prefixCodeValue: string
• primarySpecialityId: string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• status(required): string (uuid)
• statusCodeValue: string
• studyAgnostic(required): string
• studyId(required): string
• suffix: string (uuid)
• suffixCodeValue: string
• taxId: string
  Minimum Length: 0

  Maximum Length: 50
• timezone: string
• versionStart: string (date-time)

{
    "required":[
        "contactType",
        "firstName",
        "lastName",
        "status",
        "studyAgnostic",
        "studyId"
    ],
    "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"
        },
        "firstName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "lastName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "middleName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "suffix":{
            "type":"string",
            "format":"uuid"
        },
        "prefix":{
            "type":"string",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "format":"uuid"
        },
        "degree":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string"
        },
        "contactId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "timezone":{
            "type":"string"
        },
        "taxId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "primarySpecialityId":{
            "type":"string",
            "format":"uuid"
        },
        "disbarmentStart":{
            "type":"string",
            "format":"date-time"
        },
        "disbarmentEnd":{
            "type":"string",
            "format":"date-time"
        },
        "contactType":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string"
        },
        "studyAgnostic":{
            "type":"string"
        },
        "suffixCodeValue":{
            "type":"string"
        },
        "prefixCodeValue":{
            "type":"string"
        },
        "statusCodeValue":{
            "type":"string"
        }
    }
}

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