Skip to content

Call Managing Organisations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/call-managing-organisations/ List Call Managing Organisations
GET /api/call-managing-organisations/{uuid}/ Retrieve
POST /api/call-managing-organisations/ Create
PUT /api/call-managing-organisations/{uuid}/ Update
PATCH /api/call-managing-organisations/{uuid}/ Partial Update
DELETE /api/call-managing-organisations/{uuid}/ Delete
Permissions & Users
GET /api/call-managing-organisations/{uuid}/list_users/ List users
POST /api/call-managing-organisations/{uuid}/add_user/ Add user
POST /api/call-managing-organisations/{uuid}/delete_user/ Delete user
POST /api/call-managing-organisations/{uuid}/update_user/ Update user
Other Actions
GET /api/call-managing-organisations/{uuid}/stats/ Return statistics for call managing organisation

Core CRUD

List Call Managing Organisations

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-managing-organisations/ \
  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_managing_organisations import call_managing_organisations_list # (1)

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

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

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

200 -

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

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-managing-organisations/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_managing_organisations import call_managing_organisations_retrieve # (1)

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

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

try {
  const response = await callManagingOrganisationsRetrieve({
  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
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/call-managing-organisations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_managing_organisation_request import CallManagingOrganisationRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_create # (2)

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

body_data = CallManagingOrganisationRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = call_managing_organisations_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await callManagingOrganisationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
description string
customer string (uri) ✓
image string (binary)

201 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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.call_managing_organisation_request import CallManagingOrganisationRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_update # (2)

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

body_data = CallManagingOrganisationRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = call_managing_organisations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await callManagingOrganisationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/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 string
customer string (uri) ✓
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/call-managing-organisations/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_managing_organisation_request import PatchedCallManagingOrganisationRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_partial_update # (2)

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

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

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

try {
  const response = await callManagingOrganisationsPartialUpdate({
  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 string
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/call-managing-organisations/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_managing_organisations import call_managing_organisations_destroy # (1)

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

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

try {
  const response = await callManagingOrganisationsDestroy({
  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) ✓

204 - No response body

Permissions & Users

List users

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

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

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

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

try {
  const response = await callManagingOrganisationsListUsersList({
  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) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

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

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Add user

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_add_user # (2)

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

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = call_managing_organisations_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await callManagingOrganisationsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 -

Field Type Description
non_field_errors array of strings

Delete user

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_delete_user # (2)

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

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = call_managing_organisations_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await callManagingOrganisationsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - No response body

Update user

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_update_user # (2)

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

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = call_managing_organisations_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

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

try {
  const response = await callManagingOrganisationsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Other Actions

Return statistics for call managing organisation

Return statistics for call managing organisation.

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stats/ \
  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_managing_organisations import call_managing_organisations_stats_retrieve # (1)

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

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

try {
  const response = await callManagingOrganisationsStatsRetrieve({
  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
open_calls integer
active_rounds integer
accepted_proposals integer
pending_proposals integer
pending_review integer
rounds_closing_in_one_week integer
calls_closing_in_one_week integer
offering_requests_pending integer