### Program Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Endpoints for managing and reviewing program information. ```APIDOC ## GET /api/program ### Description Retrieve a collection of programs with optional filtering capabilities. ### Method GET ### Endpoint /api/program ### Parameters #### Query Parameters * **filter** (string) - Optional - Parameters to filter the program collection. ### Response #### Success Response (200) - **programs** (array) - A list of program objects. #### Response Example ```json { "programs": [ { "id": "prog1", "name": "Program One" }, { "id": "prog2", "name": "Program Two" } ] } ``` ``` ```APIDOC ## POST /api/program ### Description Add a new program to the system. ### Method POST ### Endpoint /api/program ### Parameters #### Request Body * **name** (string) - Required - The name of the program. * **organizationId** (string) - Required - The ID of the organization this program belongs to. ### Response #### Success Response (201) - **id** (string) - The unique identifier of the newly created program. #### Response Example ```json { "id": "new_prog_id" } ``` ``` ```APIDOC ## GET /api/program/{uniqueId} ### Description Find a specific program by its unique ID. ### Method GET ### Endpoint /api/program/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the program to retrieve. ### Response #### Success Response (200) - **program** (object) - The details of the requested program. #### Response Example ```json { "id": "prog1", "name": "Program One", "organizationId": "org1" } ``` ``` ```APIDOC ## PUT /api/program/{uniqueId} ### Description Updates an existing program identified by its unique ID. ### Method PUT ### Endpoint /api/program/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the program to update. #### Request Body * **name** (string) - Optional - The updated name of the program. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the update. #### Response Example ```json { "message": "Program updated successfully." } ``` ``` ```APIDOC ## GET /api/program/{uniqueId}/metrics ### Description Fetch basic metrics for a specific program. ### Method GET ### Endpoint /api/program/{uniqueId}/metrics ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the program to fetch metrics for. ### Response #### Success Response (200) - **metrics** (object) - An object containing program metrics. #### Response Example ```json { "participantsCount": 150, "totalPointsAwarded": 50000 } ``` ``` -------------------------------- ### Program Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Provides operations for program management and review. ```APIDOC ## GET /api/program ### Description Retrieves a list of programs. ### Method GET ### Endpoint /api/program ### Parameters None ### Request Example None ### Response #### Success Response (200) * **schemaProgramList** (array) - List of program objects. #### Response Example ```json { "example": "[{"uniqueId": "prog1", "name": "Program A"}, {"uniqueId": "prog2", "name": "Program B"}]" } ``` ``` ```APIDOC ## POST /api/program ### Description Creates a new program. ### Method POST ### Endpoint /api/program ### Parameters #### Request Body * **schemaProgramCreate** (object) - Required - Program creation schema. ### Request Example ```json { "example": "{\"name\": \"New Program\", \"organizationId\": \"org1\", ...}" } ``` ### Response #### Success Response (200) * **schemaProgramRead** (object) - The created program object. #### Response Example ```json { "example": "{\"uniqueId\": \"prog3\", \"name\": \"New Program\", ...}" } ``` ``` ```APIDOC ## GET /api/program/{uniqueId} ### Description Retrieves a specific program by its unique ID. ### Method GET ### Endpoint /api/program/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the program. ### Request Example None ### Response #### Success Response (200) * **schemaProgramRead** (object) - The program object. #### Response Example ```json { "example": "{\"uniqueId\": \"prog1\", \"name\": \"Program A\", ...}" } ``` ``` ```APIDOC ## PUT /api/program/{uniqueId} ### Description Updates an existing program by its unique ID. ### Method PUT ### Endpoint /api/program/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the program to update. #### Request Body * **schemaProgramUpdate** (object) - Required - Program update schema. ### Request Example ```json { "example": "{\"name\": \"Updated Program Name\", ...}" } ``` ### Response #### Success Response (200) * **schemaProgramRead** (object) - The updated program object. #### Response Example ```json { "example": "{\"uniqueId\": \"prog1\", \"name\": \"Updated Program Name\", ...}" } ``` ``` ```APIDOC ## GET /api/program/{uniqueId}/metrics ### Description Retrieves metrics for a specific program. ### Method GET ### Endpoint /api/program/{uniqueId}/metrics ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the program. ### Request Example None ### Response #### Success Response (200) * **schemaProgramMetrics** (object) - Program metrics object. #### Response Example ```json { "example": "{\"totalParticipants\": 1000, \"totalPointsAwarded\": 50000, ...}" } ``` ``` -------------------------------- ### SSO Integration API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Generates Single Sign-On (SSO) URLs for participants. ```APIDOC ## POST /api/program/{programId}/participant/{uniqueId}/sso ### Description Generates a Single Sign-On (SSO) URL for a participant. ### Method POST ### Endpoint /api/program/{programId}/participant/{uniqueId}/sso ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. ### Request Example None ### Response #### Success Response (200) * **ssoUrl** (string) - The generated SSO URL. #### Response Example ```json { "example": "https://sso.example.com/login?token=..." } ``` ``` ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId}/sso ### Description Retrieves the SSO status or configuration for a participant. (Note: The exact functionality of GET might differ from POST; this is an interpretation based on typical SSO patterns). ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId}/sso ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. ### Request Example None ### Response #### Success Response (200) * **ssoStatus** (string) - The SSO status of the participant (e.g., 'enabled', 'disabled', 'pending'). #### Response Example ```json { "example": "{\"ssoStatus\": \"enabled\"}" } ``` ``` -------------------------------- ### Participant Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Provides operations for participant management and review. ```APIDOC ## GET /api/program/{programId}/participant ### Description Retrieves a list of participants for a given program. ### Method GET ### Endpoint /api/program/{programId}/participant ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. ### Request Example None ### Response #### Success Response (200) * **schemaParticipantRead** (array) - List of participant objects. #### Response Example ```json { "example": "[{"uniqueId": "p1", "programId": "prog1", "firstName": "John", "lastName": "Doe"}, ...]" } ``` ``` ```APIDOC ## POST /api/program/{programId}/participant ### Description Adds a single participant to a program. ### Method POST ### Endpoint /api/program/{programId}/participant ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. #### Request Body * **schemaUserWrite** (object) - Required - Participant creation schema. ### Request Example ```json { "example": "{\"firstName\": \"Jane\", \"lastName\": \"Smith\", \"email\": \"jane.smith@example.com\"}" } ``` ### Response #### Success Response (200) * **schemaParticipantRead** (object) - The created participant object. #### Response Example ```json { "example": "{\"uniqueId\": \"p2\", \"programId\": \"prog1\", \"firstName\": \"Jane\", \"lastName\": \"Smith\", ...}" } ``` ``` ```APIDOC ## POST /api/program/{programId}/participant/list ### Description Adds multiple participants to a program in a batch. ### Method POST ### Endpoint /api/program/{programId}/participant/list ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. #### Request Body * **schemaUserList** (array) - Required - An array of participant creation schemas. ### Request Example ```json { "example": "[{\"firstName\": \"Alice\", \"lastName\": \"Wonderland\"}, {\"firstName\": \"Bob\", \"lastName\": \"TheBuilder\"}]" } ``` ### Response #### Success Response (200) * **schemaParticipantRead** (array) - List of created participant objects. #### Response Example ```json { "example": "[{\"uniqueId\": \"p3\", ...}, {\"uniqueId\": \"p4\", ...}]" } ``` ``` ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId} ### Description Retrieves a specific participant by their unique ID within a program. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. ### Request Example None ### Response #### Success Response (200) * **schemaParticipantRead** (object) - The participant object. #### Response Example ```json { "example": "{\"uniqueId\": \"p1\", \"programId\": \"prog1\", \"firstName\": \"John\", \"lastName\": \"Doe\", ...}" } ``` ``` ```APIDOC ## PUT /api/program/{programId}/participant/{uniqueId} ### Description Updates a specific participant by their unique ID within a program. ### Method PUT ### Endpoint /api/program/{programId}/participant/{uniqueId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant to update. #### Request Body * **schemaParticipantUpdate** (object) - Required - Participant update schema. ### Request Example ```json { "example": "{\"firstName\": \"Jonathan\", \"lastName\": \"Doe\"}" } ``` ### Response #### Success Response (200) * **schemaParticipantRead** (object) - The updated participant object. #### Response Example ```json { "example": "{\"uniqueId\": \"p1\", \"programId\": \"prog1\", \"firstName\": \"Jonathan\", \"lastName\": \"Doe\", ...}" } ``` ``` ```APIDOC ## DELETE /api/program/{programId}/participant/{uniqueId} ### Description Deletes a specific participant by their unique ID within a program. ### Method DELETE ### Endpoint /api/program/{programId}/participant/{uniqueId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant to delete. ### Request Example None ### Response #### Success Response (200) * **message** (string) - Confirmation message of deletion. #### Response Example ```json { "example": "Participant with ID p1 deleted successfully." } ``` ``` ```APIDOC ## PUT /api/program/{programId}/participant/{uniqueId}/meta ### Description Updates the metadata for a specific participant. ### Method PUT ### Endpoint /api/program/{programId}/participant/{uniqueId}/meta ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Request Body * **schemaMeta** (object) - Required - Metadata to update. ### Request Example ```json { "example": "{\"customField1\": \"value1\", \"customField2\": \"value2\"}" } ``` ### Response #### Success Response (200) * **schemaMeta** (object) - The updated metadata. #### Response Example ```json { "example": "{\"customField1\": \"value1\", \"customField2\": \"value2\"}" } ``` ``` ```APIDOC ## PATCH /api/program/{programId}/participant/{uniqueId}/meta ### Description Partially updates the metadata for a specific participant. ### Method PATCH ### Endpoint /api/program/{programId}/participant/{uniqueId}/meta ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Request Body * **schemaMeta** (object) - Required - Metadata to partially update. ### Request Example ```json { "example": "{\"customField1\": \"new_value\"}" } ``` ### Response #### Success Response (200) * **schemaMeta** (object) - The updated metadata. #### Response Example ```json { "example": "{\"customField1\": \"new_value\", \"customField2\": \"value2\"}" } ``` ``` -------------------------------- ### Webhook Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Provides operations for webhook management and review. ```APIDOC ## GET /api/organization/{orgId}/webhooks ### Description Retrieves a list of webhooks configured for a specific organization. ### Method GET ### Endpoint /api/organization/{orgId}/webhooks ### Parameters #### Path Parameters * **orgId** (string) - Required - The unique identifier of the organization. ### Request Example None ### Response #### Success Response (200) * **schemaWebhookRead** (array) - List of webhook configurations. #### Response Example ```json { "example": "[{\"webhookId\": \"wh1\", \"url\": \"https://example.com/webhook\", \"events\": [\"participant.created\"], ...}, ...]" } ``` ``` ```APIDOC ## POST /api/organization/{orgId}/webhooks ### Description Creates a new webhook configuration for an organization. ### Method POST ### Endpoint /api/organization/{orgId}/webhooks ### Parameters #### Path Parameters * **orgId** (string) - Required - The unique identifier of the organization. #### Request Body * **schemaWebhookCreate** (object) - Required - Webhook creation schema. ### Request Example ```json { "example": "{\"url ``` -------------------------------- ### Organization Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Endpoints for managing and reviewing organization information. ```APIDOC ## GET /api/organization ### Description Retrieve a collection of organizations with optional filtering capabilities. ### Method GET ### Endpoint /api/organization ### Parameters #### Query Parameters * **filter** (string) - Optional - Parameters to filter the organization collection. ### Response #### Success Response (200) - **organizations** (array) - A list of organization objects. #### Response Example ```json { "organizations": [ { "id": "org1", "name": "Organization One" }, { "id": "org2", "name": "Organization Two" } ] } ``` ``` ```APIDOC ## POST /api/organization ### Description Add a new organization to the system. ### Method POST ### Endpoint /api/organization ### Parameters #### Request Body * **name** (string) - Required - The name of the organization. * **details** (object) - Optional - Additional details about the organization. ### Response #### Success Response (201) - **id** (string) - The unique identifier of the newly created organization. #### Response Example ```json { "id": "new_org_id" } ``` ``` ```APIDOC ## GET /api/organization/{uniqueId} ### Description Find a specific organization by its unique ID. ### Method GET ### Endpoint /api/organization/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the organization to retrieve. ### Response #### Success Response (200) - **organization** (object) - The details of the requested organization. #### Response Example ```json { "id": "org1", "name": "Organization One", "details": {} } ``` ``` ```APIDOC ## PUT /api/organization/{uniqueId} ### Description Updates an existing organization identified by its unique ID. ### Method PUT ### Endpoint /api/organization/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the organization to update. #### Request Body * **name** (string) - Optional - The updated name of the organization. * **details** (object) - Optional - Updated additional details about the organization. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the update. #### Response Example ```json { "message": "Organization updated successfully." } ``` ``` -------------------------------- ### Organization Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Provides operations for organization management and review. ```APIDOC ## GET /api/organization ### Description Retrieves a list of organizations. ### Method GET ### Endpoint /api/organization ### Parameters None ### Request Example None ### Response #### Success Response (200) * **schemaOrganizationList** (array) - List of organization objects. #### Response Example ```json { "example": "[{"uniqueId": "org1", "name": "Organization A"}, {"uniqueId": "org2", "name": "Organization B"}]" } ``` ``` ```APIDOC ## POST /api/organization ### Description Creates a new organization. ### Method POST ### Endpoint /api/organization ### Parameters #### Request Body * **schemaOrganizationCreate** (object) - Required - Organization creation schema. ### Request Example ```json { "example": "{\"name\": \"New Organization\", \"contact\": {...}}" } ``` ### Response #### Success Response (200) * **schemaOrganizationRead** (object) - The created organization object. #### Response Example ```json { "example": "{\"uniqueId\": \"org3\", \"name\": \"New Organization\", ...}" } ``` ``` ```APIDOC ## GET /api/organization/{uniqueId} ### Description Retrieves a specific organization by its unique ID. ### Method GET ### Endpoint /api/organization/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the organization. ### Request Example None ### Response #### Success Response (200) * **schemaOrganizationRead** (object) - The organization object. #### Response Example ```json { "example": "{\"uniqueId\": \"org1\", \"name\": \"Organization A\", ...}" } ``` ``` ```APIDOC ## PUT /api/organization/{uniqueId} ### Description Updates an existing organization by its unique ID. ### Method PUT ### Endpoint /api/organization/{uniqueId} ### Parameters #### Path Parameters * **uniqueId** (string) - Required - The unique identifier of the organization to update. #### Request Body * **schemaOrganizationUpdate** (object) - Required - Organization update schema. ### Request Example ```json { "example": "{\"name\": \"Updated Organization Name\", \"contact\": {...}}" } ``` ### Response #### Success Response (200) * **schemaOrganizationRead** (object) - The updated organization object. #### Response Example ```json { "example": "{\"uniqueId\": \"org1\", \"name\": \"Updated Organization Name\", ...}" } ``` ``` -------------------------------- ### Participant Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Endpoints for managing and reviewing participant information within a program. ```APIDOC ## GET /api/program/{programId}/participant ### Description Retrieve a collection of participants for a given program with optional filtering. ### Method GET ### Endpoint /api/program/{programId}/participant ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. #### Query Parameters * **filter** (string) - Optional - Parameters to filter the participant collection. ### Response #### Success Response (200) - **participants** (array) - A list of participant objects. #### Response Example ```json { "participants": [ { "id": "p1", "name": "Participant One" }, { "id": "p2", "name": "Participant Two" } ] } ``` ``` ```APIDOC ## POST /api/program/{programId}/participant ### Description Add a new participant to a specified program. ### Method POST ### Endpoint /api/program/{programId}/participant ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. #### Request Body * **name** (string) - Required - The name of the participant. * **email** (string) - Required - The email address of the participant. ### Response #### Success Response (201) - **id** (string) - The unique identifier of the newly created participant. #### Response Example ```json { "id": "new_participant_id" } ``` ``` ```APIDOC ## POST /api/program/{programId}/participant/list ### Description Bulk fetch participants by their unique IDs within a specified program. ### Method POST ### Endpoint /api/program/{programId}/participant/list ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. #### Request Body * **participantIds** (array) - Required - An array of unique participant identifiers. ### Response #### Success Response (200) - **participants** (array) - A list of participant objects matching the provided IDs. #### Response Example ```json { "participants": [ { "id": "p1", "name": "Participant One" }, { "id": "p3", "name": "Participant Three" } ] } ``` ``` ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId} ### Description Find a specific participant by their unique ID within a program. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant to retrieve. ### Response #### Success Response (200) - **participant** (object) - The details of the requested participant. #### Response Example ```json { "id": "p1", "name": "Participant One", "email": "participant1@example.com" } ``` ``` ```APIDOC ## PUT /api/program/{programId}/participant/{uniqueId} ### Description Updates an existing participant identified by their unique ID within a program. ### Method PUT ### Endpoint /api/program/{programId}/participant/{uniqueId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant to update. #### Request Body * **name** (string) - Optional - The updated name of the participant. * **email** (string) - Optional - The updated email address of the participant. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the update. #### Response Example ```json { "message": "Participant updated successfully." } ``` ``` ```APIDOC ## DELETE /api/program/{programId}/participant/{uniqueId} ### Description Deletes a participant by setting their status to inactive. ### Method DELETE ### Endpoint /api/program/{programId}/participant/{uniqueId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant to delete. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the deletion. #### Response Example ```json { "message": "Participant deactivated successfully." } ``` ``` ```APIDOC ## PUT /api/program/{programId}/participant/{uniqueId}/meta ### Description Replaces all metadata for a specific participant. ### Method PUT ### Endpoint /api/program/{programId}/participant/{uniqueId}/meta ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Request Body * **metadata** (object) - Required - An object containing all participant metadata. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the metadata update. #### Response Example ```json { "message": "Participant metadata updated successfully." } ``` ``` ```APIDOC ## PATCH /api/program/{programId}/participant/{uniqueId}/meta ### Description Adds or updates one or more metadata key-value pairs for a specific participant. ### Method PATCH ### Endpoint /api/program/{programId}/participant/{uniqueId}/meta ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Request Body * **metadataUpdates** (object) - Required - An object containing metadata key-value pairs to add or update. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the metadata update. #### Response Example ```json { "message": "Participant metadata updated successfully." } ``` ``` -------------------------------- ### Webhook Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Endpoints for managing and reviewing webhooks for organizations. ```APIDOC ## GET /api/organization/{orgId}/webhooks ### Description List all webhooks configured for a specific organization. ### Method GET ### Endpoint /api/organization/{orgId}/webhooks ### Parameters #### Path Parameters * **orgId** (string) - Required - The unique identifier of the organization. ### Response #### Success Response (200) - **webhooks** (array) - A list of webhook objects. #### Response Example ```json { "webhooks": [ { "id": "wh1", "url": "https://example.com/webhook", "event": "participant.created" }, { "id": "wh2", "url": "https://example.com/another", "event": "transaction.completed" } ] } ``` ``` ```APIDOC ## POST /api/organization/{orgId}/webhooks ### Description Create a new webhook for a specific organization. ### Method POST ### Endpoint /api/organization/{orgId}/webhooks ### Parameters #### Path Parameters * **orgId** (string) - Required - The unique identifier of the organization. #### Request Body * **url** (string) - Required - The URL to send webhook events to. * **event** (string) - Required - The event that triggers the webhook. ### Response #### Success Response (201) - **id** (string) - The unique identifier of the newly created webhook. #### Response Example ```json { "id": "new_webhook_id" } ``` ``` ```APIDOC ## GET /api/organization/{orgId}/webhooks/{webhookId} ### Description Get details of a specific webhook for an organization. ### Method GET ### Endpoint /api/organization/{orgId}/webhooks/{webhookId} ### Parameters #### Path Parameters * **orgId** (string) - Required - The unique identifier of the organization. * **webhookId** (string) - Required - The unique identifier of the webhook. ### Response #### Success Response (200) - **webhook** (object) - The details of the requested webhook. #### Response Example ```json { "id": "wh1", "url": "https://example.com/webhook", "event": "participant.created" } ``` ``` ```APIDOC ## PUT /api/organization/{orgId}/webhooks/{webhookId} ### Description Update an existing webhook for an organization. ### Method PUT ### Endpoint /api/organization/{orgId}/webhooks/{webhookId} ### Parameters #### Path Parameters * **orgId** (string) - Required - The unique identifier of the organization. * **webhookId** (string) - Required - The unique identifier of the webhook to update. #### Request Body * **url** (string) - Optional - The updated URL. * **event** (string) - Optional - The updated event trigger. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the update. #### Response Example ```json { "message": "Webhook updated successfully." } ``` ``` ```APIDOC ## GET /api/organization/{orgId}/webhooks/{webhookId}/logs ### Description Get the logs for a specific webhook. ### Method GET ### Endpoint /api/organization/{orgId}/webhooks/{webhookId}/logs ### Parameters #### Path Parameters * **orgId** (string) - Required - The unique identifier of the organization. * **webhookId** (string) - Required - The unique identifier of the webhook. ### Response #### Success Response (200) - **logs** (array) - A list of webhook log objects. #### Response Example ```json { "logs": [ { "logId": "log1", "timestamp": "2023-10-27T10:00:00Z", "status": "success" }, { "logId": "log2", "timestamp": "2023-10-27T10:05:00Z", "status": "failed" } ] } ``` ``` ```APIDOC ## GET /api/organization/{orgId}/webhooks/{webhookId}/logs/{webhookLogId} ### Description View a single webhook log entry. ### Method GET ### Endpoint /api/organization/{orgId}/webhooks/{webhookId}/logs/{webhookLogId} ### Parameters #### Path Parameters * **orgId** (string) - Required - ``` -------------------------------- ### Transaction Management API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Provides operations for transaction management and review. ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId}/transaction ### Description Retrieves a list of transactions for a specific participant. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId}/transaction ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. ### Request Example None ### Response #### Success Response (200) * **schemaTransaction** (array) - List of transaction objects. #### Response Example ```json { "example": "[{\"transactionId\": \"txn1\", \"amount\": 10.50, \"timestamp\": \"2023-10-27T12:00:00Z\"}, ...]" } ``` ``` ```APIDOC ## POST /api/program/{programId}/participant/{uniqueId}/transaction ### Description Creates a new transaction for a participant. ### Method POST ### Endpoint /api/program/{programId}/participant/{uniqueId}/transaction ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Request Body * **schemaCreateTransaction** (object) - Required - Transaction creation schema. ### Request Example ```json { "example": "{\"amount\": 25.00, \"description\": \"Purchase item X\", \"products\": [{\"sku\": \"SKU123\", \"quantity\": 1}]}" } ``` ### Response #### Success Response (200) * **schemaTransaction** (object) - The created transaction object. #### Response Example ```json { "example": "{\"transactionId\": \"txn2\", \"amount\": 25.00, \"timestamp\": \"2023-10-27T13:00:00Z\", ...}" } ``` ``` ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId}/transaction/{transactionId} ### Description Retrieves a specific transaction by its ID for a participant. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId}/transaction/{transactionId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. * **transactionId** (string) - Required - The unique identifier of the transaction. ### Request Example None ### Response #### Success Response (200) * **schemaTransaction** (object) - The transaction object. #### Response Example ```json { "example": "{\"transactionId\": \"txn1\", \"amount\": 10.50, ...}" } ``` ``` ```APIDOC ## PATCH /api/program/{programId}/participant/{uniqueId}/transaction/{transactionId}/meta ### Description Partially updates the metadata for a specific transaction. ### Method PATCH ### Endpoint /api/program/{programId}/participant/{uniqueId}/transaction/{transactionId}/meta ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. * **transactionId** (string) - Required - The unique identifier of the transaction. #### Request Body * **schemaMeta** (object) - Required - Metadata to partially update. ### Request Example ```json { "example": "{\"notes\": \"Customer feedback received\"}" } ``` ### Response #### Success Response (200) * **schemaMeta** (object) - The updated metadata. #### Response Example ```json { "example": "{\"notes\": \"Customer feedback received\"}" } ``` ``` ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId}/transaction/{transactionId}/return/{itemGuid} ### Description Retrieves details about a returned item within a transaction. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId}/transaction/{transactionId}/return/{itemGuid} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. * **transactionId** (string) - Required - The unique identifier of the transaction. * **itemGuid** (string) - Required - The unique identifier of the returned item. ### Request Example None ### Response #### Success Response (200) * **schemaReturnItemRead** (object) - The details of the returned item. #### Response Example ```json { "example": "{\"itemGuid\": \"item1\", \"sku\": \"SKU123\", \"quantityReturned\": 1, \"reason\": \"Defective\"}" } ``` ``` -------------------------------- ### SSO API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Endpoints for generating and validating Single Sign-On (SSO) URLs for participants. ```APIDOC ## POST /api/program/{programId}/participant/{uniqueId}/sso ### Description Create a Single Sign-On (SSO) token for a participant, generating an SSO URL. ### Method POST ### Endpoint /api/program/{programId}/participant/{uniqueId}/sso ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. ### Response #### Success Response (201) - **ssoUrl** (string) - The generated Single Sign-On URL for the participant. #### Response Example ```json { "ssoUrl": "https://sso.example.com/login?token=abc123xyz" } ``` ``` ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId}/sso ### Description Validate a participant's SSO token. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId}/sso ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Query Parameters * **ssoToken** (string) - Required - The SSO token to validate. ### Response #### Success Response (200) - **isValid** (boolean) - Indicates if the SSO token is valid. #### Response Example ```json { "isValid": true } ``` ``` -------------------------------- ### Point Adjustment API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Allows for crediting or debiting points from participants. ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId}/adjustment ### Description Retrieves a history of point adjustments for a specific participant. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId}/adjustment ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. ### Request Example None ### Response #### Success Response (200) * **schemaPointRead** (array) - List of point adjustment objects. #### Response Example ```json { "example": "[{\"adjustmentId\": \"adj1\", \"amount\": 100, \"type\": \"credit\", \"timestamp\": \"2023-10-27T10:00:00Z\"}, ...]" } ``` ``` ```APIDOC ## POST /api/program/{programId}/participant/{uniqueId}/adjustment ### Description Applies a point adjustment (credit or debit) to a participant's account. ### Method POST ### Endpoint /api/program/{programId}/participant/{uniqueId}/adjustment ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Request Body * **schemaPointWrite** (object) - Required - Point adjustment schema. ### Request Example ```json { "example": "{\"amount\": 50, \"type\": \"credit\", \"description\": \"Welcome bonus\"}" } ``` ### Response #### Success Response (200) * **schemaPointRead** (object) - The created point adjustment object. #### Response Example ```json { "example": "{\"adjustmentId\": \"adj2\", \"amount\": 50, \"type\": \"credit\", \"timestamp\": \"2023-10-27T11:00:00Z\"}" } ``` ``` ```APIDOC ## PATCH /api/program/{programId}/participant/{uniqueId}/adjustment/{adjustmentId} ### Description Partially updates a specific point adjustment. ### Method PATCH ### Endpoint /api/program/{programId}/participant/{uniqueId}/adjustment/{adjustmentId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. * **adjustmentId** (string) - Required - The unique identifier of the adjustment. #### Request Body * **schemaPointUpdate** (object) - Required - Point adjustment update schema. ### Request Example ```json { "example": "{\"description\": \"Updated bonus description\"}" } ``` ### Response #### Success Response (200) * **schemaPointRead** (object) - The updated point adjustment object. #### Response Example ```json { "example": "{\"adjustmentId\": \"adj1\", \"amount\": 100, \"type\": \"credit\", \"description\": \"Updated bonus description\", ...}" } ``` ``` -------------------------------- ### Point Adjustment API Source: https://app.swaggerhub.com/apis/AllDigitalRewards/Marketplace/index Endpoints for crediting or debiting points from participants. ```APIDOC ## GET /api/program/{programId}/participant/{uniqueId}/adjustment ### Description Retrieve a list of point adjustment transactions for a specific participant. ### Method GET ### Endpoint /api/program/{programId}/participant/{uniqueId}/adjustment ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. ### Response #### Success Response (200) - **adjustments** (array) - A list of point adjustment transaction objects. #### Response Example ```json { "adjustments": [ { "id": "adj1", "amount": 100, "reason": "Award" }, { "id": "adj2", "amount": -50, "reason": "Redemption" } ] } ``` ``` ```APIDOC ## POST /api/program/{programId}/participant/{uniqueId}/adjustment ### Description Add a point adjustment for a specific participant. ### Method POST ### Endpoint /api/program/{programId}/participant/{uniqueId}/adjustment ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. #### Request Body * **amount** (number) - Required - The amount of points to adjust (positive for credit, negative for debit). * **reason** (string) - Required - The reason for the point adjustment. ### Response #### Success Response (201) - **id** (string) - The unique identifier of the created point adjustment. #### Response Example ```json { "id": "new_adjustment_id" } ``` ``` ```APIDOC ## PATCH /api/program/{programId}/participant/{uniqueId}/adjustment/{adjustmentId} ### Description Update an existing point adjustment for a participant. ### Method PATCH ### Endpoint /api/program/{programId}/participant/{uniqueId}/adjustment/{adjustmentId} ### Parameters #### Path Parameters * **programId** (string) - Required - The unique identifier of the program. * **uniqueId** (string) - Required - The unique identifier of the participant. * **adjustmentId** (string) - Required - The unique identifier of the point adjustment to update. #### Request Body * **amount** (number) - Optional - The updated amount of points. * **reason** (string) - Optional - The updated reason for the adjustment. ### Response #### Success Response (200) - **message** (string) - Confirmation message of the update. #### Response Example ```json { "message": "Point adjustment updated successfully." } ``` ```