Histórico de Revisões

A Plataforma de integração consiste numa solução que visa integrar aplicações para acesso à informações no ambiente da CCEE– Câmara de Comercialização de Energia Elétrica. Por meio dele, qualquer sistema, escrito em qualquer linguagem, pode conectar-se para consulta ou inserção de dados.

A CCEE estabeleceu por meio dessa plataforma um padrão de interconexão entre sistemas heterogêneos, que usa a web e a XML como linguagem para troca de informações (dados e metadados). Esse serviço destina-se num canal oferecido para interação entre os sistemas dos Agentes e a CCEE.

Módulo de Contratos (Consulta de Contratos)

Este serviço possibilitará a consulta de contratos através de uma chamada Web Service. Consideramos um tipo de operações:

• Listar contratos – Este método será responsável por retornar uma lista de contratos para informações específicas.

A operação estará disponível através da mesma operação (Soap Action), cabendo a determinados elementos dentro da mensagem de entrada definir qual consulta está sendo feita.

2. Localização

A tabela abaixo lista os ambientes e as correspondentes URLs da Web Service:

Ambiente

WSDL URL

Endpoint URL

Piloto

xxxxx://xxxxxx- xxxxxxxx.xxxx.xxx.xx:442/ws/v2/ContratoBSv2?

wsdl

xxxxx://xxxxxx- xxxxxxxx.xxxx.xxx.xx:443/ws/v2/ContratoBSv2

Produção

xxxxx://xxxxxxxx.xxxx.xxx.xx:000/xx/x0/Xxxxxxx oBSv2?wsdl

xxxxx://xxxxxxxx.xxxx.xxx.xx:000/xx/x0/Xxxxxxx oBSv2

A consulta do documento WSDL pode ser feita via navegador Web, ou através de softwares e bibliotecas especializadas em Web Service.

3. Limite de requisições

Esse serviço possui uma limitação de seiscentas (600) requisições a cada sessenta (60) segundos.

4. Estrutura geral dos elementos

As seções a seguir descrevem cada parâmetro de entrada e saída, com seus respectivos tipos de dados e descrição.

As operações contendo os campos do tipo “Enumeration” são consideradas case sensitive, e em alguns casos com valores restritos. Os valores deverão ser exatamente iguais aos valores definidos no documento WSDL e seus arquivos XSD importados.

4.1. messageHeader

Tanto a mensagem de entrada (request) quanto a mensagem de resposta (response) deverão conter a seção messageHeader como parte do Header, sendo constituída dos seguintes elementos:

Nome	Descrição	Tipo	Condição	Caminho (XPath) *
Código do Perfil	Código do perfil agente utilizados nos sistemas da CCEE	Alfabético	Obrigatório	/ soapenv :Envelope/ soapenv :Header/hdr:messageHeader/h dr:codigoPerfilAgente
Transaction Id	Contém o identificador da mensagem. Será preenchido pela CCEE e incluído na mensagem de resposta	Alfabético	Opcional	/ soapenv :Envelope/ soapenv :Header/hdr:messageHeader/h dr:transactionId
Lista de códigos de perfil	Para uso interno da CCEE. Não precisa ser enviado no request e não será enviado na resposta	Estrutura	Uso interno	N/A
Versão	Versão do serviço utilizado	Alfabético	Obrigatório	/soapenv:Envelope/soapenv:He ader/hdr:messageHeader/hdr:v ersao

4.2. Security

A mensagem de entrada deverá conter, dentro do Header, a estrutura Security listada abaixo, que deverá conter o usuário e senha utilizados para autenticação. Esta estrutura é uma especialização do UsernameToken da especificação WS-Security, contendo apenas os seguintes elementos:

Nome

Descrição

Tipo

Condição

Caminho (XPath) *

Usuário

Usuário sistêmico que deseja se

autenticar

Alfabético

Obrigatório

/soapenv:Envelope/soapenv:Hea der/oas:Security/sec:UsernameT

oken/sec:Username

Senha

Senha do usuário

Alfabético

Obrigatório

/soapenv:Envelope/soapenv:Hea der/oas:Security/sec:UsernameT

oken/sec:Password

*Namespaces declarados:

• soapenv="xxxx://xxxxxxx.xxxxxxx.xxx/xxxx/xxxxxxxx/"

• sec="xxxx://xxxx.xxxxx-xxxx.xxx/xxx/0000/00/xxxxx-000000-xxx-xxxxxxxxxx-xxxxxx-0.0.xxx"

4.3. Paginação

Nome

Descrição

Tipo

Condição

Caminho (XPath) *

Número da página

Número da página que deseja obter o

resultado

Numérico

Obrigatório

/soapenv:Envelope/soapenv:Hea der/hdr:paginacao/hdr:numero

