IATI: Reporting Orgs Not Discoverable Via POST Endpoint

by Alex Johnson 56 views

Let's dive into a critical issue encountered while using the IATI Registry API. Specifically, we're addressing the problem where new reporting organizations created via the POST /reporting-orgs endpoint aren't automatically set as discoverable. This has significant implications for users and the overall usability of the IATI platform. This article will discuss the severity of the issue, the expected behavior, and potential solutions.

The Problem: Organizations Created, But Hidden

The core of the problem lies in the fact that when a new reporting organization is created using the POST /reporting-orgs endpoint, it's not automatically flagged as 'discoverable'. This means that even the administrators of the newly created organization are unable to see it, edit it, or invite other users to join. Essentially, the organization exists in the system but is invisible to those who should have immediate access.

This issue introduces a significant bottleneck. Currently, the workaround involves contacting IATI support to manually set the 'discoverable' flag in the CRM. This not only adds an unnecessary step to the process but also delays the ability of organizations to manage their data and engage with the IATI ecosystem effectively. The user experience suffers considerably, as administrators are left wondering why their newly created organization is nowhere to be found. To make matters worse, attempts to directly set the iati_registry_discoverable flag within the payload of the POST request appear to be ignored by the system, offering no immediate solution for users.

Severity: A Major Roadblock

The severity of this issue is high. It directly impacts the ability of new organizations to onboard and manage their IATI data. The inability to immediately access and manage their organization creates a frustrating experience for users and hinders their participation in the IATI initiative. It's not just an inconvenience; it's a roadblock that prevents organizations from fully utilizing the IATI platform. Consider a scenario where an organization is under a tight deadline to publish their data. Discovering that they cannot even see their organization after creating it can lead to significant delays and potential non-compliance. The manual intervention required from IATI support further exacerbates the problem, adding to the overall turnaround time and potentially overwhelming support resources.

Furthermore, this issue undermines the self-service nature of the IATI Registry API. The API is designed to empower organizations to manage their data independently. However, the need for manual intervention defeats this purpose and creates a dependency on IATI support for a seemingly simple task. This not only increases the workload for IATI staff but also reduces the efficiency and autonomy of organizations using the platform. This problem can discourage new users from contributing if the beginning is riddled with problems.

Expected Behavior: Immediate Visibility

The expected behavior is straightforward: when a new reporting organization is created via the POST /reporting-orgs endpoint, it should be immediately visible and accessible to its designated administrators. This is a fundamental requirement for a smooth and efficient user experience. Even if there are plans for a future approval process for organizations to be discoverable to the wider IATI community, the administrators themselves should always have immediate access.

Imagine a scenario where an organization successfully creates their reporting organization through the API. They should then be able to log in, view their organization profile, edit details, add users, and begin publishing their IATI data. This seamless flow is crucial for encouraging participation and ensuring data quality. The current situation, where organizations are left in the dark and require manual intervention, is simply unacceptable. The principle of least surprise dictates that creating an organization should result in immediate visibility and control for its administrators. Any deviation from this expectation creates confusion and frustration.

Potential Solutions and Next Steps

To resolve this issue, a thorough investigation of the POST /reporting-orgs endpoint is necessary. The following steps should be considered:

  1. Code Review: Carefully examine the code responsible for handling the POST /reporting-orgs request to identify why the 'discoverable' flag is not being set correctly.
  2. Payload Handling: Verify that the iati_registry_discoverable parameter, when included in the payload, is being properly processed and applied to the new organization.
  3. Database Updates: Ensure that the database is being updated correctly with the 'discoverable' flag set to 'true' for new organizations.
  4. Testing: Implement comprehensive testing to ensure that new organizations are consistently created as discoverable.
  5. Immediate Access Control: Make sure administrators can manage and see the organization's information.

In addition to these technical steps, it's also important to communicate clearly with users about the expected behavior and any known issues. Providing clear documentation and timely updates can help manage expectations and reduce frustration.

Conclusion: A Call for Action

The issue of newly created reporting organizations not being discoverable via the POST /reporting-orgs endpoint is a significant problem that needs immediate attention. It hinders the onboarding process, creates a poor user experience, and undermines the self-service nature of the IATI Registry API. By addressing this issue promptly and effectively, IATI can ensure that new organizations can seamlessly join the IATI community and contribute to the shared goal of increased transparency and accountability in development finance.

It's crucial that IATI prioritizes this issue and takes the necessary steps to resolve it. The long-term success of the IATI initiative depends on providing a user-friendly and efficient platform for organizations to manage their data. By addressing this seemingly small but critical issue, IATI can demonstrate its commitment to supporting its users and fostering a thriving IATI ecosystem.

For further information on IATI and its standards, please visit the IATI official website.