Ats.Applications

Overview

Available Operations

Create - Create Application
Update - Update Application
ListOffers - List Application Offers
Move - Move Application
Reject - Reject Application
GetOffer - Get Application Offer
ScorecardsList - List Application Scorecards
ListScheduledInterviews - List Applications scheduled interviews
GetScheduledInterview - Get Applications scheduled interview
DownloadDocument - Download Application Document
ListCustomFieldDefinitions - List Application Custom Field Definitions
GetCustomFieldDefinition - Get Application Custom Field Definition

Create

Create Application

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Ats.Applications.CreateAsync(
    xAccountId: "<id>",
    atsCreateApplicationRequestDto: new AtsCreateApplicationRequestDto() {
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
        JobId = "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
        JobPostingId = "1c702a20-8de8-4d03-ac18-cbf4ac42eb51",
        LocationId = "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
        ApplicationStatus = null,
        Questionnaires = new List<CreateQuestionnaire>() {
            new CreateQuestionnaire() {
                Id = "right_to_work",
                Answers = new List<CreateAnswer>() {
                    new CreateAnswer() {
                        Id = "answer1",
                        Type = new CreateAnswerType() {
                            Value = CreateAnswerValue.ShortText,
                            SourceValue = CreateAnswerSourceValueUnion.CreateStr(
                                "Short Text"
                            ),
                        },
                        Values = new List<string>() {
                            "Yes",
                        },
                    },
                },
            },
        },
        Source = new AtsCreateApplicationRequestDtoSource() {
            Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            Name = "LinkedIn",
        },
        CandidateId = "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        Candidate = new AtsCreateApplicationRequestDtoCandidate() {
            Passthrough = new Dictionary<string, object>() {
                { "other_known_names", "John Doe" },
            },
            UnifiedCustomFields = new Dictionary<string, object>() {
                { "my_project_custom_field_1", "REF-1236" },
                { "my_project_custom_field_2", "some other value" },
            },
            PhoneNumbers = new List<PhoneNumber>() {
                new PhoneNumber() {
                    Phone = "+447700112233",
                },
            },
            Name = "Romain Sestier",
            FirstName = "Romain",
            LastName = "Sestier",
            Email = "sestier.romain123@gmail.com",
            SocialLinks = new List<SocialLink>() {
                new SocialLink() {
                    Type = "linkedin",
                    Url = "https://www.linkedin.com/in/romainsestier/",
                },
            },
            Company = "Company Inc.",
            Title = "Software Engineer",
            HiredAt = System.DateTime.Parse("2021-01-01T01:01:01.000Z"),
            Country = "United States",
            CustomFields = new List<CustomFields>() {
                new CustomFields() {
                    Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    Name = "Training Completion Status",
                    Value = CustomFieldsValueUnion.CreateStr(
                        "Completed"
                    ),
                    ValueId = "value_456",
                    RemoteValueId = "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
                },
            },
        },
        Documents = new List<AtsDocumentsUploadRequestDto>() {
            new AtsDocumentsUploadRequestDto() {
                Name = "weather-forecast",
                FileFormat = new AtsDocumentsUploadRequestDtoFileFormat() {
                    Value = AtsDocumentsUploadRequestDtoFileFormatValue.Pdf,
                    SourceValue = AtsDocumentsUploadRequestDtoFileFormatSourceValueUnion.CreateStr(
                        "application/pdf"
                    ),
                },
                Content = "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
                CategoryId = "6530",
                Path = "/path/to/file",
                Confidential = new AtsDocumentsUploadRequestDtoConfidential() {
                    Value = AtsDocumentsUploadRequestDtoConfidentialValue.True,
                    SourceValue = AtsDocumentsUploadRequestDtoConfidentialSourceValueUnion.CreateStr(
                        "public"
                    ),
                },
                Category = null,
            },
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`AtsCreateApplicationRequestDto`	AtsCreateApplicationRequestDto	✔️	N/A
`Prefer`	string	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

AtsCreateApplicationResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

Update

Update Application

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Ats.Applications.UpdateAsync(
    xAccountId: "<id>",
    id: "<id>",
    atsUpdateApplicationRequestDto: new AtsUpdateApplicationRequestDto() {
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
        CustomFields = new List<CustomFields>() {
            new CustomFields() {
                Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                Name = "Training Completion Status",
                Value = CustomFieldsValueUnion.CreateStr(
                    "Completed"
                ),
                ValueId = "value_456",
                RemoteValueId = "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
            },
        },
        ApplicationStatus = new AtsUpdateApplicationRequestDtoApplicationStatus() {
            Value = AtsUpdateApplicationRequestDtoValue.Hired,
            SourceValue = AtsUpdateApplicationRequestDtoSourceValueUnion.CreateStr(
                "Hired"
            ),
        },
        Source = new AtsUpdateApplicationRequestDtoSource() {
            Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            Name = "LinkedIn",
        },
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`AtsUpdateApplicationRequestDto`	AtsUpdateApplicationRequestDto	✔️	N/A
`Prefer`	string	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

AtsUpdateApplicationResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListOffers

List Application Offers

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsListApplicationsOffersRequest req = new AtsListApplicationsOffersRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields",
    Filter = new AtsListApplicationsOffersFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

AtsListApplicationsOffersResponse? res = await sdk.Ats.Applications.ListOffersAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AtsListApplicationsOffersRequest	✔️	The request object to use for the request.

Response

AtsListApplicationsOffersResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

Move

Move Application

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Ats.Applications.MoveAsync(
    xAccountId: "<id>",
    id: "<id>",
    atsMoveApplicationRequestDto: new AtsMoveApplicationRequestDto() {
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
        InterviewStageId = "f223d7f6-908b-48f0-9237-b201c307f609",
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`AtsMoveApplicationRequestDto`	AtsMoveApplicationRequestDto	✔️	N/A
`Prefer`	string	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

AtsMoveApplicationResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

Reject

Reject Application

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using System.Collections.Generic;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Ats.Applications.RejectAsync(
    xAccountId: "<id>",
    id: "<id>",
    atsRejectApplicationRequestDto: new AtsRejectApplicationRequestDto() {
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
        RejectedReasonId = "f223d7f6-908b-48f0-9237-b201c307f609",
    },
    prefer: "heartbeat"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`XAccountId`	string	✔️	The account identifier
`Id`	string	✔️	N/A
`AtsRejectApplicationRequestDto`	AtsRejectApplicationRequestDto	✔️	N/A
`Prefer`	string	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

AtsRejectApplicationResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetOffer

Get Application Offer

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsGetApplicationOfferRequest req = new AtsGetApplicationOfferRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    SubResourceId = "<id>",
    Fields = "id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Ats.Applications.GetOfferAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AtsGetApplicationOfferRequest	✔️	The request object to use for the request.

Response

AtsGetApplicationOfferResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ScorecardsList

List Application Scorecards

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsListApplicationScorecardsRequest req = new AtsListApplicationScorecardsRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields",
    Filter = new AtsListApplicationScorecardsFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

AtsListApplicationScorecardsResponse? res = await sdk.Ats.Applications.ScorecardsListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AtsListApplicationScorecardsRequest	✔️	The request object to use for the request.

Response

AtsListApplicationScorecardsResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListScheduledInterviews

List Applications scheduled interviews

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;
using System;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsListApplicationsScheduledInterviewsRequest req = new AtsListApplicationsScheduledInterviewsRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields",
    Filter = new AtsListApplicationsScheduledInterviewsFilter() {
        UpdatedAfter = System.DateTime.Parse("2020-01-01T00:00:00.000Z"),
    },
    Prefer = "heartbeat",
};

AtsListApplicationsScheduledInterviewsResponse? res = await sdk.Ats.Applications.ListScheduledInterviewsAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AtsListApplicationsScheduledInterviewsRequest	✔️	The request object to use for the request.

Response

AtsListApplicationsScheduledInterviewsResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetScheduledInterview

Get Applications scheduled interview

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsGetApplicationScheduledInterviewRequest req = new AtsGetApplicationScheduledInterviewRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    SubResourceId = "<id>",
    Fields = "id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields",
    Prefer = "heartbeat",
};

var res = await sdk.Ats.Applications.GetScheduledInterviewAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AtsGetApplicationScheduledInterviewRequest	✔️	The request object to use for the request.

Response

AtsGetApplicationScheduledInterviewResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

DownloadDocument

Download Application Document

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsDownloadApplicationDocumentRequest req = new AtsDownloadApplicationDocumentRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    SubResourceId = "<id>",
    Format = "base64",
    ExportFormat = "text/plain",
    Prefer = "heartbeat",
};

var res = await sdk.Ats.Applications.DownloadDocumentAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AtsDownloadApplicationDocumentRequest	✔️	The request object to use for the request.

Response

AtsDownloadApplicationDocumentResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

ListCustomFieldDefinitions

List Application Custom Field Definitions

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsListApplicationCustomFieldDefinitionsRequest req = new AtsListApplicationCustomFieldDefinitionsRequest() {
    XAccountId = "<id>",
    Fields = "id,remote_id,name,description,type,options,unified_custom_fields",
    Filter = null,
    Prefer = "heartbeat",
};

AtsListApplicationCustomFieldDefinitionsResponse? res = await sdk.Ats.Applications.ListCustomFieldDefinitionsAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	AtsListApplicationCustomFieldDefinitionsRequest	✔️	The request object to use for the request.

Response

AtsListApplicationCustomFieldDefinitionsResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

GetCustomFieldDefinition

Get Application Custom Field Definition

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;
using StackOneHQ.Client.Models.Requests;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

AtsGetApplicationCustomFieldDefinitionRequest req = new AtsGetApplicationCustomFieldDefinitionRequest() {
    XAccountId = "<id>",
    Id = "<id>",
    Fields = "id,remote_id,name,description,type,options,unified_custom_fields",
    Filter = null,
    Prefer = "heartbeat",
};

var res = await sdk.Ats.Applications.GetCustomFieldDefinitionAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	AtsGetApplicationCustomFieldDefinitionRequest	✔️	The request object to use for the request.

Response

AtsGetApplicationCustomFieldDefinitionResponse

Errors

Error Type	Status Code	Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException	400	application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException	401	application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException	403	application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException	404	application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException	408	application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException	409	application/json
StackOneHQ.Client.Models.Errors.PreconditionFailedResponseException	412	application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException	422	application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException	429	application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse	500	application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException	501	application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException	502	application/json
StackOneHQ.Client.Models.Errors.APIException	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Ats.Applications

Overview

Available Operations

Create

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

ListOffers

Example Usage

Parameters

Response

Errors

Move

Example Usage

Parameters

Response

Errors

Reject

Example Usage

Parameters

Response

Errors

GetOffer

Example Usage

Parameters

Response

Errors

ScorecardsList

Example Usage

Parameters

Response

Errors

ListScheduledInterviews

Example Usage

Parameters

Response

Errors

GetScheduledInterview

Example Usage

Parameters

Response

Errors

DownloadDocument

Example Usage

Parameters

Response

Errors

ListCustomFieldDefinitions

Example Usage

Parameters

Response

Errors

GetCustomFieldDefinition

Example Usage

Parameters

Response

Errors