Skip to content

Offering Compliance API Documentation

Offering compliance functionality enables service providers to define and track compliance requirements for their marketplace offerings. Users of these offerings must complete compliance checklists, and service providers can monitor completion status across all their offerings.

Overview

The offering compliance system allows service providers to:

  • Define compliance checklists for their offerings
  • Track user compliance across all offerings
  • Monitor completion rates and identify users needing attention
  • Ensure regulatory and organizational compliance requirements are met

Architecture

The system consists of three main components:

  1. Compliance Checklists - Customizable questionnaires attached to offerings
  2. Offering Users - Users who have access to offerings and must complete compliance
  3. Service Provider Management - Dashboard and APIs for compliance monitoring

Configuration

Setting Up Offering Compliance

1. Create a Compliance Checklist

First, create a checklist with type offering_compliance:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin/
Content-Type: application/json
Authorization: Token <admin-token>

{
  "name": "Security Compliance Checklist",
  "description": "Required security compliance information for cloud services",
  "checklist_type": "offering_compliance"
}

2. Add Questions to the Checklist

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST /api/checklists-admin/questions/
Content-Type: application/json
Authorization: Token <admin-token>

{
  "checklist": "<checklist-uuid>",
  "description": "Have you completed security training?",
  "question_type": "boolean",
  "required": true,
  "order": 1
}

3. Assign Checklist to Offering

Attach the compliance checklist to an offering:

1
2
3
4
5
6
7
POST /api/marketplace-provider-offerings/<offering-uuid>/update_compliance_checklist/
Content-Type: application/json
Authorization: Token <service-provider-token>

{
  "compliance_checklist": "<checklist-uuid>"
}

4. Remove Checklist from Offering

Remove the compliance checklist from an offering:

1
2
3
4
5
6
7
POST /api/marketplace-provider-offerings/<offering-uuid>/update_compliance_checklist/
Content-Type: application/json
Authorization: Token <service-provider-token>

{
  "compliance_checklist": null
}

API Endpoints

Checking Offering Compliance Requirements

Before accessing compliance-specific endpoints, you can check if an offering has compliance requirements using the standard offering API.

Get Offering Details

1
GET /api/marketplace-public-offerings/<offering-uuid>/

Response includes:

1
2
3
4
5
6
{
  "uuid": "offering-uuid",
  "name": "Cloud VM Service",
  "has_compliance_requirements": true,
  // ... other offering fields
}

Field Description:

Field Type Description
has_compliance_requirements Boolean Indicates whether this offering requires users to complete compliance checklists

Usage:

  • true - This offering requires compliance. Users must complete checklists before using the service.
  • false - This offering has no compliance requirements. Users can use the service without additional checklists.

For Offering Users

These endpoints allow offering users to view and complete their compliance requirements.

Base URL Pattern

1
/api/marketplace-offering-users/<offering-user-uuid>/

1. Get Compliance Checklist

Retrieves the compliance checklist for an offering user, including all questions and existing answers.

1
2
GET /api/marketplace-offering-users/<offering-user-uuid>/checklist/
Authorization: Token <user-token>

Permissions Required:

  • The authenticated user must be the offering user
  • Service provider staff with UPDATE_OFFERING_USER permission

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  "checklist": {
    "uuid": "checklist-uuid",
    "name": "Security Compliance Checklist",
    "description": "Required security compliance information",
    "checklist_type": "offering_compliance"
  },
  "completion": {
    "uuid": "completion-uuid",
    "is_completed": false,
    "completion_percentage": 50.0,
    "unanswered_required_questions": [
      {
        "uuid": "question-uuid",
        "description": "Data handling procedures",
        "question_type": "text_area"
      }
    ],
    "checklist_name": "Security Compliance Checklist",
    "created": "2024-01-15T10:30:00Z",
    "modified": "2024-01-15T14:20:00Z"
  },
  "questions": [
    {
      "uuid": "question-uuid-1",
      "description": "Have you completed security training?",
      "question_type": "boolean",
      "required": true,
      "order": 1,
      "existing_answer": {
        "uuid": "answer-uuid",
        "answer_data": true,
        "user": "user-uuid",
        "user_name": "John Doe",
        "created": "2024-01-15T14:20:00Z"
      }
    },
    {
      "uuid": "question-uuid-2",
      "description": "Compliance level",
      "question_type": "single_select",
      "required": true,
      "order": 2,
      "existing_answer": null,
      "question_options": [
        {
          "uuid": "option-uuid-1",
          "label": "Basic",
          "order": 1
        },
        {
          "uuid": "option-uuid-2",
          "label": "Advanced",
          "order": 2
        }
      ]
    }
  ]
}

