PT
Español
English
Português
    Usuários associados a empresas

    Detalhes da petição

    • URL base: {host}/ASMSAPI/
    • URI: api/v9/user/{Id}/usercompanies
    • Tipo: GET
    • 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/{Id}/usercompanies
    


    Parâmetros:

    Nome Tipo de dado Obrigatório Descrição
    Id Int Sim Identificação de usuário

    Corpo da petição: N/A

    Responder

    {
        "totalItems": 2,
        "content": [
            {
                "companytId": 1,
                "companyName": "Empresa AT",
                "projects": [
                    {
                        "projectId": 4,
                        "projectName": "Soporte"
                    }
                ]
            },
            {
                "companytId": 6,
                "companyName": "Empresa4",
                "projects": [
                    {
                        "projectId": 4,
                        "projectName": "Soporte"
                    }
                ]
            }
        ]
    }
    

    Nota: A solicitação retorna a empresa associada ao usuário consultado e o projeto ao qual pertence.

    Parâmetros

    Nome Tipo de dado Descrição
    ID da empresa Int Identificador da empresa
    nomeDaempresa Corda Nome da empresa
    Projetos Lista Lista de projetos relacionados à empresa
    projectos.projectId Int ID do projeto relacionado à empresa
    nome_dos_projetos.projeto Corda Nome do projeto relacionado à empresa

    Exceções:

    Sair Descrição
    exceptionMessage: “InvalidClientUser”,
    message: “FailureGetUserCompanies”,
    operation: “GetUserCompanies”,
    serviceName: “Usuário”
    O usuário consultado não existe ou não está definido como um cliente