Quantidade de Itens

Quantidade de itens retornados por página

Numérico

Obrigatório

/soapenv:Envelope/soapenv:Hea der/hdr:paginacao/hdr:quantidad eItens

4.4. Parâmetros de entrada

Os seguintes elementos fazem parte da mensagem de entrada da operação listarContrato:

Nome	Descrição	Tipo	Valores	Condição
Perfis de agente	Lista de perfis de agentes	Estrutura		Obrigatório
Papel	Identifica se os códigos dos perfis de agente utilizado pertencem a compradores ou vendedores	Alfabético	COMPRADOR VENDEDOR	Opcional
Situações do contrato	Lista de Situações do Contrato	Estrutura		Opcional
Tipo do contrato	Tipo do Contrato	Estrutura		Opcional
Período de referência	Período de referência para a busca	Estrutura		Obrigatório
Indicador – listar montantes não validados	ATENÇÃO: TRUE retorna APENAS os contratos com o montante não validado. FALSE, retorna todos os contratos de acordo com os demais filtros.	boolean	true false	Opcional
Ambiente de contratação	Define o tipo de ambiente de contratação do mercado de energia ao qual o contrato foi submetido. Caso este valor não seja informado, será considerado o valor ‘LIVRE’	Alfabético	LIVRE REGULADO	Obrigatório
Código do contrato físico	O código ACR é a chave do contrato papel, utilizado nos processos do SGP e da Certisign quando da assinatura dos contratos. O código ACR pode estar relacionado a N códigos de contrato Cliq. Será permitido informar um código ACR para localizar contratos regulados.	Númerico	123	Opcional

4.4.1. perfil

Nome	Descrição	Tipo	Valores	Condição
id	Identifica o código do perfil do agente utilizado nos sistemas da CCEE	Numérico	1234	Opcional

4.4.2. situação

Nome

Descrição

Tipo

Valores

Condição

Identifica o código da situação do contrato

Numérico

10211 – RASCUNHO

10212 - REGISTRADO NAO VALIDADO

10213 - VALIDADO

10214 - ADITIVO NAO VALIDADO

11203 - RESCINDIDO

15829 - RESCINDIDO NAO VALIDADO

11204 - SUSPENSO

Opcional

4.4.3. tipo

Nome

Descrição

Tipo

Valores

Condição

Identificador dos tipos de contrato existentes no ambiente sistêmico da CCEE.

Numérico

10185 –

CCEAL

00000 - XXX

Opcional

subtipo

Subtipo do Contrato

Estrutura

Opcional

4.4.4. subtipo

Nome

Descrição

Tipo

Valores

Condição

Identificador dos subtipos de contrato existentes no ambiente sistêmico da CCEE.

Numérico

Sub tipos validados para CCEAL:

10806 (Flexível Por Percentual de Geração)

10777 (Firme)

10778 (Flexível Por Percentual de Consumo)

10779 (Flexível Por Prioridade) 16233 (MVE)

Opcional

1.2

Versão

0405/2020

Data Publicação

7 de 26 Páginas

Sub tipos validados para CBR:

11245 (Chamada Publica)

00000 (Xxxxxxxxxxxxxxxxx)

11247 (Mercado Próprio) 11248 (Xxxxxxxx e Supridoras) 11249 (Ant.Lei nº 10.848/2004)

11250 (Sistema Isolado)

11392 (Outros CBR) 15999 (Art. 5º Lei nº 13.182/2015)

16000 (Art. 10º Lei nº

13.182/2015)

4.4.5. periodoReferencia

Nome

Descrição

Tipo

Valores

Condição

inicio

Início do período a ser consultado. Não considera

horário de verão

DateTime

2019-10-

31T00:00:00

Obrigatório

fim

Fim do período a ser consultado. Não considera horário de verão

DateTime

2019-10-

31T00:00:00

Obrigatório

4.5. Parâmetros de saída

Os seguintes elementos fazem parte da mensagem de resposta da operação listarContrato:

Nome

Descrição

Tipo

Valores

Condição

contrato

Lista com os contratos encontradas durante a consulta.

Lista

Min: 0

Max: Unbounded

Opcional

4.5.1. contrato

Nome	Descrição	Tipo	Valores	Condição
id	Identificador único que corresponde a um número sequencial de um determinado contrato	Numérico	Exemplo: 12465	Opcional
codigoReferencia	Identifica o código do contrato proveniente do sistema externo proprietário do Agente	Alfabético	Exemplo: 1150	Opcional
codigoOrigem	Identifica o código do contrato no qual esse foi originado	Numérico	Exemplo: 9999	Opcional
codigoContratoFis ico	O código ACR é a chave do contrato papel, utilizado nos processos do SGP e da Certisign quando da assinatura dos	Númerico	123	Opcional

1.2

Versão

0405/2020

Data Publicação

8 de 26 Páginas

	contratos. O código ACR pode estar relacionado a N códigos de contrato Cliq
tipo	Identificador dos tipos de contrato existentes no ambiente sistêmico da CCEE.	Estrutura		Opcional
fonteEnergia	Identifica a fonte de energia	Estrutura		Opcional
vigencia	Vigências do contrato	Estrutura		Opcional
solicitarCancelam ento	Identifica se foi solicitado o cancelamento do contrato	Boolean	True False	Opcional
cancelado	Identifica se o contrato foi cancelado com sucesso	Boolean	True False	Opcional
indicadores	Lista de indicadores relacionado ao contrato	Lista	Min: 0 Max: Unbounded	Opcional

4.5.2. fonteEnergia

Nome

Descrição

Tipo

Valores

Condição

tipo

Identifica o tipo de Fonte de Energia para o

Contrato.

Estrutura

Opcional

4.5.3. tipoFonteEnergia

Nome	Descrição	Tipo	Valores	Condição
id	Identificador do tipo de Fonte de Energia	Numérico		Opcional
nome	Nome do tipo de Fonte de Energia	Alfabético		Opcional

4.5.4. tipo

Nome

Descrição

Tipo

Valores

Condição

Identificador dos tipos de contrato existentes no ambiente sistêmico da CCEE.

Numérico

11177 - CER

00000 - XXXXX

10186 - CCEAR_Q

10187 - CCEAR_D

10188 - LEILAO_DE_AJUSTE 10189 - PROINFA

10190 - ITAIPU

10671 - CCGF

10672 - CCEN

Opcional

1.2

Versão

0405/2020

Data Publicação

9 de 26 Páginas

			15900 - CCEAR_C 00000 - XXX
nome	Descrição dos tipos de contrato existentes	Alfabético	11177 - CER	Opcional
	no ambiente sistêmico da CCEE.		10185 - CCEAL
			10186 - CCEAR_Q
			10187 - CCEAR_D
			10188 -
			LEILAO_DE_AJUSTE
			10189 - PROINFA
			10190 - ITAIPU
			10671 - CCGF
			00000 - XXXX
			15900 - CCEAR_C
			00000 - XXX
subtipo	Subtipo do Contrato	Estrutura		Opcional

1.2

Versão

0405/2020

Data Publicação

10 de 26 Páginas

4.5.5. subtipo

Nome	Descrição	Tipo	Valores	Condição
id	Identificador dos subtipos de	Numérico	Sub tipos validados para	Opcional
	contrato existentes no		CCEAL:
	ambiente sistêmico da CCEE.		10806 (Flexível Por
			Percentual de Geração)
			10777 (Firme)
			10778 (Flexível Por
			Percentual de Consumo)
			10779 (Flexível Por
			Prioridade)
			16233 (MVE)
			Sub tipos validados para CBR:
			11245 (Chamada Publica)
			00000 (Xxxxxxxxxxxxxxxxx)
			11247 (Mercado Próprio)
			11248 (Supridas e Supridoras)
			11249 (Ant.Lei nº
			10.848/2004)
			11250 (Sistema Isolado)
			11392 (Outros CBR)
			15999 (Art. 5º Lei nº
			13.182/2015)
			16000 (Art. 10º Lei nº
			13.182/2015)
nome	Descrição dos subtipos de contrato existentes no ambiente sistêmico da CCEE.	Alfabético		Opcional

4.5.6. participanteMercado

Nome	Descrição	Tipo	Valores	Condição
tipo	Descrição do papel do agente na negociação	Alfabético	COMPRADOR VENDEDOR	Opcional
perfil	Código do perfil do agente participante na negociação	Numérico	123	Opcional

4.5.7. situação

Nome

Descrição

Tipo

Valores

Condição

Identifica o código da situação do contrato

Numérico

10211 – RASCUNHO

10212 - REGISTRADO NAO VALIDADO

10213 - VALIDADO

Opcional

1.2

Versão

0405/2020

Data Publicação

11 de 26 Páginas

10214 - ADITIVO NAO VALIDADO

11203 - RESCINDIDO

15829 - RESCINDIDO NAO VALIDADO

11204 - SUSPENSO

nome

Identifica a descrição da situação do contrato

Alfabético

Opcional

4.5.8. periodoSuprimento

Nome

Descrição

Tipo

Valores

Condição

inicio

Início do período a ser consultado. Não considera

horário de verão

DateTime

2019-10-

31T00:00:00

Obrigatório

fim

Fim do período a ser consultado. Não considera horário de verão

DateTime

2019-10-

31T00:00:00

Obrigatório

4.5.9. submercadoEntrega

Nome	Descrição	Tipo	Valores	Condição
id	Identificador do submercado de entrega	Numérico		Opcional
nome	Nome do submercado de entrega	Alfabético		Opcional

4.5.10. submercadoOrigem

Nome	Descrição	Tipo	Valores	Condição
id	Identificador do submercado de origem	Numérico		Opcional
nome	Nome do submercado de origem	Alfabético		Opcional

4.5.11. indicador

Nome	Descrição	Tipo	Valores	Condição
descricao	Descrição do indicador	Alfabético		Opcional
valor	Valor do indicador	Alfabético		Opcional

1.2

Versão

0405/2020

Data Publicação

12 de 26 Páginas

4.5.12. vigência

Nome	Descrição	Tipo	Valores	Condição
observacao	Observações referente a vigência do contrato	Alfanumérico	Texto	Opcional
submercadoEntrega	Identifica o Submercado de Entrega da energia.	Estrutura		Opcional
submercadoOrigem	Identifica o Submercado de Origem da energia.	Estrutura		Opcional
situacao	Identifica a situação da vigência do Contrato	Estrutura		Opcional
periodoSuprimento	Período de Suprimento da Vigência do Contrato	Estrutura		Opcional
participantesMercad o	Identica os participantes da negociação (Comprador e Vendedor)	Estrutura		Opcional
finalizado	Identifica se o contrato foi finalizado	Boolean	True False	Opcional
dataFinalizacao	Identifica a data da finalização do contrato, caso o contrato tenha sido finalizado	DateTime	2019-10- 31T00:00 :00	Opcional

5. Operações disponíveis

O serviço ContratoBSv2 possuirá duas operações, sendo elas listarContrato e obterContratos.

A seção “Estrutura dos Elementos” irá descrever os tipos de valores para cada elemento. Aqui apenas

quais elementos devem ser enviados para cada tipo de consulta serão listados.

IMPORTANTE:

• Em todas as consultas o valor do codigoPerfilAgente e da versão (no messageHeader) deverá ser enviado.

5.1. Listar Contratos livres

Este método será responsável por retornar uma lista de contratos.

5.1.1. Parâmetros de entrada

Os parâmetros abaixo devem ser enviados para a consulta de contratos:

Nome	Descrição	Tipo	Valores	Condição
codigoPerfilAgente	Código do perfil agente utilizados nos sistemas da CCEE	Alfanumérico		Obrigatório
Username	Usuário fornecido para utilização da plataforma	Alfanumérico		Obrigatório
Password	Senha fornecida para utilização da plataforma	Alfanumérico		Obrigatório
versao	Versão do serviço a ser utilizado		2.1	Obrigatório
numero	Número da página que deseja obter o resultado	Numérico		Obrigatório
quantidadeItens	Quantidade de itens retornados por página	Numérico		Obrigatório
Perfis de agente	Lista de perfis de agentes	Estrutura		Obrigatório
papel	Identifica se os códigos dos perfis de agente utilizado pertencem a compradores ou vendedores	Alfabético	COMPRAD OR VENDEDO R	Opcional
Situações do Contrato	Lista de Situações do Contrato	Estrutura		Opcional
Tipo do Contrato	Tipo do Contrato	Estrutura		Opcional
periodoReferencia	Período de referência para a busca	Estrutura		Obrigatório
listarMontantesNaoValidados	Indica se deseja retornar contratos com o montante não validado	boolean	true false	Opcional
Ambiente de contratação	Define o tipo de ambiente de contratação do mercado de energia ao qual o contrato foi submetido. Caso este valor não seja informado, será considerado o valor ‘LIVRE’	Alfabético	LIVRE	Opcional

5.1.2. Parâmetros de saída

Os parâmetros abaixo serão retornados na consulta de contratos:

Nome	Descrição	Tipo	Valores	Condição
id	Identificador único que corresponde a um número sequencial de um determinado contrato	Numérico	Exemplo: 12465	Opcional
codigoReferencia	Identifica o código do contrato proveniente do sistema externo proprietário do Agente	Alfabético	Exemplo: 1150	Opcional
codigoOrigem	Identifica o código do contrato no qual esse foi originado	Numérico	Exemplo: 9999	Opcional
tipo	Identificador dos tipos de contrato existentes no ambiente sistêmico da CCEE.	Estrutura		Opcional
fonteEnergia	Identifica a fonte de energia	Estrutura		Opcional
vigencia	Vigências do contrato	Estrutura		Opcional
solicitarCancelam ento	Identifica se foi solicitado o cancelamento do contrato	Boolean	True False	Opcional
cancelado	Identifica se o contrato foi cancelado com sucesso	Boolean	True False	Opcional
indicadores	Lista de indicadores relacionado ao contrato	Lista	Min: 0 Max: Unbounded	Opcional

5.1.3. Exemplo de XML de entrada

<soapenv:Envelope xmlns:soapenv="xxxx://xxxxxxx.xxxxxxx.xxx/xxxx/xxxxxxxx/" xmlns:v2="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0" xmlns:oas="xxxx://xxxx.xxxxx- xxxx.xxx/xxx/0000/00/xxxxx-000000-xxx-xxxxxxxxxx-xxxxxx-0.0.xxx" xmlns:v21="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0" xmlns:v22="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0">

<soapenv:Header>

<v2:messageHeader>

<v2:codigoPerfilAgente>99</v2:codigoPerfilAgente>

<v2:versao>2.1</v2:versao>

</v2:messageHeader>

<oas:Security>

<oas:UsernameToken>

<oas:Username>USUARIO</oas:Username>

<oas:Password>SENHA</oas:Password>

</oas:UsernameToken>

</oas:Security>

<v2:paginacao>

<v2:numero>1</v2:numero>

<v2:quantidadeItens>100</v2:quantidadeItens>

</v2:paginacao>

</soapenv:Header>

<soapenv:Body>

<v21:listarContratoRequest>

<v21:listarMontantesNaoValidados>true</v21:listarMontantesNaoValidados>

<v21:periodoReferencia>

<v22:inicio>2018-06-01T00:00:00</v22:inicio>

<v22:fim>2018-07-01T00:00:00</v22:fim>

</v21:periodoReferencia>

<v21:situacoes>

<v22:situacao>

<v22:id>10212</v22:id>

</v22:situacao>

</v21:situacoes>

<v21:tipos>

<v22:tipoContrato>

<v22:id>10185</v22:id>

</v22:tipoContrato>

</v21:tipos>

<v21:perfis>

<v22:perfil>

<v22:id>99</v22:id>

</v22:perfil>

<v22:perfil>

<v22:id>1234</v22:id>

</v22:perfil>

</v21:perfis>

<v21:papel>VENDEDOR</v21:papel>

</v21:listarContratoRequest>

</soapenv:Body>

</soapenv:Envelope>

5.1.4. Exemplo de XML de saída

<io:Envelope xmlns:io="xxxx://xxxxxxx.xxxxxxx.xxx/xxxx/xxxxxxxx/" xmlns:io2="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0">

<io:Header>

<io2:messageHeader>

<io2:transactionId>37525c89-f5a5-48d1-b1c5-8ab515d68628</io2:transactionId>

<io2:versao>2.1</io2:versao>

</io2:messageHeader>

<io2:paginacao>

<io2:numero>1</io2:numero>

<io2:quantidadeItens>2</io2:quantidadeItens>

<io2:totalPaginas>1</io2:totalPaginas>

<io2:quantidadeTotalItens>2</io2:quantidadeTotalItens>

</io2:paginacao>

</io:Header>

<io:Body>

<bmv2:listarContratoResponse xmlns:bov2="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0" xmlns:bmv2="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0">

<bmv2:contratos>

<bov2:contrato>

<bov2:codigoOrigem>1234</bov2:codigoOrigem>

<bov2:codigoReferencia>LEILAO</bov2:codigoReferencia>

<bov2:fonteEnergia>

<bov2:tipo>

<bov2:id>10197</bov2:id>

<bov2:nome>CONVENCIONAL</bov2:nome>

</bov2:tipo>

</bov2:fonteEnergia>

<bov2:id>123456</bov2:id>

<bov2:tipo>

<bov2:id>10185</bov2:id>

<bov2:nome>CCEAL</bov2:nome>

<bov2:subTipo>

<bov2:id>10777</bov2:id>

<bov2:nome>Firme</bov2:nome>

</bov2:subTipo>

</bov2:tipo>

<bov2:vigencias>

<bov2:vigenciaContrato>

<bov2:dataFinalizacao>2018-12-31T22:00:00-03:00</bov2:dataFinalizacao>

<bov2:finalizado>true</bov2:finalizado>

<bov2:participantesMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>COMPRADOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>1234</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>VENDEDOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>99</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

</bov2:participantesMercado>

<bov2:periodoSuprimento>

<bov2:inicio>2013-04-01T00:00:00-03:00</bov2:inicio>

<bov2:fim>2018-12-31T22:00:00-03:00</bov2:fim>

</bov2:periodoSuprimento>

<bov2:situacao>

<bov2:id>10212</bov2:id>

<bov2:nome>REGISTRADO_NAO_VALIDADO</bov2:nome>

</bov2:situacao>

<bov2:submercadoEntrega>

<bov2:id>1</bov2:id>

<bov2:nome>Sudeste / Centro-Oeste</bov2:nome>

</bov2:submercadoEntrega>

<bov2:submercadoOrigem>

<bov2:id>1</bov2:id>

<bov2:nome>Sudeste / Centro-Oeste</bov2:nome>

</bov2:submercadoOrigem>

<bov2:observacao>Observa絥s</bov2:observacao>

</bov2:vigenciaContrato>

</bov2:vigencias>

<bov2:solicitarCancelamento>false</bov2:solicitarCancelamento>

1.2

Versão

0405/2020

Data Publicação

17 de 26 Páginas

<bov2:cancelado>false</bov2:cancelado>

<bov2:indicadores>

<bov2:indicador>

<bov2:descricao>EXPORTACAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>EXPORTACAOVALIDADO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>GERACAOPROPRIA</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>GERACAOPROPRIAVALIDADO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>AUTOPRODUCAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>ALIVIOEXPOSICAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>RECEBIMENTOEXCEDENTE</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>LASTROVENDADISPONIVEL</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>LASTROVENDAVALIDADO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>PARTESRELACIONADAS</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>REPASSEAUTOPRODUCAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

</bov2:indicadores>

</bov2:contrato>

<bov2:contrato>

<bov2:codigoReferencia>LEILAO</bov2:codigoReferencia>

<bov2:fonteEnergia>

<bov2:tipo>

<bov2:id>10197</bov2:id>

<bov2:nome>CONVENCIONAL</bov2:nome>

</bov2:tipo>

</bov2:fonteEnergia>

<bov2:id>999999</bov2:id>

<bov2:tipo>

<bov2:id>10185</bov2:id>

<bov2:nome>CCEAL</bov2:nome>

<bov2:subTipo>

<bov2:id>10777</bov2:id>

<bov2:nome>Firme</bov2:nome>

</bov2:subTipo>

</bov2:tipo>

<bov2:vigencias>

<bov2:vigenciaContrato>

<bov2:finalizado>false</bov2:finalizado>

<bov2:participantesMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>COMPRADOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>1234</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>VENDEDOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>99</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

</bov2:participantesMercado>

<bov2:periodoSuprimento>

<bov2:inicio>2013-05-01T00:00:00-03:00</bov2:inicio>

<bov2:fim>2018-12-31T22:00:00-03:00</bov2:fim>

</bov2:periodoSuprimento>

<bov2:situacao>

<bov2:id>10212</bov2:id>

<bov2:nome>REGISTRADO_NAO_VALIDADO</bov2:nome>

</bov2:situacao>

<bov2:submercadoEntrega>

<bov2:id>1</bov2:id>

<bov2:nome>Sudeste / Centro-Oeste</bov2:nome>

</bov2:submercadoEntrega>

</bov2:vigenciaContrato>

</bov2:vigencias>

<bov2:solicitarCancelamento>false</bov2:solicitarCancelamento>

<bov2:cancelado>false</bov2:cancelado>

<bov2:indicadores>

<bov2:indicador>

<bov2:descricao>EXPORTACAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>EXPORTACAOVALIDADO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>GERACAOPROPRIA</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>GERACAOPROPRIAVALIDADO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>AUTOPRODUCAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>ALIVIOEXPOSICAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>RECEBIMENTOEXCEDENTE</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>LASTROVENDADISPONIVEL</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>LASTROVENDAVALIDADO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>PARTESRELACIONADAS</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

<bov2:indicador>

<bov2:descricao>REPASSEAUTOPRODUCAO</bov2:descricao>

<bov2:valor>NAO</bov2:valor>

</bov2:indicador>

</bov2:indicadores>

</bov2:contrato>

</bmv2:contratos>

</bmv2:listarContratoResponse>

</io:Body>

</io:Envelope>

5.2. Listar Contratos Regulados

Este método será responsável por retornar uma lista de contratos regulados. Para isso, é obrigatório o

envio do valor “REGULADO” no campo “ambienteContratacao”.

5.2.1. Parâmetros de entrada

Os parâmetros abaixo devem ser enviados para a consulta de contratos:

Nome	Descrição	Tipo	Valores	Condição
codigoPerfilAgente	Código do perfil agente utilizados nos sistemas da CCEE	Alfanumérico		Obrigatório
Username	Usuário fornecido para utilização da plataforma	Alfanumérico		Obrigatório
Password	Senha fornecida para utilização da plataforma	Alfanumérico		Obrigatório
versao	Versão do serviço a ser utilizado		2.1	Obrigatório
numero	Número da página que deseja obter o resultado	Numérico		Obrigatório
quantidadeItens	Quantidade de itens retornados por página	Numérico		Obrigatório
Perfis de agente	Lista de perfis de agentes	Estrutura		Obrigatório
papel	Identifica se os códigos dos perfis de agente utilizado pertencem a compradores ou vendedores	Alfabético	COMPRADOR VENDEDOR	Opcional
Situações do Contrato	Lista de Situações do Contrato	Estrutura		Opcional
Tipo do Contrato	Tipo do Contrato	Estrutura		Opcional
periodoReferencia	Período de referência para a busca	Estrutura		Obrigatório
Ambiente de contratação	Define o tipo de ambiente de contratação do mercado de energia ao qual o contrato foi submetido. Caso este valor não seja informado, será considerado o valor ‘LIVRE’	Alfabético	REGULADO	Obrigatório
Código do contrato físico	O código ACR é a chave do contrato papel, utilizado nos processos do SGP e da Certisign quando da assinatura dos contratos. O código ACR pode estar relacionado a N códigos de contrato Cliq. Será permitido informar um código ACR para localizar contratos regulados.	Númerico	123	Opcional

5.2.2. Parâmetros de saída

Os parâmetros abaixo serão retornados na consulta de contratos:

Nome	Descrição	Tipo	Valores	Condição
id	Identificador único que corresponde a um número sequencial de um determinado contrato	Numérico	Exemplo: 12465	Opcional
Código do contrato físico	O código ACR é a chave do contrato papel, utilizado nos processos do SGP e da Certisign quando da assinatura dos contratos. O código ACR pode estar relacionado a N códigos de contrato Cliq. Será permitido informar um código ACR para localizar contratos regulados	Alfabético	Exemplo: 1150	Opcional
tipo	Identificador dos tipos de contrato existentes no ambiente sistêmico da CCEE.	Estrutura		Opcional
vigencia	Vigências do contrato	Estrutura		Opcional

5.2.1. Exemplo de XML de entrada

<soapenv:Header>

<v2:messageHeader>

<v2:codigoPerfilAgente>99999</v2:codigoPerfilAgente>

<v2:versao>2.1</v2:versao>

</v2:messageHeader>

<oas:Security>

<oas:UsernameToken>

<oas:Username>USUARIO</oas:Username>

<oas:Password>SENHA</oas:Password>

</oas:UsernameToken>

</oas:Security>

<v2:paginacao>

<v2:numero>1</v2:numero>

<v2:quantidadeItens>10</v2:quantidadeItens>

</v2:paginacao>

</soapenv:Header>

<soapenv:Body>

<v21:listarContratoRequest>

<v21:ambienteContratacao>

<v22:nome>REGULADO</v22:nome>

</v21:ambienteContratacao>

<v21:periodoReferencia>

<v22:inicio>2019-01-01T00:00:00</v22:inicio>

<v22:fim>2019-02-01T00:00:00</v22:fim>

</v21:periodoReferencia>

<v21:tipos>

<v22:tipoContrato>

<v22:codigo>10186</v22:codigo>

</v22:tipoContrato>

</v21:tipos>

<v21:perfis>

<v22:perfil>

<v22:id>99999</v22:id>

</v22:perfil>

</v21:perfis>

</v21:listarContratoRequest>

</soapenv:Body>

</soapenv:Envelope>

5.2.2. Exemplo de XML de saída

<io:Envelope xmlns:io2="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0" xmlns:io="xxxx://xxxxxxx.xxxxxxx.xxx/xxxx/xxxxxxxx/">

<io:Header>

<io2:messageHeader>

<io2:transactionId>9a8f32a4-d796-4e33-92aa-6b30c86a2869</io2:transactionId>

<io2:versao>2.1</io2:versao>

</io2:messageHeader>

<io2:paginacao>

<io2:numero>1</io2:numero>

<io2:quantidadeItens>2</io2:quantidadeItens>

<io2:totalPaginas>12</io2:totalPaginas>

<io2:quantidadeTotalItens>24</io2:quantidadeTotalItens>

</io2:paginacao>

</io:Header>

<io:Body>

<bmv2:listarContratoResponse xmlns:bov2="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0" xmlns:bmv2="xxxx://xxxxx.xxxxxxx.xxx.xx/XX/x0">

<bmv2:contratos>

<bov2:contrato>

<bov2:codigoContratoFisico>12345</bov2:codigoContratoFisico>

<bov2:id>54321</bov2:id>

<bov2:tipo>

<bov2:id>10186</bov2:id>

<bov2:nome>CCEAR_Q</bov2:nome>

</bov2:tipo>

<bov2:vigencias>

<bov2:vigenciaContrato>

<bov2:participantesMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>COMPRADOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>99999</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>VENDEDOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>88888</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

</bov2:participantesMercado>

<bov2:periodoSuprimento>

<bov2:inicio>2018-01-01T00:00:00-02:00</bov2:inicio>

