Suspensions Module API

API reference for suspension workflow endpoints.

BriteCore V2 suspensions API endpoint wrappers.

britecore_sdk.api.api_calls.v2.suspensions.create_suspension(suspension=None, **kwargs)[source]

Create Suspension.

POST /api/v2/suspensions/create_suspension

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.suspensions.delete_suspension(**kwargs)[source]

Delete Suspension.

POST /api/v2/suspensions/delete_suspension

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.suspensions.get_policy_applicable_suspensions(suspension_actions=None, policy_id=None, **kwargs)[source]

Get Policy Applicable Suspensions.

POST /api/v2/suspensions/get_policy_applicable_suspensions

Parameters:

  • suspension_actions (list[str] | None)

  • policy_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.suspensions.get_revision_suspensions(revision_id=None, **kwargs)[source]

Get Revision Suspensions.

POST /api/v2/suspensions/get_revision_suspensions

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.suspensions.get_user_suspensions_with_geometries(date=None, state=None, **kwargs)[source]

Get User Suspensions With Geometries.

POST /api/v2/suspensions/get_user_suspensions_with_geometries

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.suspensions.list_suspensions(**kwargs)[source]

List Suspensions.

POST /api/v2/suspensions/list_suspensions

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.suspensions.update_suspension(suspension=None, **kwargs)[source]

Update Suspension.

POST /api/v2/suspensions/update_suspension

Parameters:
Return type:

Any