Saltar al contenido

Get a work details

Módulo Identity

GET/work-details/{id}workDetails.get

The caller's own work details (Section 4.5.6 item 10): uniform sizes, dietary and accessibility needs and the travel profile. Read and written only by the person; an engaging org sees a category only while the person shares it with that engagement. The passport number is Restricted and encrypted: it is written here, always read masked, and shown only through the logged revealPassport action. One live row per person (409 on a second). Returns one work details with its `ETag`. A work details the caller may not see returns 404.

  • Requiere la capacidad me.work_details.write.
  • Alcances de OAuth: me.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

workDetails.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the work details.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: WorkDetails

workDetails.get: WorkDetails
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the work details.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
person_idstring (uuid)SíIdentifier of the person the work details belong to; always the caller.
shirt_sizeGarmentLetterSize | nullSí
jacket_sizeGarmentLetterSize | nullSí
pants_sizestring | nullSíPants size as the person writes it.Restricciones: length 1 to 20
shoe_sizestring | nullSíShoe size with its system.Restricciones: length 1 to 20
glove_sizeGarmentLetterSize | nullSí
hat_sizestring | nullSíHat size as the person writes it.Restricciones: length 1 to 20
uniform_notesstring | nullSíAnything else about fit.Restricciones: length 1 to 500
dietary_needsarray of DietaryNeedSíDietary needs, each once, in enum order.
allergiesstring | nullSíAllergies in the person's words, with how severe.Restricciones: length 1 to 500
dietary_notesstring | nullSíOther dietary notes.Restricciones: length 1 to 500
accessibility_needsarray of AccessibilityNeedSíAccessibility needs, each once, in enum order.
accessibility_notesstring | nullSíAccessibility needs in the person's words.Restricciones: length 1 to 1000
seat_preferenceSeatPreference | nullSí
meal_preferencestring | nullSíPreferred in-flight meal.Restricciones: length 1 to 100
home_airportstring | nullSíIATA airport code.Restricciones: pattern ^[A-Z]{3}$
passport_numberstring | Masked | nullSí
passport_number_last4string | nullSíLast four characters of the passport number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
passport_issuing_countrystring | nullSíCountry that issued the passport.Restricciones: pattern ^[A-Z]{2}$
passport_expires_onstring (date) | nullSíDay the passport expires.
passport_namestring | nullSíName exactly as printed in the passport.Restricciones: length 1 to 200
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shirt_size": "XXS",
  "jacket_size": "XXS",
  "pants_size": "32x32",
  "shoe_size": "US 10.5",
  "glove_size": "XXS",
  "hat_size": "7 1/4",
  "uniform_notes": "Prefers a relaxed cut.",
  "dietary_needs": [
    "Vegan"
  ],
  "allergies": "Peanuts, severe",
  "dietary_notes": "No pork.",
  "accessibility_needs": [
    "Seating"
  ],
  "accessibility_notes": "Needs a seat near the stage door.",
  "seat_preference": "Window",
  "meal_preference": "Vegetarian (VGML)",
  "home_airport": "MIA",
  "passport_number": "YA0000TEST",
  "passport_number_last4": "TEST",
  "passport_issuing_country": "US",
  "passport_expires_on": "2026-10-08",
  "passport_name": "IVY MARCHETTI"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/work-details/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.workDetails.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.work_details.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos work-details get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f