2. Get Completion Status

Retrieves only the completion status for the offering user's compliance.

1
2
GET /api/marketplace-offering-users/<offering-user-uuid>/completion_status/
Authorization: Token <user-token>

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "uuid": "completion-uuid",
  "is_completed": false,
  "completion_percentage": 75.0,
  "unanswered_required_questions": [
    {
      "uuid": "question-uuid",
      "description": "Emergency contact",
      "question_type": "text_input"
    }
  ],
  "checklist_name": "Security Compliance Checklist",
  "created": "2024-01-15T10:30:00Z",
  "modified": "2024-01-15T14:20:00Z"
}

3. Submit Compliance Answers

Submit or update answers to compliance questions.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
POST /api/marketplace-offering-users/<offering-user-uuid>/submit_answers/
Content-Type: application/json
Authorization: Token <user-token>

[
  {
    "question_uuid": "question-uuid-1",
    "answer_data": true
  },
  {
    "question_uuid": "question-uuid-2",
    "answer_data": "Completed advanced security training on 2024-01-10"
  },
  {
    "question_uuid": "question-uuid-3",
    "answer_data": ["option-uuid-1"]
  }
]

Answer Data Formats:

Question Type Format Example
text_input String "Short text answer"
text_area String "Detailed compliance information"
boolean Boolean true or false
number Number 42 or 3.14
single_select Array with one UUID ["option-uuid"]
multi_select Array with multiple UUIDs ["option-1", "option-2"]

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "detail": "Answers submitted successfully",
  "completion": {
    "uuid": "completion-uuid",
    "is_completed": true,
    "completion_percentage": 100.0,
    "unanswered_required_questions": [],
    "checklist_name": "Security Compliance Checklist",
    "created": "2024-01-15T10:30:00Z",
    "modified": "2024-01-15T15:45:00Z"
  }
}

For Service Providers

These endpoints allow service providers to monitor and manage compliance across all their offerings.

Base URL Pattern

1
/api/marketplace-service-providers/<service-provider-uuid>/compliance/

Checklist Completions API

This endpoint provides a comprehensive view of checklist completions across all offerings that the current user has access to.

List All Checklist Completions

Get a paginated list of all checklist completions for offering users that the current user is allowed to see.

1
2
GET /api/marketplace-offering-user-checklist-completions/
Authorization: Token <user-token>

Permissions:

  • Regular users: See only their own checklist completions
  • Staff users: See all checklist completions
  • Support users: See all checklist completions
  • Service providers: See completions for offerings they manage

Query Parameters:

Parameter Type Description
user_uuid UUID Filter by specific user
offering_uuid UUID Filter by specific offering
is_completed Boolean Filter by completion status (true or false)
o String Order by field (modified, -modified, is_completed, -is_completed)
page_size Integer Number of results per page (default: 10, max: 300)

Example Requests:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# Get all completions for current user
GET /api/marketplace-offering-user-checklist-completions/

# Filter by specific user (staff/support only)
GET /api/marketplace-offering-user-checklist-completions/?user_uuid=<user-uuid>

# Filter by offering
GET /api/marketplace-offering-user-checklist-completions/?offering_uuid=<offering-uuid>

