ES
Español
English
Português
    Asociación de compañías a cliente

    Detalles de la petición

    • URL Base: {host}/ASMSAPI/
    • Uri: api/v9/user/{user_id}/companies
    • Tipo: POST

    • Encabezados requeridos:

      • content-type: application/json
      • X-Authorization: Bearer {token}

    Descripción de la URL

    • {host}: Representa el dominio del ambiente en el que se encuentra la API.
    • ASMSAPI/: Prefijo fijo de la API.
    • Uri: Endpoint específico para la petición.


    ⚐ EJEMPLO URL:

    https://{host}/ASMSAPI/api/v9/user/{user_id}/companies


    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    user_id Número Si Identificador único del cliente.
    companiesId Array[int] Si Lista de IDs de las compañías que se asociarán al cliente (máximo 100 compañías). Si se envían más de 100 compañías, solo se considerarán los primeros 100 IDs del array.

    Cuerpo de la petición

    {
    "companiesId": [
        1,
        3,
        4,
        5
    ]
}

    **Respuesta**

200 OK

    Mensajes de error

    Código Estado HTTP Mensaje de error
    409 Conflict Se produce cuando alguno de los IDs enviados no existe en la base de datos. Sin embargo, las compañías que sí existen serán asociadas correctamente.
    404 Not Found “message”: “CompanyIdInvalid” (el ID de la compañía no existe o se encuentra asociada únicamente como proveedor).
    400 BadRequest “exceptionMessage”: “NoCompaniesProvided” (no se han proporcionado compañías).