Curso e ofertas

O sistema entende que um curso pode ser ofertado em diversos momentos e com variações. Para isso é preciso primeiro cadastrar o curso para depois cadastrar suas ofertas.

Cadastro de curso

POSTapplication/json /api/Curso/cadastroCurso

Atributos	Tipo	Obrigatoriedade	Descrição
codigo	string	Não	Código de identificação externa.
nome	string	Sim	Nome do curso. Limite de caracteres: 255.
descricao	string	Não	Descrição do curso. Limite de caracteres: 500.
camposPersonalizados	object	Não	Usado para atribuir algum campo específico que não está presente no escopo da API. Os campos devem ser informados como no exemplo abaixo: "camposPersonalizados" : { coluna: "valor" } Os nomes das colunas dos campos personalizados são informados no método cadastro de campo personalizado, o valor poderá ser uma string normal ou um array de strings caso o campo seja multi valorado.
origem	integer	Sim	Código de identificação do canal.
token	string	Sim	Chave de acesso única referente ao canal.

Exemplos

Resposta

JSON:

{
    "success":true,
    "id":"1"
}

Cadastro de oferta de curso

Após realizar o cadastro do curso, você pode cadastrar suas ofertas. É a oferta de curso que fica vinculada a um registro de processo.

POSTapplication/json /api/Curso/cadastroOferta

Atributos	Tipo	Obrigatoriedade	Descrição
codOferta	string	Não	Código de identificação externa.
nome	string	Sim	Nome do curso. Limite de caracteres: 255.
complemento	string	Não	Limite de caracteres: 255. Este campo é para diferenciar de forma rápida as ofertas do mesmo curso. Por exemplo: “Como falar em público – Intensivo” ou “Como falar em público – Final de Semana”. Seja qual for o complemento que queira usar, lembre que a equipe comercial vai ver ele quando tiver duas ofertas com o mesmo nome do curso.
valor	float	Não	Valor referente ao que a registro de processo gerado a partir deste curso representa (valor do contrato).
vagasMinimas	integer	Não	Mínimo de vagas que deverão ser preenchidas do curso. Esses dados podem ser utilizados nos fluxos de automação para configurar comportamentos automatizados a partir do preenchimento das vagas.
vagasMaximas	integer	Não	Máximo de vagas que poderão ser preenchidas do curso. Esses dados podem ser utilizados nos fluxos de automação para configurar comportamentos automatizados a partir do preenchimento das vagas.
inicioInscricao	date	Não	Data de início das inscrições. Padrão: YYYY-MM-DD
terminoInscricao	date	Não	Data de término das inscrições. Padrão: YYYY-MM-DD
inicioMatricula	date	Não	Data de início das matrículas. Padrão: YYYY-MM-DD
terminoMatricula	date	Não	Data de término das matrículas. Padrão: YYYY-MM-DD
inicioCurso	date	Não	Data de início do curso. Padrão: YYYY-MM-DD
terminoCurso	date	Não	Data de término do curso. Padrão: YYYY-MM-DD
modalidade	integer	Sim	Identificação da modalidade, que pode ser obtido através do método abaixo no CRM Rubeus. Consulta modalidades
codModalidade	string	Sim	Código único de identificação da modalidade, que pode ser obtido através do método abaixo no CRM Rubeus. Consulta modalidades
codCurso	string	Sim	O curso pai pode ser adicionado no momento do cadastro da oferta caso ele já não tenha sido cadastrado pelo método cadastro curso. Para cadastrar ele basta informar também os campos nomeCurso e descricaoCurso. Caso já tenha cadastrado o curso pai, basta informar o codCurso com o código definido no cadastro. É obrigatório estar vinculado a um curso pai.
nomeCurso	string	Não	Nome do curso pai. Deve ser informado caso queira adicionar o curso pai junto com o cadastro da oferta. Caso já tenha cadastrado o curso pai basta informar o codCurso.
descricaoCurso	string	Não	Descrição do curso pai. Deve ser informado caso queira adicionar o curso pai junto com o cadastro da oferta. Caso já tenha cadastrado o curso pai basta informar o codCurso.
codUnidade	string	Sim	Código único para identificação da unidade que está ofertando o curso atual. Listar Unidades Enviar o campo codigo
codLocalOferta	array[]	Sim	Array com os códigos externos de identificação do local de oferta cadastrado. Veja abaixo um exemplo do formato para envio. "codLocalOferta": ["codigo do local de oferta"]
codNivelEnsino	integer	Condicional	Código único de identificação do nível de ensino. Listar niveis de ensino Enviar o campo codigo Caso não seja enviado deverá ser o utilizado o campo nivelEnsino.
nivelEnsino	integer	Condicional	Identificação do nível de ensino. Listar niveis de ensino Enviar o campo id Caso não seja enviado deverá ser o utilizado o campo codNivelEnsino.
codProcessoSeletivo	string	Não	Código único de identificação do processo seletivo. Para visualizar os códigos dos processos seletivos utilize a aplicação.
origem	integer	Sim	Código de identificação do canal.
token	string	Sim	Chave de acesso única referente ao canal.

Exemplos

Resposta

JSON:

{
    "success":true,
    "id":"1"
}

Listar cursos

GETapplication/json /api/Curso/listarCursos

Atributos	Tipo	Obrigatoriedade	Descrição
id	integer	Não	Caso o id do curso seja informado será retornado apenas o curso desejado.
codCurso	string	Não	Caso o código do curso seja informado será retornado apenas o curso desejado.
origem	integer	Sim	Código de identificação do canal.
token	string	Sim	Chave de acesso única referente ao canal.

Exemplos

Resposta

JSON:

{
    "success": true,
    "dados": [
        {
            "id": "1",
            "nome": "Nome do curso",
            "descricao": null,
            "codigo": "000",
            "origem": "1",
            "origemNome": "CRM"
        }
    ]
}

Listar ofertas

GETapplication/json /api/Curso/listarOfertas

Atributos	Tipo	Obrigatoriedade	Descrição
id	integer	Não	Caso o id da oferta de curso seja informada será retornada apenas a oferta de curso desejado.
codOferta	string	Não	Caso o codOferta seja informado juntamente com o codCurso será retornado apenas a oferta desejada.
codCurso	string	Não	Caso o codCurso seja informado juntamente com a codOferta será retornado apenas a oferta desejada.
origem	integer	Sim	Código de identificação do canal.
token	string	Sim	Chave de acesso única referente ao canal.

Exemplos

Resposta

JSON:

{
    "success": true,
    "dados": [
        {
            "id": "1",
            "nome": "Nome da oferta de curso",
            "complemento": null,
            "codigo": "000",
            "codCurso": "000",
            "inicioInscricao": null,
            "terminoInscricao": null,
            "inicioMatricula": null,
            "terminoMatricula": null,
            "inicioCurso": null,
            "terminoCurso": null,
            "unidade": "1",
            "unidadeNome": "Unidade",
            "nivelEnsino": "1",
            "nivelEnsinoNome": "Graduação",
            "modalidade": "1",
            "modalidadeNome": "Presencial",
            "origem": "1",
            "origemNome": "CRM",
            "processoSeletivo": "1",
            "codProcessoSeletivo": "1-1",
            "processoSeletivoNome": "Nome do processo seletivo"
        }
    ]
}

Dados da oferta de curso

GETapplication/json /api/Curso/dadosOferta

Atributos	Tipo	Obrigatoriedade	Descrição
codOferta	string	Sim	Código de identificação externa da oferta de curso
origemOferta	integer	Não	Identificação da origem da oferta de curso, caso a origem da oferta de curso seja diferente do campo origem, este campo torna-se importante para o resultado correto.
origem	integer	Sim	Código de identificação do canal.
token	string	Sim	Chave de acesso única referente ao canal.

Exemplos

Resposta

JSON:

{
    "success": true,
    "dados": {
        "id": "1",
        "nome": "CURSO DE MEDICINA - IPATINGA",
        "complemento": null,
        "vagasMinimas": "1",
        "vagasMaximas": "40",
        "valor": "0",
        "codigo": "ADM_3",
        "inicioInscricao": null,
        "terminoInscricao": null,
        "inicioMatricula": "2018-01-01",
        "terminoMatricula": "2018-01-31",
        "inicioCurso": null,
        "terminoCurso": null,
        "curso": "1",
        "unidade": "1",
        "nivelEnsino": "1",
        "modalidade": "1",
        "processoSeletivo": "1",
        "codProcessoSeletivo": "1-1",
        "origem": "1",
        "localOferta": [
            "1"
        ]
    }
}

Listar modalidades

GETapplication/json /api/Curso/listarModalidades

Atributos	Tipo	Obrigatoriedade	Descrição
origem	integer	Sim	Código de identificação do canal.
token	string	Sim	Chave de acesso única referente ao canal.

Exemplos

Resposta

JSON:

{
    "success": true,
    "dados": [
        {
            "id": "1",
            "titulo": "Presencial"
        }
    ]
}