Detalhes da petição
- URL Base: {host}/ASMSAPI/
- URI: /api/v9/user/searchAll?projectId={projectId}&serviceId={serviceId}&companyId={companyId}&itemType={itemType}&criteria={criteria}
- Cara: OBTER
-
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.
⚐ EJEMPLO URL:
https://{host}/ASMSAPI/api/v9/user/searchAll?projectId={projectId}&serviceId={serviceId}&companyId={companyId}&itemType={itemType}&criteria={criteria}
Parâmetros
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
tipo de item | Enumerador | Sim | Tipo de pesquisa: • Cliente = 37 • Especialista = 53 |
ID do projeto | Número | Não | ID do projeto |
ID do serviço | Número | Não | Identificador de serviço |
ID da empresa | Número | Não | Identificador da empresa |
Critérios | Texto | Não | Texto de pesquisa do usuário |
Corpo da petição
N/A
Exemplos de URIs
- /api/v9/user/searchAll?itemType=specialist&projectId=2&criteria=abdy
- /api/v9/user/searchAll?itemType=specialist&projectId=2&criteria=
- /api/v9/user/searchAll?itemType=specialist&projectId=2
Responder
{
"content": [
{
"email": "tri@pri.comx",
"id": 150,
"name": "Abdy Sanjur",
"userName": "ASANJUR"
}
],
"totalItems": 1
}
Parâmetros de resposta
Nome | Tipo de dado | Descrição |
---|---|---|
totalItems | Número | Número total de objetos encontrados |
conteúdo | Lista | Lista de itens |
Texto | E-mail do usuário | |
Id | Número | Identificação de usuário |
Nome | Texto | Nome de usuário |
nome do usuário | Texto | Aliases de usuário |
Mensagens de erro
Código | Status HTTP | Mensagem de erro |
---|---|---|
500 | Erro de servidor interno | Usuários de pesquisa de falhas |
400 | Solicitação BadRequest | InvalidTypeForSearch |