# Filter by completion status
GET /api/marketplace-offering-user-checklist-completions/?is_completed=false

# Order by last modified
GET /api/marketplace-offering-user-checklist-completions/?o=-modified

# Combine filters
GET /api/marketplace-offering-user-checklist-completions/?offering_uuid=<uuid>&is_completed=false&o=-modified

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
[
  {
    "uuid": "completion-uuid-1",
    "offering_user_uuid": "offering-user-uuid-1",
    "offering_name": "Cloud VM Service",
    "offering_uuid": "offering-uuid-1",
    "customer_provider_uuid": "provider-customer-uuid-1",
    "customer_provider_name": "TechCorp Solutions",
    "checklist_uuid": "checklist-uuid",
    "checklist_name": "Security Compliance Checklist",
    "checklist_description": "Required security compliance information",
    "is_completed": false,
    "completion_percentage": 75.0,
    "unanswered_required_questions": 1,
    "requires_review": false,
    "reviewed_by": null,
    "reviewed_at": null,
    "review_notes": "",
    "created": "2024-01-15T10:30:00Z",
    "modified": "2024-01-19T14:20:00Z",
    "offering_user": {
      "uuid": "offering-user-uuid-1",
      "username": "johndoe",
      "user_full_name": "John Doe",
      "user_email": "john.doe@example.com",
      "state": "OK",
      "is_restricted": false
    }
  },
  {
    "uuid": "completion-uuid-2",
    "offering_user_uuid": "offering-user-uuid-2",
    "offering_name": "Storage Service",
    "offering_uuid": "offering-uuid-2",
    "customer_provider_uuid": "provider-customer-uuid-2",
    "customer_provider_name": "DataVault Inc",
    "checklist_uuid": "checklist-uuid-2",
    "checklist_name": "Data Protection Compliance",
    "checklist_description": "Data handling and protection requirements",
    "is_completed": true,
    "completion_percentage": 100.0,
    "unanswered_required_questions": 0,
    "requires_review": true,
    "reviewed_by": "reviewer-uuid",
    "reviewed_at": "2024-01-18T16:30:00Z",
    "review_notes": "Approved after verification",
    "created": "2024-01-10T09:00:00Z",
    "modified": "2024-01-18T16:30:00Z",
    "offering_user": {
      "uuid": "offering-user-uuid-2",
      "username": "janesmith",
      "user_full_name": "Jane Smith",
      "user_email": "jane.smith@example.com",
      "state": "OK",
      "is_restricted": false
    }
  }
]

Response Headers (Pagination):

Header Description
X-Result-Count Total number of completions matching filters
Link Navigation links for pagination (first, prev, next, last)

Field Descriptions:

Field Type Description
uuid UUID Unique identifier for the checklist completion
offering_user_uuid UUID UUID of the associated offering user
offering_name String Name of the offering
offering_uuid UUID UUID of the offering
customer_provider_uuid UUID UUID of the service provider customer
customer_provider_name String Name of the service provider customer
checklist_uuid UUID UUID of the compliance checklist
checklist_name String Name of the compliance checklist
checklist_description String Description of the compliance checklist
is_completed Boolean Whether all required questions are answered
completion_percentage Float Percentage of questions answered (0-100)
unanswered_required_questions Integer Count of required questions not yet answered
requires_review Boolean Whether any answers triggered review requirements
reviewed_by UUID/null UUID of user who reviewed (if reviewed)
reviewed_at Datetime/null When the completion was reviewed
review_notes String Notes from the reviewer
created Datetime When the completion was created
modified Datetime When the completion was last modified
offering_user Object Details about the offering user

Use Cases:

  1. Service Provider Dashboard: Monitor compliance across all managed offerings
  2. User Dashboard: View personal compliance status across all services
  3. Compliance Reporting: Generate reports on completion rates and pending items
  4. Administrative Overview: Staff can see system-wide compliance status

Performance Notes:

This endpoint is optimized for performance with:

  • Database query optimization to prevent N+1 problems
  • Efficient filtering using database-level operations
  • Proper pagination support for large datasets
  • Cached relationship data to minimize database queries

1. Compliance Overview

Get aggregated compliance statistics for all offerings managed by the service provider.

1
2
GET /api/marketplace-service-providers/<service-provider-uuid>/compliance/compliance_overview/
Authorization: Token <service-provider-token>

Permissions Required:

  • Customer owner or staff with LIST_SERVICE_PROVIDER_CUSTOMERS permission

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
[
  {
    "offering_uuid": "offering-uuid-1",
    "offering_name": "Cloud VM Service",
    "checklist_name": "Security Compliance Checklist",
    "total_users": 25,
    "users_with_completions": 23,
    "completed_users": 18,
    "pending_users": 5,
    "compliance_rate": 72.0
  },
  {
    "offering_uuid": "offering-uuid-2",
    "offering_name": "Storage Service",
    "checklist_name": "Data Protection Compliance",
    "total_users": 15,
    "users_with_completions": 15,
    "completed_users": 15,
    "pending_users": 0,
    "compliance_rate": 100.0
  },
  {
    "offering_uuid": "offering-uuid-3",
    "offering_name": "Basic Compute",
    "checklist_name": null,
    "total_users": 10,
    "users_with_completions": 0,
    "completed_users": 0,
    "pending_users": 0,
    "compliance_rate": 0.0
  }
]

2. List Offering Users with Compliance Status

Get detailed compliance status for individual offering users.

1
2
GET /api/marketplace-service-providers/<service-provider-uuid>/compliance/offering_users/
Authorization: Token <service-provider-token>

Query Parameters:

Parameter Type Description
offering_uuid UUID Filter by specific offering
compliance_status String Filter by status: completed, pending, no_checklist

Example Request:

1
GET /api/marketplace-service-providers/<uuid>/compliance/offering_users/?compliance_status=pending

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
[
  {
    "uuid": "offering-user-uuid-1",
    "user_full_name": "John Doe",
    "user_email": "john.doe@example.com",
    "offering_name": "Cloud VM Service",
    "checklist_name": "Security Compliance Checklist",
    "username": "johndoe",
    "state": "OK",
    "completion_percentage": 75,
    "compliance_status": "pending",
    "last_updated": "2024-01-19T10:30:00Z",
    "created": "2024-01-15T09:00:00Z"
  },
  {
    "uuid": "offering-user-uuid-2",
    "user_full_name": "Jane Smith",
    "user_email": "jane.smith@example.com",
    "offering_name": "Cloud VM Service",
    "checklist_name": "Security Compliance Checklist",
    "username": "janesmith",
    "state": "OK",
    "completion_percentage": 50,
    "compliance_status": "pending",
    "last_updated": "2024-01-18T14:20:00Z",
    "created": "2024-01-10T11:00:00Z"
  }
]

Workflow Examples

Complete User Compliance Flow

  1. Check if offering requires compliance
1
GET /api/marketplace-public-offerings/<offering-uuid>/

Check the has_compliance_requirements field in the response.

  1. User receives offering access

  2. When an offering user is created for an offering with compliance requirements, a compliance checklist completion is automatically created

  3. User views compliance requirements (only if has_compliance_requirements is true)

1
GET /api/marketplace-offering-users/<uuid>/checklist/
  1. User submits compliance answers
1
POST /api/marketplace-offering-users/<uuid>/submit_answers/
  1. Service provider monitors compliance
1
GET /api/marketplace-service-providers/<uuid>/compliance/compliance_overview/

Service Provider Monitoring Flow

  1. View overall compliance statistics
1
GET /api/marketplace-service-providers/<uuid>/compliance/compliance_overview/
  1. Get detailed checklist completions (Alternative comprehensive view)
1
GET /api/marketplace-offering-user-checklist-completions/?is_completed=false&o=-modified
  1. Identify non-compliant users
