← Volver al índice de esquemas

CreateBeneficiaryImportResponse

Respuesta de `POST /v1/beneficiaries/imports` (HTTP 202). Devuelve un envoltorio JSON:API mínimo con el ID de la importación y su estado inicial (`pending`). Sondea `GET /v1/beneficiaries/imports/{id}` cada 2s hasta que el estado sea `preview_ready` o `failed`.

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
type*stringTipo del recurso JSON:API. Siempre `beneficiary_import`.
id*stringIdentificador numérico del trabajo de importación (expresado como string).
attributes*objectAtributos iniciales de la importación devueltos al crearlo.
status*stringEstado inicial del trabajo de importación. El único valor posible es `pending`.
metaobjectMetadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
timezone*stringSiempre `UTC` — la zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601` — sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • POST /v1/beneficiaries/imports