<bov2:fim>2019-12-31T23:00:00-03:00</bov2:fim>

</bov2:periodoSuprimento>

<bov2:situacao>

<bov2:id>10213</bov2:id>

<bov2:nome>VALIDADO</bov2:nome>

</bov2:situacao>

</bov2:vigenciaContrato>

</bov2:vigencias>

</bov2:contrato>

<bov2:contrato>

<bov2:codigoContratoFisico>65432</bov2:codigoContratoFisico>

<bov2:id>23456</bov2:id>

<bov2:tipo>

<bov2:id>10186</bov2:id>

<bov2:nome>CCEAR_Q</bov2:nome>

</bov2:tipo>

<bov2:vigencias>

<bov2:vigenciaContrato>

<bov2:participantesMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>COMPRADOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>999999</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

<bov2:participanteMercado>

<bov2:tipo>

<bov2:descricao>VENDEDOR</bov2:descricao>

</bov2:tipo>

<bov2:perfis>

<bov2:perfil>

<bov2:id>777777</bov2:id>

</bov2:perfil>

</bov2:perfis>

</bov2:participanteMercado>

</bov2:participantesMercado>

<bov2:periodoSuprimento>

<bov2:inicio>2018-01-01T00:00:00-02:00</bov2:inicio>

<bov2:fim>2019-12-31T23:00:00-03:00</bov2:fim>

</bov2:periodoSuprimento>

<bov2:situacao>

<bov2:id>10213</bov2:id>

<bov2:nome>VALIDADO</bov2:nome>

</bov2:situacao>

</bov2:vigenciaContrato>

</bov2:vigencias>

</bov2:contrato>

</bmv2:contratos>

</bmv2:listarContratoResponse>

</io:Body>

</io:Envelope>

6. Regras de negócio

• Número da página obrigatório e deve ser maior que zero;

• Tamanho da página obrigatório e deve ser maior que zero;

• Data fim (dataFimPeriodo) não pode ser maior do que a data início (dataIniPeriodo);

• Data início (dataIniPeriodo) e Data fim (dataFimPeriodo) deve estar dentro do mesmo mês (Ex. Não são permitidas datas 15/09/2019 até 15/10/2019);

• Pode ser informado no máximo CEM (100) Código de perfil do agente (codPerfilAgente - Lista);

• Não é possível consultar contratos que você não seja o proprietário ou represente alguma das partes;

7. Descrição de alerta e Exceções

A seguir, descreveremos as descrições das mensagens de alerta e exceção, classificando-as em categorias de código de erro:

Código de erro	Mensagem de ambiente
2-9999	Um erro aconteceu.
2-1001	O Serviço está indisponível.
2-2001	Acesso Negado.
2-2002	XML Inválido.

Código	Mensagens de Alerta referentes ao negócio.
0000	A Operação <nome da operação> foi processada com sucesso!
1-3001	Dados não encontrados.
1-3006	A Data inicial não pode ser maior que a Data final.

1.2

Versão

0405/2020

Data Publicação

25 de 26 Páginas

8. Abreviações, siglas e acrônimos

Sigla	Definição
XML	eXtensible Markup Language
SOAP	Simple Object Access Protocol
WSDL	Web Service Description Language
XSD	Xml Schema Definition
CCEE	Câmara de Comercialização de Energia Elétrica
HTTPS	HyperText Transfer Protocol Secure
SSL	Secure Sockets Layer
URL	Uniform Resource Locator
WSS	Web Service Security

9. Referências

Sigla	Definição
Apache Axis 1.x, 2.x	xxxx://xx.xxxxxx.xxx/xxxx/
HTTP	xxxx://xxx.x0.xxx/Xxxxxxxxx/xxx0000/xxx0000.xxx
SOAP 1.1	xxxx://xxx.x0.xxx/XX/0000/XXXX-XXXX-00000000/
WSDL 1.1	xxxx://xxx.x0.xxx/XX/0000/XXXX-xxxx-00000000
Web Services Security 1.0	xxxx://xxx.xxxxx- xxxx.xxx/xxxxxxxxxx/xx_xxxx.xxx?xx_xxxxxxxxxx
XML 1.1	xxxx://xxx.x0.xxx/XX/xxx00/
XML Schema 1.1	xxxx://xxx.x0.xxx/XXX/Xxxxxx
XML Schema Definition	xxxx://xxx.x0.xxx/0000/XXXXxxxxx.xxx
SSL	xxxx://xxx.xxx.xxx/
HTTPS	xxxx://xxxxx.xxxx.xxx/xxxx/xxx0000

1.2

Versão

0405/2020

Data Publicação

26 de 26 Páginas

Document Metadata

Table of Contents

Histórico de Revisões

Document Metadata