1
GET /api/marketplace-service-providers/<uuid>/compliance/offering_users/?compliance_status=pending
  1. Follow up with specific users

Use the user details from the response to send reminders or take action

User Dashboard Flow

  1. View personal compliance status across all services
1
GET /api/marketplace-offering-user-checklist-completions/
  1. Filter for pending completions
1
GET /api/marketplace-offering-user-checklist-completions/?is_completed=false
  1. Access specific checklist for completion
1
GET /api/marketplace-offering-users/<offering-user-uuid>/checklist/

Lifecycle Management

Automatic Checklist Creation

When an offering user is created:

  1. System checks if the offering has a compliance checklist
  2. If present, creates a ChecklistCompletion object automatically
  3. Links it to the offering user via generic foreign key

Automatic Cleanup

When an offering user is deleted:

  1. Associated ChecklistCompletion is automatically deleted
  2. All related answers are cascade deleted
  3. No orphaned data remains

Error Handling

Common Error Responses

400 Bad Request - No Checklist Configured

1
2
3
{
  "detail": "No checklist configured for this object"
}

This occurs when trying to access compliance endpoints for an offering without a configured checklist.

403 Forbidden - Insufficient Permissions

1
2
3
{
  "detail": "You do not have permission to perform this action."
}

404 Not Found - Resource Not Found

1
2
3
{
  "detail": "Not found."
}

This can occur when:

  • The offering user doesn't exist
  • The service provider doesn't exist
  • The user doesn't have access to the resource

Validation Errors

When submitting invalid answers:

1
2
3
4
5
6
7
8
9
[
  {},  // First answer valid
  {
    "non_field_errors": [
      "Answer value 'invalid text' is not valid for the question 'Accept terms' (type: boolean)."
    ]
  },
  {}   // Third answer valid
]

Integration Patterns

Frontend Integration

When displaying offerings in your application, use the has_compliance_requirements field to show appropriate UI elements:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
// Example: React component for offering display
function OfferingCard({ offering }) {
  return (
    <div className="offering-card">
      <h3>{offering.name}</h3>
      <p>{offering.description}</p>

      {offering.has_compliance_requirements && (
        <div className="compliance-notice">
          <Icon name="shield" />
          <span>Compliance requirements apply</span>
        </div>
      )}

      <button onClick={() => handleOrder(offering)}>
        Order Service
      </button>
    </div>
  );
}

Order Flow Integration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
// Example: Check compliance before allowing order completion
async function handleOfferingOrder(offering, user) {
  if (offering.has_compliance_requirements) {
    // Redirect to compliance checklist first
    const complianceStatus = await checkUserCompliance(offering, user);

    if (!complianceStatus.is_completed) {
      return redirectToCompliance(offering, user);
    }
  }

  // Proceed with normal order flow
  return processOrder(offering, user);
}

Service Provider Dashboard

Use the compliance overview endpoints to build monitoring dashboards:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// Example: Compliance dashboard component
function ComplianceDashboard({ serviceProvider }) {
  const [complianceData, setComplianceData] = useState([]);

  useEffect(() => {
    fetch(`/api/marketplace-service-providers/${serviceProvider.uuid}/compliance/compliance_overview/`)
      .then(response => response.json())
      .then(data => setComplianceData(data));
  }, [serviceProvider.uuid]);

  return (
    <div className="compliance-dashboard">
      {complianceData.map(offering => (
        <div key={offering.offering_uuid} className="offering-compliance">
          <h4>{offering.offering_name}</h4>
          {offering.checklist_name ? (
            <div className="compliance-stats">
              <span>Compliance Rate: {offering.compliance_rate}%</span>
              <span>Pending Users: {offering.pending_users}</span>
            </div>
          ) : (
            <span className="no-compliance">No compliance requirements</span>
          )}
        </div>
      ))}
    </div>
  );
}

User Compliance Dashboard

