GET api/Consultas/Cliente/{cliente}/Estado/{estado}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| cliente | string |
Required |
|
| estado | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Consulta| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | string |
None. |
|
| Contrato | string |
None. |
|
| Processo | string |
None. |
|
| Servico | string |
None. |
|
| Tecnico | string |
None. |
|
| TipoConsulta | string |
None. |
|
| Descricao | string |
None. |
|
| Cliente | Cliente |
None. |
|
| Data | date |
None. |
|
| DataFim | date |
None. |
|
| Fechada | boolean |
None. |
|
| Faturada | boolean |
None. |
|
| FaturadoEm | date |
None. |
|
| LinhaDocID | globally unique identifier |
None. |
|
| Documento | string |
None. |
|
| Zona | string |
None. |
|
| Online | boolean |
None. |
|
| URLConsulta | string |
None. |
|
| ErroIntegracao | string |
None. |
|
| nconsultas | integer |
None. |
|
| mesEntradaP | integer |
None. |
|
| IdadeCliente | string |
None. |
|
| Estado | string |
None. |
|
| Motivo | integer |
None. |
|
| NrSessao | integer |
None. |
|
| Reagendada | boolean |
None. |
|
| Anexos | Collection of Anexo |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": "sample string 1",
"Contrato": "sample string 2",
"Processo": "sample string 3",
"Servico": "sample string 4",
"Tecnico": "sample string 5",
"TipoConsulta": "sample string 6",
"Descricao": "sample string 7",
"Cliente": {
"Codigo": "sample string 1",
"Nome": "sample string 2",
"DataNascimento": "2025-12-06T06:34:37.4397011+00:00",
"Morada": "sample string 4",
"LocalidadeCp": "sample string 5",
"Numcontrib": "sample string 6",
"Tel1": "sample string 7",
"Tel2": "sample string 8",
"EnderecoWeb": "sample string 9",
"Agrupamento": "sample string 10",
"Escola": "sample string 11",
"Turma": "sample string 12",
"AnoLetivo": "sample string 13",
"Professor": "sample string 14",
"Hospital": "sample string 15",
"Medico": "sample string 16",
"Requerente": "sample string 17",
"Tecnico": "sample string 18",
"Zona": "sample string 19",
"Localidade": "sample string 20",
"CodPostal": "sample string 21",
"NomeFiscal": "sample string 22",
"NISSRequerente": "sample string 23",
"Parentesco": "sample string 24",
"Email": "sample string 25",
"DataEntrada": "2025-12-06T06:34:37.4397011+00:00",
"DataInscricao": "2025-12-06T06:34:37.4397011+00:00",
"Distrito": "sample string 28",
"Rastreio": true,
"ClienteAnulado": true,
"Anexos": [
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
},
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
}
],
"Historico": []
},
"Data": "2025-12-06T06:34:37.4397011+00:00",
"DataFim": "2025-12-06T06:34:37.4397011+00:00",
"Fechada": true,
"Faturada": true,
"FaturadoEm": "2025-12-06T06:34:37.4397011+00:00",
"LinhaDocID": "2db4bf72-4aa4-487a-86bc-dd6490cd81b2",
"Documento": "sample string 14",
"Zona": "sample string 15",
"Online": true,
"URLConsulta": "sample string 17",
"ErroIntegracao": "sample string 18",
"nconsultas": 19,
"mesEntradaP": 20,
"IdadeCliente": "sample string 21",
"Estado": "sample string 22",
"Motivo": 23,
"NrSessao": 24,
"Reagendada": true,
"Anexos": [
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
},
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
}
]
},
{
"ID": "sample string 1",
"Contrato": "sample string 2",
"Processo": "sample string 3",
"Servico": "sample string 4",
"Tecnico": "sample string 5",
"TipoConsulta": "sample string 6",
"Descricao": "sample string 7",
"Cliente": {
"Codigo": "sample string 1",
"Nome": "sample string 2",
"DataNascimento": "2025-12-06T06:34:37.4397011+00:00",
"Morada": "sample string 4",
"LocalidadeCp": "sample string 5",
"Numcontrib": "sample string 6",
"Tel1": "sample string 7",
"Tel2": "sample string 8",
"EnderecoWeb": "sample string 9",
"Agrupamento": "sample string 10",
"Escola": "sample string 11",
"Turma": "sample string 12",
"AnoLetivo": "sample string 13",
"Professor": "sample string 14",
"Hospital": "sample string 15",
"Medico": "sample string 16",
"Requerente": "sample string 17",
"Tecnico": "sample string 18",
"Zona": "sample string 19",
"Localidade": "sample string 20",
"CodPostal": "sample string 21",
"NomeFiscal": "sample string 22",
"NISSRequerente": "sample string 23",
"Parentesco": "sample string 24",
"Email": "sample string 25",
"DataEntrada": "2025-12-06T06:34:37.4397011+00:00",
"DataInscricao": "2025-12-06T06:34:37.4397011+00:00",
"Distrito": "sample string 28",
"Rastreio": true,
"ClienteAnulado": true,
"Anexos": [
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
},
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
}
],
"Historico": []
},
"Data": "2025-12-06T06:34:37.4397011+00:00",
"DataFim": "2025-12-06T06:34:37.4397011+00:00",
"Fechada": true,
"Faturada": true,
"FaturadoEm": "2025-12-06T06:34:37.4397011+00:00",
"LinhaDocID": "2db4bf72-4aa4-487a-86bc-dd6490cd81b2",
"Documento": "sample string 14",
"Zona": "sample string 15",
"Online": true,
"URLConsulta": "sample string 17",
"ErroIntegracao": "sample string 18",
"nconsultas": 19,
"mesEntradaP": 20,
"IdadeCliente": "sample string 21",
"Estado": "sample string 22",
"Motivo": 23,
"NrSessao": 24,
"Reagendada": true,
"Anexos": [
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
},
{
"ID": "92bc8a8d-2ef7-44d0-b697-fb0812b95bde",
"FicheiroOrig": "sample string 2",
"Data": "2025-12-06T06:34:37.4397011+00:00",
"Descricao": "sample string 4",
"Tipo": "sample string 5",
"Utilizador": "sample string 6",
"URL": "sample string 7",
"Document": "sample string 8"
}
]
}
]