Public API

import { ORGANIZATION } from ‘@agnesuserguide/config’;

Proyecto: Heimdall de dos patas

Utilice esta API para autorizar el acceso de dos vías y devolver un token JWT. El token es necesario para la autorización en todas las demás solicitudes de API.

📁 Colección: Usuarios

Punto final: obtener usuarios

Descripción:

Utilice esta API para obtener una matriz de objetos que contengan datos de usuario de la organización.

Propiedades del objeto:

Clave de propiedad	El valor de la propiedad	Descripción
organización	cadena UUID	El ID de la organización principal del usuario.
sub	cadena UUID	Número de abonado del usuario. Se utiliza para como un identificador único para el usuario.
primer nombre	cuerda	El nombre del usuario.
apellido	cuerda	El apellido del usuario.
role	cuerda	El rol del usuario dentro del sistema. “usuario”, “administrador”, “sistema”
npi	Número de diez dígitos como cadena	Un Identificador Nacional de Proveedor es un número de identificación único de 10 dígitos emitido a los proveedores de atención médica en los Estados Unidos por los Centros de Servicios de Medicare y Medicaid.

Ejemplo de objeto de retorno JSON:

[
    {
        "org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "username": "frodobaggins@email.com",
        "firstname": "Frodo",
        "lastname": "Baggins",
        "role": "user",
        "npi": null
    },
    {
        "org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "username": "bilbobaggins@email.com",
        "firstname": "Bilbo",
        "lastname": "Baggins",
        "role": "administrator",
        "npi": null
    }
]

Método: OBTENER

{{baseUrl}}/api/v1/org/{{orgId}}/users

Parámetros de consulta

