Skip to content

Reviewer Invitations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/reviewer-invitations/{token}/ Get invitation details by token
Other Actions
POST /api/reviewer-invitations/{token}/accept/ Accept a reviewer invitation
POST /api/reviewer-invitations/{token}/decline/ Decline a reviewer invitation

Core CRUD

Get invitation details by token

Get invitation details by token.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-invitations/********/ \
  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.reviewer_invitations import reviewer_invitations_retrieve # (1)

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

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

try {
  const response = await reviewerInvitationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
token string ✓

200 -

Field Type Description
call_name string
call_uuid string (uuid)
invitation_status string
expires_at string (date-time)
is_expired boolean
max_assignments integer
invited_by_name string Name of the person who sent the invitation
profile_status string User's profile status: 'published', 'unpublished', 'missing', or null if not authenticated
requires_profile boolean Whether the invitation requires creating a reviewer profile
coi_configuration any COI configuration for this call
coi_types array of arrays Available COI types as list of [value, label] tuples
proposals array of objects Proposals for which conflicts can be declared
proposals.uuid string (uuid)
proposals.name string
proposals.summary string

Other Actions

Accept a reviewer invitation

Accept a reviewer invitation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-invitations/********/accept/ \
  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.invitation_accept_request import InvitationAcceptRequest # (1)
from waldur_api_client.api.reviewer_invitations import reviewer_invitations_accept # (2)

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

body_data = InvitationAcceptRequest()
response = reviewer_invitations_accept.sync(
    token="********",
    client=client,
    body=body_data
)

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

try {
  const response = await reviewerInvitationsAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
token string ✓
Field Type Required Description
declared_conflicts array of objects Optional list of self-declared conflicts with proposals. Each conflict creates a ConflictOfInterest record with detection_method='self_disclosed'.
declared_conflicts.proposal_uuid string (uuid) ✓
declared_conflicts.coi_type string ✓
Enum: INST_SAME, FIN_DIRECT, REL_FAMILY, ROLE_NAMED, COLLAB_ACTIVE, REL_MENTOR, REL_SUPERVISOR, COAUTH_RECENT, INST_DEPT, INST_FORMER, ROLE_CONF, COLLAB_GRANT, REL_EDITORIAL, COMPET, COAUTH_OLD, INST_CONSORT, CONF_ATTEND, SOC_MEMBER
declared_conflicts.severity any
Constraints: default: apparent
declared_conflicts.description string
Constraints: default: ``

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

401 -

Field Type
error string

Decline a reviewer invitation

Decline a reviewer invitation.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-invitations/********/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.reviewer_invitations import reviewer_invitations_decline # (2)

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

body_data = InvitationDeclineRequest(
    reason="string-value"
)
response = reviewer_invitations_decline.sync(
    token="********",
    client=client,
    body=body_data
)

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

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

200 -

Field Type
detail string