Saltar al contenido

List project authority rows

Módulo Projects

GET/project-authoritiesprojectAuthorities.list

An authority having jurisdiction over a project: a responder agency of the jurisdiction of the project's venue (xpms.jurisdiction_agency), one row per service and agency. A project without a venue has none. Returns a cursor page of project authority rows the caller may see. The default order is `project_id`, then `service`, then `agency` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad projects.project.read.
  • Alcances de OAuth: projects.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

projectAuthorities.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de ProjectAuthority

projectAuthorities.list: ProjectAuthority
CampoTipoObligatorioDescripción
project_idstring (uuid)SíIdentifier of the project.
servicestringSíResponder service the agency provides.Restricciones: length 1 to 100
agencystringSíAgency having jurisdiction.Restricciones: length 1 to 300
contactstring | nullSíHow to reach the agency.Restricciones: length 1 to 300
{
  "data": [
    {
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "service": "fire",
      "agency": "Miami-Dade Fire Rescue",
      "contact": "911"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/project-authorities" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.projectAuthorities.listAll()) {
  console.log(row);
}
for row in xos.project_authorities.list_all():
    print(row)
xos project-authorities list --all