Parámetro	valor
sub	{{$guid}}
grupo	{{$guid}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Colección: Portales

Punto final: obtener portales

Descripción:

Utilice esta API para obtener una matriz de objetos que contengan datos del portal de la organización.

Los portales son la representación virtual de la computadora de un usuario registrado en el sistema.

Propiedades del objeto:

Clave de propiedad	El valor de la propiedad	Descripción
datos	cadena UUID	datos

Ejemplo de objeto de retorno JSON:

[
    {
        "data": "data"
    },
    {
        "data": "data"
    }
]

Método: OBTENER

{{baseUrl}}/api/v1/org/{{orgId}}/portals

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Colección: Grupos

Punto final: obtener grupos

Utilice esta API para obtener una matriz de objetos que contengan datos de grupos de organización.

Método: OBTENER

{{baseUrl}}/api/v1/org/{{orgId}}/groups

Respuesta: 200

[
    {
        "id": "3s5*****-****-****-****-************",
        "org": "7ag*****-****-****-****-************",
        "name": "Administrators",
        "meta": {},
        "members": []
    },
    {
        "id": "9sd*****-****-****-****-************",
        "org": "53f*****-****-****-****-************",
        "name": "Test",
        "meta": {},
        "members": ["9ba*****-****-****-****-************"]
    }
]

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Crear grupo

Utilice esta API para crear un nuevo grupo en una organización.

Método: POST

{{baseUrl}}/api/v1/org/{{orgId}}/groups

Cuerpo (crudo)

{
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "meta": {},
    "members": []
}

Respuesta: 200

{
    "id": "04a*****-****-****-****-************",
    "org": "040*****-****-****-****-************",
    "name": "back-end hard drive",
    "meta": {
        "meta": {}
    },
    "members": []
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Obtener grupo por ID

Utilice esta API para obtener objetos que contengan datos para un grupo específico en una organización.

Método: OBTENER

{{baseUrl}}/api/v1/org/{{orgId}}/groups?id={{temporaryGroupId}}

Parámetros de consulta

Parámetro	valor
identificación	{{temporaryGroupId}}
identificación	717e4c96-847b-4b87-b22e-8488a7802d9a

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Modificar grupo

Utilice esta API para modificar los datos de un grupo específico en una organización.

Método: PARCHE

{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}

Cuerpo (crudo)

{
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "meta": {},
    "members": ["{{userId}}"]
}

Respuesta: 204

null

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Eliminar grupo

Utilice esta API para eliminar un grupo específico en una organización.

Método: ELIMINAR

{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Colección: Horario

Punto final: Obtener horario

Descripción:

Utilice esta API para obtener una matriz de objetos que contengan los datos de las citas programadas de una organización.

Devolver propiedades del objeto:

Clave de propiedad	El valor de la propiedad	Descripción
proveedor	cadena UUID	El id del médico que organiza la sesión. Obtenido de la propiedad sub de un usuario.
paciente	objeto	Objeto que contiene propiedades que describen a un paciente.
paciente.ID del paciente	cuerda	Un identificador único para el paciente.
paciente.nombre	cuerda	El nombre del paciente.
paciente.apellido	cuerda	El apellido del paciente.
paciente.fecha de nacimiento	Fecha en formato año-mes-fecha : AAAA-MM-DD	La fecha de nacimiento del paciente.
paciente.sexo	cuerda	El identificador biológico del paciente. “M” o “F”
ID de sesión	cadena UUID	Una identificación única que conecta una cita programada con los datos del paciente. Proporcionar una identificación de sesión al unirse a un portal extraerá los datos del paciente asociado para la cita programada. Si no se proporcionaron los datos del paciente al crear la cita programada, no se extraerán datos.
ID del portal	número de 64 dígitos	El ID del portal en el que está programada la cita.
hora de inicio	Fecha con formato ISO	Hora de inicio fuera de la cita programada.
tiempo de parada	Fecha con formato ISO	Hora de finalización de la cita programada.

Ejemplo de objeto de retorno JSON:

[
    {
        "providerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "patient": {
            "patientId": "c",
            "firstName": "Larry",
            "lastName": "Friesen",
            "birthDate": "2001-12-02",
            "sex": "M"
        },
        "sessionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "portalId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        "startTime": "2021-12-02T06:07:49.000Z",
        "stopTime": "2021-12-02T08:00:24.000Z"
    }
]

Método: OBTENER

{{baseUrl}}/api/v1/org/{{orgId}}/schedule?startDate=2021-01-01&perPage=10&page=0

Parámetros de consulta

Parámetro	valor
fecha de inicio	2021-01-01
fecha de parada	2021-12-03
por página	10
página	0
portales.nombre	Teleclínica Portátil

Respuesta: 200

[]

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Crear elemento de programación

Descripción:

Utilice esta API para crear una nueva cita programada para una organización.

Devolver propiedades del objeto:

Verdadero si la cita programada se creó con éxito

Falso si la cita programada se creó con éxito

Ejemplo de objeto de retorno JSON:

true

Método: PONER

{{baseUrl}}/api/v1/org/{{orgId}}/schedule

Cuerpo (crudo)

{
    "providerId": "{{userId}}",
    "patient": {
        "patientId": "{{$randomAlphaNumeric}}",
        "firstName": "{{$randomFirstName}}",
        "lastName": "{{$randomLastName}}",
        "birthDate": "{{randomDatePast}}",
        "sex": "M"
    },
    "sessionId": "{{$randomUUID}}",
    "portalId": "{{portalId}}",
    "startTime": "{{$randomDateRecent}}",
    "stopTime": "{{$randomDateRecent}}"
}

Respuesta: 200

true

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Obtener elemento de programación por ID

Descripción:

Utilice esta API para obtener un objeto que contenga datos para una cita programada específica de una organización.

Devolver propiedades del objeto:

Clave de propiedad	El valor de la propiedad	Descripción
datos	datos	datos

Ejemplo de objeto de retorno JSON:

{
    // TODO
}

Método: OBTENER

{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Eliminar elemento de programación

Utilice esta API para eliminar una cita programada específica en una organización.

Método: ELIMINAR

{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}

Respuesta: 200

{
    "sessionId": "1560f626-117f-4263-a068-46963357f30a",
    "providerId": null,
    "portalId": "8ad982843f36037b16450dd99c48663ecb6e031364241f146a906642efa9e101",
    "startTime": "2021-12-02T06:07:49.000Z",
    "stopTime": "2021-12-02T08:00:24.000Z",
    "meta": "{\"providerId\":\"b2f8d193-4e72-4d76-9dbf-677c86786ecb\",\"patient\":{\"patientId\":\"c\",\"firstName\":\"Larry\",\"lastName\":\"Friesen\",\"birthDate\":\"{{randomDatePast}}\",\"sex\":\"M\"}}"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Colección: Organización

Punto final: obtener organizaciones

Utilice esta API para obtener un objeto que contenga atributos de datos para una organización.

Ejemplo de objeto de respuesta:

[
    {
        "id": "2xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "parent": "0xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
        "name": "{ORGANIZATION.names.short} Demo Child",
        "slug": "{ORGANIZATION.names.short}-demo-child",
        "config": {
            "emr_provider": "redox",
            "datascan": {
                "api": {
                    "token": ""
                }
            },
            "ldap": {
                "url": null,
                "bindDN": null,
                "bindCredentials": null,
                "searchBase": "",
                "adminGroupDN": "",
                "users": {
                    "class": "inetOrgPerson",
                    "subAttribute": "",
                    "usernameAttribute": ""
                },
                "groups": {
                    "class": "groupOfUniqueNames",
                    "idAttribute": "dn",
                    "nameAttribute": "cn",
                    "memberAttribute": "uniqueMember"
                }
            },
            "emr_provider_org": null,
            "logo": null,
            "pcc": {
                "clientId": "",
                "clientSecret": ""
            },
            "identity_provider": "amd",
            "azuread": {
                "client_id": "",
                "client_secret": "",
                "tenant": "",
                "admin_group": "",
                "npi_claim": "sub"
            },
            "agnes": {
                "whitelabel": "",
                "webPageTimeout": 15,
                "maxUsers": 2,
                "leftWindow": "medicalvideo",
                "rightWindow": null,
                "iframes": [],
                "modules": {
                    "chat": {
                        "enabled": true
                    },
                    "notes": {
                        "enabled": true,
                        "templates": []
                    },
                    "sessiondocs": {
                        "coverLogoHeight": 0,
                        "headerLogoHeight": 0
                    },
                    "vc": {
                        "enabled": true,
                        "force": false,
                        "iceTransportPolicy": "all"
                    },
                    "vitals": {
                        "enabled": true,
                        "temperatureUnits": "fahrenheit",
                        "bloodpressureUnits": "mmhg",
                        "heightUnits": "inches",
                        "weightUnits": "pounds"
                    }
                }
            },
            "identity_provider_org": null,
            "redox": {
                "destination_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "patient": {
                    "id_type": "EHRID"
                }
            }
        },
        "metadata": {
            "emr_provider": "redox",
            "emr_provider_org": null
        }
    },
    {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "parent": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "children": [],
        "name": "I am a sibling organization",
        "slug": "sibling",
        "config": {},
        "metadata": {
            "emr_provider": null,
            "emr_provider_org": null
        }
    },
    {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "parent": null,
        "children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
        "name": "{ORGANIZATION.names.short} Demo",
        "slug": "{ORGANIZATION.names.short}-demo",
        "config": {
            "agnes": {
                "webPageTimeout": 1500,
                "maxUsers": 99,
                "modules": {
                    "notes": {
                        "templates": [
                            {
                                "template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint/Reason for visit:   \n\nVital Signs   \n-SpO2: {{vitals.spo2}}      -Pulse: {{vitals.pulse}}   \n-Blood Pressure: {{vitals.bloodpressure}}   -Temperature: {{vitals.temperature}}   -Height: {{vitals.height}}   -Weight: {{vitals.weight}}   \n-Blood Glucose (mg/dL):    \n\nAdditional Encounter Notes:",
                                "name": "Patient Intake Form"
                            },
                            {
                                "template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
                                "name": "Provider Encounter Notes"
                            }
                        ]
                    },
                    "vitals": {
                        "temperatureUnits": "celsius"
                    }
                },
                "whitelabel": null,
                "iframes": [],
                "rightWindow": "videoconference",
                "leftWindow": "documents"
            },
            "logo": "url",
            "identity_provider": "amd",
            "emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'",
            "identity_provider_org": "''",
            "emr_provider": "redox"
        },
        "metadata": {
            "emr_provider": "redox",
            "emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'"
        }
    }
]

Método: OBTENER

{{baseUrl}}/api/v1/org?page=0

Parámetros de consulta

Parámetro	valor
página	0

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Crear organización

Utilice esta API para crear una nueva organización.

Método: PONER

{{baseUrl}}/api/v1/org

Cuerpo (crudo)

{
    "id": "{{$randomUUID}}",
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "slug": "{{$randomCatchPhraseNoun}}",
    "parent": "{{orgId}}",
    "config": {
        "agnes": {
            "webPageTimeout": 1500,
            "maxUsers": 99,
            "modules": {
                "notes": {
                    "templates": [
                        {
                            "template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint/Reason for visit:   \n\nVital Signs   \n-SpO2: {{vitals.spo2}}      -Pulse: {{vitals.pulse}}   \n-Blood Pressure: {{vitals.bloodpressure}}   -Temperature: {{vitals.temperature}}   -Height: {{vitals.height}}   -Weight: {{vitals.weight}}   \n-Blood Glucose (mg/dL):    \n\nAdditional Encounter Notes:",
                            "name": "Patient Intake Form"
                        },
                        {
                            "template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
                            "name": "Provider Encounter Notes"
                        }
                    ]
                },
                "vitals": {
                    "temperatureUnits": "celsius"
                }
            },
            "whitelabel": null,
            "iframes": [],
            "rightWindow": "videoconference",
            "leftWindow": "documents"
        },
        "logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b",
        "identity_provider": "amd",
        "emr_provider_org": "{{$randomUUID}}",
        "identity_provider_org": "{{$randomUUID}}",
        "emr_provider": "redox"
    },
    "metadata": {
        "emr_provider": "redox",
        "emr_provider_org": "{{$randomUUID}}"
    }
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Obtener organización por ID

Utilice esta API para obtener un objeto que contenga datos para una organización específica.

Método: OBTENER

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

Respuesta: 200

{
    "name": "1080p panel",
    "id": "9038420b-c49c-4b76-b87d-94052ba4c4df",
    "slug": "groupware",
    "config": {
        "logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b"
    }
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: modificar organización por ID

Utilice esta API para modificar los atributos de datos de una organización específica. La solicitud se realiza utilizando el ID de la organización.

Método: PARCHE

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

Cuerpo (crudo)

{
    "id": "{{temporaryOrgId}}",
    "name": "{ORGANIZATION.names.short} Mod",
    "slug": "{ORGANIZATION.names.short}-mod"
}

Respuesta: 403

{
    "type": "ForbiddenError",
    "message": "Forbidden",
    "stack": "ForbiddenError: Forbidden\n    at assert (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/http-assert/index.js:8:9)\n    at patchOrganizations (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/actions/organization/patch.js:24:9)\n    at runMicrotasks (<anonymous>)\n    at processTicksAndRejections (internal/process/task_queues.js:93:5)\n    at async nocacheMiddleware (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koajs-nocache/index.js:29:5)\n    at async bodyParser (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-bodyparser/index.js:95:5)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/index.js:18:13\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:58:5\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/helpers/initialize_app.js:246:5\n    at async errorHandler (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/shared/error_handler.js:23:7)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async serve (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-static/index.js:53:9)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:72:17\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-compress/index.js:43:5\n    at async logger (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-logger/index.js:67:7)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:49:13"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: Eliminar organización por ID

Use esta API para eliminar una organización específica por su ID.

Método: ELIMINAR

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

Respuesta: 204

null

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Punto final: obtener organización por slug

Utilice esta API para obtener un objeto que contenga los atributos de datos de una organización específica. La solicitud se realiza mediante el slug de la organización.

Método: OBTENER

{{baseUrl}}/api/v1/org/slug/{{orgSlug}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Desarrollado por: cartero a rebajas