Use the checklist completions endpoint to build user-facing compliance dashboards:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
// Example: User compliance status component
function UserComplianceDashboard({ user }) {
  const [completions, setCompletions] = useState([]);
  const [loading, setLoading] = useState(true);

  useEffect(() => {
    // Fetch user's compliance status across all services
    fetch('/api/marketplace-offering-user-checklist-completions/')
      .then(response => response.json())
      .then(data => {
        setCompletions(data);
        setLoading(false);
      });
  }, []);

  const pendingCompletions = completions.filter(c => !c.is_completed);
  const completedCompletions = completions.filter(c => c.is_completed);

  if (loading) return <div>Loading compliance status...</div>;

  return (
    <div className="user-compliance-dashboard">
      <div className="compliance-summary">
        <h3>Your Compliance Status</h3>
        <div className="stats">
          <span className="completed">Completed: {completedCompletions.length}</span>
          <span className="pending">Pending: {pendingCompletions.length}</span>
        </div>
      </div>

      {pendingCompletions.length > 0 && (
        <div className="pending-section">
          <h4>⚠️ Action Required</h4>
          {pendingCompletions.map(completion => (
            <div key={completion.uuid} className="completion-card pending">
              <h5>{completion.offering_name}</h5>
              <p>{completion.checklist_name}</p>
              <div className="progress">
                <span>{completion.completion_percentage}% complete</span>
                <div className="progress-bar">
                  <div
                    className="progress-fill"
                    style={{ width: `${completion.completion_percentage}%` }}
                  />
                </div>
              </div>
              <button
                onClick={() => navigateToChecklist(completion.offering_user_uuid)}
                className="complete-button"
              >
                Complete Compliance
              </button>
            </div>
          ))}
        </div>
      )}

      {completedCompletions.length > 0 && (
        <div className="completed-section">
          <h4>✅ Completed</h4>
          {completedCompletions.map(completion => (
            <div key={completion.uuid} className="completion-card completed">
              <h5>{completion.offering_name}</h5>
              <p>{completion.checklist_name}</p>
              <span className="completed-date">
                Completed: {new Date(completion.modified).toLocaleDateString()}
              </span>
              {completion.requires_review && (
                <span className="review-status">Under Review</span>
              )}
            </div>
          ))}
        </div>
      )}
    </div>
  );
}

Detailed Compliance Monitoring

Use filtering and pagination for detailed compliance monitoring:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// Example: Detailed compliance monitoring with filters
function DetailedComplianceMonitor() {
  const [completions, setCompletions] = useState([]);
  const [filters, setFilters] = useState({
    is_completed: '',
    offering_uuid: '',
    user_uuid: '',
    ordering: '-modified'
  });
  const [totalCount, setTotalCount] = useState(0);
  const [currentPage, setCurrentPage] = useState(1);

  const fetchCompletions = async (page = 1) => {
    const params = new URLSearchParams({
      page_size: 20,
      ...filters
    });

    if (page > 1) params.set('page', page);

    const response = await fetch(`/api/marketplace-offering-user-checklist-completions/?${params}`);
    const data = await response.json();

    setCompletions(data);
    setTotalCount(parseInt(response.headers.get('X-Result-Count') || '0'));
  };

  useEffect(() => {
    fetchCompletions(currentPage);
  }, [filters, currentPage]);

  return (
    <div className="detailed-compliance-monitor">
      <div className="filters">
        <select
          value={filters.is_completed}
          onChange={(e) => setFilters({...filters, is_completed: e.target.value})}
        >
          <option value="">All Statuses</option>
          <option value="true">Completed</option>
          <option value="false">Pending</option>
        </select>

        <select
          value={filters.ordering}
          onChange={(e) => setFilters({...filters, ordering: e.target.value})}
        >
          <option value="-modified">Newest First</option>
          <option value="modified">Oldest First</option>
          <option value="-is_completed">Completed First</option>
          <option value="is_completed">Pending First</option>
        </select>
      </div>

      <div className="results">
        <h4>Compliance Results ({totalCount} total)</h4>
        {completions.map(completion => (
          <div key={completion.uuid} className="result-row">
            <div className="user-info">
              <strong>{completion.offering_user.user_full_name}</strong>
              <span>{completion.offering_user.user_email}</span>
            </div>
            <div className="offering-info">
              <span>{completion.offering_name}</span>
              <span>{completion.checklist_name}</span>
            </div>
            <div className="status-info">
              <span className={`status ${completion.is_completed ? 'completed' : 'pending'}`}>
                {completion.is_completed ? '✅ Complete' : '⏳ Pending'}
              </span>
              <span>{completion.completion_percentage}%</span>
            </div>
            <div className="actions">
              <button onClick={() => viewDetails(completion.offering_user_uuid)}>
                View Details
              </button>
            </div>
          </div>
        ))}
      </div>

      <Pagination
        currentPage={currentPage}
        totalCount={totalCount}
        pageSize={20}
        onPageChange={setCurrentPage}
      />
    </div>
  );
}

Best Practices

For Service Providers

  1. Define Clear Questions
  2. Use descriptive question text
  3. Mark truly required fields as required

  4. Provide helpful guidance text where needed

  5. Regular Monitoring

  6. Check compliance overview regularly
  7. Follow up with users who have pending compliance

  8. Consider setting up automated reminders

  9. Checklist Design

  10. Keep checklists concise and relevant
  11. Group related questions logically
  12. Use appropriate question types for each data point

For Developers

  1. Performance Optimization
  2. Use the has_compliance_requirements field to avoid unnecessary API calls
  3. Use the compliance_overview endpoint for dashboard views
  4. Use the /marketplace-offering-user-checklist-completions/ endpoint for detailed monitoring
  5. Apply filters to reduce data transfer and improve response times
  6. Use pagination parameters to manage large datasets efficiently

  7. Cache compliance status where appropriate to reduce API calls

  8. Error Handling

  9. Always check has_compliance_requirements before accessing compliance endpoints
  10. Handle gracefully when compliance endpoints return 400 (no checklist configured)
  11. Handle permission errors gracefully (403 responses)
  12. Handle pagination limits and empty result sets

  13. Provide clear feedback to users about their compliance status

  14. Integration

  15. Check has_compliance_requirements in offering lists to show UI indicators
  16. Only call compliance endpoints when has_compliance_requirements is true
  17. Use the checklist completions endpoint for cross-service compliance dashboards
  18. Implement filtering to show relevant compliance items to different user types
  19. Consider webhooks for compliance completion events
  20. Integrate with notification systems for reminders

  21. Build comprehensive dashboards using both overview and detailed endpoints

  22. API Usage Patterns

  23. User Dashboards: Use /marketplace-offering-user-checklist-completions/ to show personal compliance status
  24. Service Provider Monitoring: Combine compliance_overview and checklist completions for complete monitoring
  25. Administrative Views: Use filtering by user_uuid and offering_uuid for targeted views
  26. Reporting: Use ordering and filtering to generate compliance reports

Migration Guide

Adding Compliance to Existing Offerings

  1. Create the compliance checklist
  2. Update the offering with the checklist UUID
  3. Existing offering users will need to complete compliance
  4. New offering users will get compliance requirements automatically

Removing Compliance Requirements

  1. Set offering's compliance_checklist to null
  2. Existing completions remain for audit purposes
  3. No new completions will be created

Security Considerations

  1. Data Privacy
  2. Compliance data is only visible to authorized users
  3. Service providers can only see data for their own offerings

  4. Users can only see and edit their own compliance data

  5. Audit Trail

  6. All answer submissions are tracked with timestamps
  7. User information is preserved with each answer

  8. Changes are logged for compliance auditing

  9. Permission Model

  10. Based on existing Waldur permission system
  11. Respects customer and project boundaries
  12. Service provider permissions are strictly scoped