PT
Español
English
Português
    Associação de usuário para empresa

    Detalhes da petição

    • URL base: {host}/ASMSAPI/
    • Uri: api/v9/company/{company_id}/associateusers
    • Tipo: POST
    • Títulos obrigatórios:

    • tipo de conteúdo: application/json
    • Autorização X: Portador {token}

    Descrição do URL

    • {host}: Ele representa o domínio do ambiente no qual a API está localizada.
    • ASMSAPI/: Prefixo de API fixo.
    • URI: Ponto de extremidade específico para a solicitação.


    URL DE EXEMPLO:

    https://{host}/ASMSAPI/api/v9/company/{company_id}/associateusers
    


    Parâmetros

    Nome Tipo de dado Obrigatório Descrição
    company_id Número Sim Identificador único da empresa.
    ID do usuário Array[int] Sim Lista de IDs dos usuários que serão associados à empresa (máximo de 100 usuários). Se mais de 100 usuários forem enviados, somente as primeiras 100 IDs na matriz serão consideradas.

    Corpo da petição

    {
        "usersId": [
            1,
            3,
            4,
            5
        ]
    }
    
    **Respuesta**
    
    200 OK
    
    

    Mensagens de erro

    Código Status HTTP Mensagem de erro
    409 Conflito Ocorre quando qualquer uma das IDs enviadas não existe no banco de dados. No entanto, os usuários que existirem serão devidamente associados.
    404 Não encontrado “message”: “CompanyIdNotExist” (o ID da empresa não existe).
    400 Solicitação BadRequest “exceptionMessage”: “NoUsersProvided”.