Skip to content

Call Reviewer Pools

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/call-reviewer-pools/ List Call Reviewer Pools
GET /api/call-reviewer-pools/{uuid}/ Retrieve
PATCH /api/call-reviewer-pools/{uuid}/ Partial Update
Other Actions
POST /api/call-reviewer-pools/{uuid}/accept/ Accept a pool invitation (authenticated users only)
POST /api/call-reviewer-pools/{uuid}/decline/ Decline a pool invitation (authenticated users only)

Core CRUD

List Call Reviewer Pools

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-reviewer-pools/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_reviewer_pools_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: call_reviewer_pools_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { callReviewerPoolsList } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
invitation_status array
my_invitations boolean
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
reviewer_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_token string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_reviewer_pools_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_reviewer_pools_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callReviewerPoolsRetrieve } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_token string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_reviewer_pool_update_request import PatchedCallReviewerPoolUpdateRequest # (1)
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCallReviewerPoolUpdateRequest()
response = call_reviewer_pools_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCallReviewerPoolUpdateRequest
  2. API Source: call_reviewer_pools_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callReviewerPoolsPartialUpdate } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
max_assignments integer Maximum number of proposals that can be assigned to this reviewer

200 -

Field Type Description
max_assignments integer Maximum number of proposals that can be assigned to this reviewer

Other Actions

Accept a pool invitation (authenticated users only)

Accept a pool invitation (authenticated users only).

1
2
3
4
echo '[{"proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "coi_type": "INST_SAME", "severity": null, "description": "A sample description."}]' | http \
  POST \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_accept # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_reviewer_pools_accept.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_reviewer_pools_accept
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { callReviewerPoolsAccept } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "coi_type": "INST_SAME", "severity": null, "description": "A sample description."}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
proposal_uuid string (uuid) ✓
coi_type string ✓
severity any
description string

200 -

Field Type Description
detail string
declared_conflicts array of string (uuid)s UUIDs of created conflict records

400 -

Field Type
error string
message string
profile_url string

Decline a pool invitation (authenticated users only)

Decline a pool invitation (authenticated users only).

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/decline/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reason="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_decline_request import InvitationDeclineRequest # (1)
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_decline # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvitationDeclineRequest(
    reason="string-value"
)
response = call_reviewer_pools_decline.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvitationDeclineRequest
  2. API Source: call_reviewer_pools_decline
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { callReviewerPoolsDecline } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsDecline({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "reason": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reason string ✓ Reason for declining the invitation

200 -

Field Type
detail string