Skip to content

Latest commit

 

History

History
155 lines (106 loc) · 9.71 KB

README.md

File metadata and controls

155 lines (106 loc) · 9.71 KB
Raw

Applications

(ats.applications)

Available Operations

list

List Applications

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.ats.applications.list(x_connection_token="<value>", remote_data=True, limit=10, cursor="1b8b05bb-5273-4012-b520-8657b0b90874")

if res is not None:
    while True:
        # handle items

        res = res.Next()
        if res is None:
            break

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
remote_data Optional[bool] ➖ Set to true to include data from the original software. true
limit Optional[float] ➖ Set to get the number of records. 10
cursor Optional[str] ➖ Set to get the number of records after this cursor. 1b8b05bb-5273-4012-b520-8657b0b90874
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListAtsApplicationResponse

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

create

Create Applications in any supported Ats software

Example Usage

import dateutil.parser
from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.ats.applications.create(x_connection_token="<value>", unified_ats_application_input={
    "applied_at": dateutil.parser.isoparse("2024-10-01T12:00:00Z"),
    "rejected_at": dateutil.parser.isoparse("2024-10-01T12:00:00Z"),
    "offers": [
        "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
        "12345678-1234-1234-1234-123456789012",
    ],
    "source": "Source Name",
    "credited_to": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "current_stage": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "reject_reason": "Candidate not experienced enough",
    "candidate_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "job_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red",
    },
}, remote_data=False)

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
unified_ats_application_input models.UnifiedAtsApplicationInput ✔️ N/A
remote_data Optional[bool] ➖ Set to true to include data from the original Ats software. false
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedAtsApplicationOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

retrieve

Retrieve Applications from any connected Ats software

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.ats.applications.retrieve(x_connection_token="<value>", id="801f9ede-c698-4e66-a7fc-48d19eebaa4f", remote_data=False)

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
id str ✔️ id of the application you want to retrieve. 801f9ede-c698-4e66-a7fc-48d19eebaa4f
remote_data Optional[bool] ➖ Set to true to include data from the original Ats software. false
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedAtsApplicationOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /