Skip to content

Onboarding Question Metadata

Operations Summary

Method Endpoint Description
GET /api/onboarding-question-metadata/ List Onboarding Question Metadata
GET /api/onboarding-question-metadata/{uuid}/ Retrieve
POST /api/onboarding-question-metadata/ Create
PUT /api/onboarding-question-metadata/{uuid}/ Update
PATCH /api/onboarding-question-metadata/{uuid}/ Partial Update
DELETE /api/onboarding-question-metadata/{uuid}/ Delete

List Onboarding Question Metadata

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-question-metadata/ \
  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.onboarding_question_metadata import onboarding_question_metadata_list # (1)

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

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

try {
  const response = await onboardingQuestionMetadataList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
checklist_uuid string (uuid) Checklist uuid
intent_field string
maps_to_customer_field string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
question_description string
question_uuid string (uuid)

200 -

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

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-question-metadata/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.onboarding_question_metadata import onboarding_question_metadata_retrieve # (1)

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

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

try {
  const response = await onboardingQuestionMetadataRetrieve({
  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
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/onboarding-question-metadata/ \
  Authorization:"Token YOUR_API_TOKEN" \
  question="https://api.example.com/api/question/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.onboarding_question_metadata_request import OnboardingQuestionMetadataRequest # (1)
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_create # (2)

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

body_data = OnboardingQuestionMetadataRequest(
    question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_question_metadata_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await onboardingQuestionMetadataCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "question": "https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
question string (uri) ✓
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification

201 -

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/onboarding-question-metadata/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  question="https://api.example.com/api/question/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.onboarding_question_metadata_request import OnboardingQuestionMetadataRequest # (1)
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_update # (2)

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

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

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

try {
  const response = await onboardingQuestionMetadataUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "question": "https://api.example.com/api/question/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
question string (uri) ✓
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification

200 -

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/onboarding-question-metadata/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_onboarding_question_metadata_request import PatchedOnboardingQuestionMetadataRequest # (1)
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_partial_update # (2)

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

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

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

try {
  const response = await onboardingQuestionMetadataPartialUpdate({
  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
question string (uri)
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification

200 -

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/onboarding-question-metadata/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.onboarding_question_metadata import onboarding_question_metadata_destroy # (1)

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

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

try {
  const response = await onboardingQuestionMetadataDestroy({
  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