Histórico da Página

createColleagueReplacement

Cria um substituto.

Método:

createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• crDto: cadastro do substituto.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

deleteColleagueReplacement

Exclui o cadastro de um substituto.

Método:

deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário origem.
• replacementId: matrícula do usuário substituto.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getColleagueReplacement

Retorna um substituto de um usuário.

Método:

getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário origem.
• replacementId: matrícula do usuário substituto.

Retorno: ColleagueReplacementDto.

 getReplacementsOfUser

Retorna todos os substitutos de um usuário.

Método:

getReplacementsOfUser(String username, String password, int companyId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário origem.

Retorno: ColleagueReplacementDto[].

getValidReplacedUsers

Retorna todos os usuário substituídos por um substituto válido.

Método:

getValidReplacedUsers(String username, String password, int companyId, String replacementId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa;
• replacementId: matrícula do usuário substituto.

Retorno: ColleagueReplacementDto[].

getValidReplacement

Retorna um substituto válido de um usuário.

Método:

getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário origem.
• replacementId: matrícula do usuário substituto.

Retorno: ColleagueReplacementDto.

getValidReplacementsOfUser

Retorna todos os substitutos válidos de um usuário.

Método:

getValidReplacementsOfUser(String username, String password, int companyId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa;
• colleagueId: matrícula do usuário origem.

Retorno: ColleagueReplacementDto[].

updateColleagueReplacement

Altera o cadastro de um substituto.

Método:

updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• crDto: cadastro do usuário.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createColleague

Cria um usuário.

Método:

createColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagues: usuários.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createColleaguewithDependencies

Cria um usuário com grupos e papéis.

Método:

createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagues: usuários.
• grupos: grupos.
• papeis: papéis.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getColleague

Retorna um usuário.

Método:

getColleague(String username, String password, int companyId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: ColleagueDto[].

Atributos de Retorno:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getColleagueByLogin 

Retorna o usuário a partir do login.

Método:

getColleagueByLogin(String username, String password)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.

Retorno: ColleagueDto.

Atributos de Retorno:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getColleagues

Retorna todos os usuários ativos.

Método:

getColleagues(String username, String password, int companyId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.

Retorno: ColleagueDto[].

Atributos de Retorno:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getColleaguesMail

Retorna um usuário utilizando um e-mail.

Método:

getColleaguesMail(String username, String password, int companyId, String mail)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• mail: e-mail do usuário.

Retorno: ColleagueDto[].

Atributos de Retorno:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

• volumeId

getColleagueWithMap

Retorna uma mensagem informando se o usuário foi criado corretamente.

Método:

getColleagueWithMap(String colleagueXML, String username, String password)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• colleagueXML: lista normalizada de documentos.

Retorno: String.

getGroups

Retorna os grupos que o usuário participa.

Método:

getGroups(String username, String password, int companyId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: GroupDto[].

Atributos de Retorno:

• companyId 

• groupDescription

• groupId

getSimpleColleague

Retorna o usuário.

Método:

getSimpleColleague(String username, String password)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.

Retorno: ColleagueDto.

Atributos de Retorno:

• active 

• adminUser 

• maxPrivateSize

• colleagueName 

• companyId 

• defaultLanguage 

• dialectID 

• emailHtml 

• gedUser 

• login

• mail

• colleagueId 

• menuConfig

• newsPublisher

• rowId

• usedSpace

getSummaryColleagues

Retorna todos os usuários ativos.

Método:

getSummaryColleagues(int companyId)

Parâmetros:

• companyId: código da empresa.

Retorno: ColleagueDto[].

Atributos de Retorno:

• active 

• colleagueId

• colleagueName

• companyId

• maxPrivateSize

• rowId

• usedSpace

removeColleague

Desativa um usuário.

Método:

removeColleague(String username, String password, int companyId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

Ativa um usuário.

Método:

activateColleague(String username, String password, int companyId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateColleague

Altera um usuário.

Método:

updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagues: usuários.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateColleaguewithDependencies

Altera um usuário com grupos e papéis.

Método:

updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagues: usuários.
• grupos: grupos.
• papeis: papéis.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

validateColleagueLogin

Valida o acesso de um usuário no produto.

Método:

validateColleagueLogin(int companyId, String colleagueId, String password)

Parâmetros:

• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• password: senha do usuário.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro