DOCSEARCHbyAlgolia
Submit Docs

PERSCOM API Reference

website·Indexed 31 days ago

https://docs.perscom.io

Documentation for the PERSCOM API, including guides on authentication via Bearer tokens and authorization using scopes. The API provides endpoints for managing announcements, assignment records, attachments, and award records, supporting both individual and batch operations.

Tokens
44.5K
Snippets
554
Records
622
Agent score
54%

What's inside PERSCOM

  1. Overview of PERSCOM Organization Structure

    PERSCOM uses a hierarchical structure to represent organizations. The hierarchy flows from Groups (top-level containers) to Units (subdivisions). Depending on the roster mode, Units may contain Slots, which are then filled by Users via Assignment Records. Users are further defined by their Rank, Position, Specialty, Status, and Unit assignment.

  2. Overview of PERSCOM personnel management suite

    PERSCOM is a comprehensive personnel management platform specifically designed for public safety agencies, including police, fire, EMS, and military organizations. It provides a unified suite of tools to track performance, assign tasks, recognize accomplishments, manage records, build custom forms, analyze data, and maintain organizational communication.

  3. Overview of PERSCOM OAuth 2.0 and OIDC Support

    PERSCOM uses OAuth 2.0 and OpenID Connect (OIDC) to enable secure authentication and authorization. This allows third-party applications to access user data or the PERSCOM API without requiring users to share their passwords. Common use cases include building apps that authenticate via PERSCOM credentials, creating Single Sign-On (SSO) experiences, and integrating with third-party platforms.

  4. Overview of PERSCOM integration options

    PERSCOM provides several methods to integrate personnel data with third-party services depending on the technical requirements:

    • API: For programmatic access and management of data.
    • Automations: To trigger actions automatically based on specific events.
    • OAuth 2.0: For secure authentication between PERSCOM and external applications.
    • SDKs: Official libraries designed to accelerate the integration build process.
    • Webhooks: For receiving real-time notifications when data changes occur.
    • Widgets: For embedding personnel data displays directly onto a website.

  5. Overview of PERSCOM Webhooks

    Webhooks in PERSCOM allow you to receive real-time HTTP notifications when data changes. They are used to integrate PERSCOM with external services such as Slack, Telegram, Discord, Firebase, AWS, or custom internal applications for data synchronization and automated workflows.

  6. Integrate Forumify forums into PERSCOM

    PERSCOM provides a white-label forum integration via Forumify. This integration allows you to add community forum capabilities to your PERSCOM site with a dedicated plugin that handles user synchronization and access control.

  7. Select the appropriate OAuth 2.0 Client Type

    Choose the client type based on your application's architecture and the required grant type:

    • Regular Web Application: Server-side apps using the authorization code grant (users are redirected to authorize).
    • Single Page / Native Application: Client-side apps (SPAs, mobile) using the implicit grant.
    • Machine-to-Machine: Server apps accessing resources without user involvement using the client credentials grant.
    • Resource Owner: Trusted apps where users provide credentials directly using the password grant.

  8. Understand PERSCOM Role-Based Access Control (RBAC)

    PERSCOM uses a role-based access control system where permissions are grouped into roles, and roles are assigned to users. Permissions are additive; if a user has multiple roles, they inherit all permissions from all assigned roles. There is no 'deny' override. The built-in 'Admin' role is a super-admin with full access to all features and cannot be modified or deleted.

  9. Understand PERSCOM API scope-based authorization

    The PERSCOM API uses a scope-based system to control API key permissions. Each API key is assigned a set of scopes that determine which endpoints and operations it can access. If a request is made to an endpoint and the API key lacks the required scope, the API returns a 403 Forbidden response.

  10. Get support for PERSCOM

    PERSCOM provides three primary channels for assistance:

    1. Community Support: Use the Slack channel for quick help from other users and administrators.
    2. Email Support: Contact the support team directly for complex issues or account-specific questions at support@deschutesdesigngroup.com.
    3. Documentation: Access self-service guides, API references, and integration instructions via the official docs site.

  11. Access PERSCOM API specifications and tools

    Developers can use the following resources to accelerate integration:

    • OpenAPI Specification: Available at https://api.perscom.io/spec.json for client generation and testing.
    • Postman Collection: Official collection available for rapid prototyping.

  12. Retrieve a specific unit by ID

    Use the GET /{version}/units/{unit} endpoint to retrieve detailed information about a specific unit. Replace {version} with the API version and {unit} with the unique identifier of the unit you wish to retrieve.
    GET /{version}/units/{unit}