PT
Español
English
Português
    Parceria de empresas com clientes

    Detalhes da petição

    • URL base: {host}/ASMSAPI/
    • Uri: api/v9/user/{user_id}/companies
    • 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/user/{user_id}/companies


    Parâmetros

    Nome Tipo de dado Obrigatório Descrição
    user_id Número Sim Identificador exclusivo do cliente.
    identificação das empresas Array[int] Sim Lista de IDs das empresas que serão associadas ao cliente (máximo de 100 empresas). Se mais de 100 empresas forem enviadas, apenas as primeiras 100 IDs na matriz serão consideradas.

    Corpo da petição

    {
    "companiesId": [
        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, as empresas que existirem serão devidamente associadas.
    404 Não encontrado “message”: “CompanyIdInvalid” (o ID da empresa não existe ou está associado apenas como um provedor).
    400 Solicitação BadRequest “exceptionMessage”: “NoCompaniesProvided”.