> For the complete documentation index, see [llms.txt](https://dev-cucei-itrans.gitbook.io/siiau-api-client/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev-cucei-itrans.gitbook.io/siiau-api-client/requests/alumno.md).

# Alumno

Obtiene los datos de un alumno

## <mark style="color:red;">Parámetros</mark>

| Parámetro  | Tipo     | Descripción       |
| ---------- | -------- | ----------------- |
| **codigo** | `string` | Código del alumno |

## <mark style="color:red;">Uso</mark>

### <mark style="color:orange;">Básico</mark>

{% tabs %}
{% tab title="Helper" %}

```php
$alumno = siiau()->alumno()->encontrar(
    codigo: '123456789',
);
```

{% endtab %}

{% tab title="Facade" %}

```php
use Siiau\ApiClient\Facades\Siiau;

$alumno = siiau()->alumno()->encontrar(
    codigo: '123456789',
);
```

{% endtab %}

{% tab title="Injection" %}

```php
use Siiau\ApiClient\SiiauConnector;

public function foo(SiiauConnector $siiau): void
{
    $alumno = $siiau->alumno()->encontrar(
        codigo: '123456789',
    );
}
```

{% endtab %}
{% endtabs %}

### <mark style="color:orange;">Avanzado</mark>

{% tabs %}
{% tab title="Por sync request" %}

```php
use Siiau\ApiClient\Requests\GetAlumnoRequest;

$response = siiau()->send(new GetAlumnoRequest(
    codigo: '123456789',
));
```

{% endtab %}

{% tab title="Por async request" %}

```php
use Siiau\ApiClient\Requests\GetAlumnoRequest;

$promise = siiau()->sendAsync(new GetAlumnoRequest(
    codigo: '123456789',
));

$promise
   ->then(static function (Response $response) {
      // Handle Response
   })
   ->otherwise(static function (RequestException $exception) {
        // Handle Exception
    });
```

{% endtab %}
{% endtabs %}

***

## <mark style="color:red;">API</mark>

## POST /api/datos-alumno

> Obtiene información básica de un alumno.

```json
{"openapi":"3.0.0","info":{"title":"Documentación de APIs de consulta al WebServer de SIIAU","version":"1.0.0"},"tags":[{"name":"Alumnos","description":"API Endpoints para manejo de Alumnos"}],"servers":[{"url":"https://ws.itrans.cucei.udg.mx","description":"API Server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","description":"Ingrese un Token con el formato: (Bearer \\<token\\>). Ejemplo: Bearer qwerty123456","name":"Authorization","in":"header"}}},"paths":{"/api/datos-alumno":{"post":{"tags":["Alumnos"],"summary":"Obtiene información básica de un alumno.","operationId":"8d31fd51224f1811aedc0f151a1beb08","parameters":[{"name":"codigo","in":"query","description":"Código de SIIAU del Alumno","required":true}],"responses":{"200":{"description":"Json con breve información académica de un alumno","content":{"application/json":{"schema":{"properties":{"carrera":{"type":"string"},"apellido":{"type":"string"},"nombre":{"type":"string"},"codigo":{"type":"string"},"ultimo_ciclo":{"type":"string"},"situacion":{"type":"string"},"ultimo_cicloDesc":{"type":"string"},"campus":{"type":"string"}},"type":"object"}}}},"404":{"description":"Error: Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Descripción del error","type":"string","nullable":"false"}},"type":"object"}}}},"500":{"description":"Error: response status is 500","content":{"application/json":{"schema":{"properties":{"error":{"description":"Descripción del error","type":"string","nullable":"false"}},"type":"object"}}}}}}}}}
```