POST api/Contrato/Consultar

Consulta os contratos do assinante

Request Information

URI Parameters

None.

Body Parameters

Dados da consulta

ConsultarContratos
NameDescriptionTypeAdditional information
metodo

Método a ser invocado (Opcional)

string

None.

token

Token de acesso Americanet

string

None.

tempo_vida

Tempo de vida do token

string

None.

token2

token de acesso a esta Api

string

None.

Cpf_Cnpj

Cpf/Cnpj do cliente (apenas números)

string

None.

Request Formats

application/json, text/json

Sample:
{
  "metodo": "sample string 1",
  "token": "sample string 2",
  "tempo_vida": "sample string 3",
  "token2": "sample string 4",
  "Cpf_Cnpj": "sample string 5"
}

application/xml, text/xml

Sample:
<ContratoModel.ConsultarContratos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/mvno">
  <Cpf_Cnpj>sample string 5</Cpf_Cnpj>
  <metodo>sample string 1</metodo>
  <tempo_vida>sample string 3</tempo_vida>
  <token>sample string 2</token>
  <token2>sample string 4</token2>
</ContratoModel.ConsultarContratos>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ConsultarContratosRetorno
NameDescriptionTypeAdditional information
contratos

Informações dos contratos e telefone vinculados ao contrato

Collection of ContratosDados

None.

retorno

Código e mensagem de retorno do servidor. 0=Sucesso

MensagemRetorno

None.

token

Token de acesso, caso seja renovado

string

None.

tempo_vida

Tempo de vida do token

string

None.

Response Formats

application/json, text/json

Sample:
{
  "contratos": [
    {
      "numero_contrato": 1,
      "nro_telefone": "sample string 2",
      "chip_icid": "sample string 3",
      "ccod": 4,
      "portabilidade": {
        "nome": "sample string 1",
        "cpf": "sample string 2",
        "rg": "sample string 3",
        "data_nascimento": "sample string 4",
        "status": "sample string 5"
      }
    },
    {
      "numero_contrato": 1,
      "nro_telefone": "sample string 2",
      "chip_icid": "sample string 3",
      "ccod": 4,
      "portabilidade": {
        "nome": "sample string 1",
        "cpf": "sample string 2",
        "rg": "sample string 3",
        "data_nascimento": "sample string 4",
        "status": "sample string 5"
      }
    }
  ],
  "retorno": {
    "codigo": 1,
    "mensagem": "sample string 2"
  },
  "token": "sample string 1",
  "tempo_vida": "sample string 2"
}

application/xml, text/xml

Sample:
<ContratoModel.ConsultarContratosRetorno xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/mvno">
  <contratos>
    <ContratoModel.ContratosDados>
      <ccod>4</ccod>
      <chip_icid>sample string 3</chip_icid>
      <nro_telefone>sample string 2</nro_telefone>
      <numero_contrato>1</numero_contrato>
      <portabilidade>
        <cpf>sample string 2</cpf>
        <data_nascimento>sample string 4</data_nascimento>
        <nome>sample string 1</nome>
        <rg>sample string 3</rg>
        <status>sample string 5</status>
      </portabilidade>
    </ContratoModel.ContratosDados>
    <ContratoModel.ContratosDados>
      <ccod>4</ccod>
      <chip_icid>sample string 3</chip_icid>
      <nro_telefone>sample string 2</nro_telefone>
      <numero_contrato>1</numero_contrato>
      <portabilidade>
        <cpf>sample string 2</cpf>
        <data_nascimento>sample string 4</data_nascimento>
        <nome>sample string 1</nome>
        <rg>sample string 3</rg>
        <status>sample string 5</status>
      </portabilidade>
    </ContratoModel.ContratosDados>
  </contratos>
  <retorno>
    <codigo>1</codigo>
    <mensagem>sample string 2</mensagem>
  </retorno>
  <tempo_vida>sample string 2</tempo_vida>
  <token>sample string 1</token>
</ContratoModel.ConsultarContratosRetorno>