Skip to content

README.md

Latest commit

 

History

History
95 lines (78 loc) · 7.25 KB

README.md

File metadata and controls

95 lines (78 loc) · 7.25 KB

Hris.Employees.WorkEligibility

Overview

Available Operations

UpdateRequest

Update Employee Work Eligibility Request

Example Usage

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

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

HrisUpdateEmployeeWorkEligibilityRequestRequest req = new HrisUpdateEmployeeWorkEligibilityRequestRequest() {
    Id = "<id>",
    SubResourceId = "<id>",
    XAccountId = "<id>",
    Prefer = "heartbeat",
    HrisCreateWorkEligibilityRequestDto = new HrisCreateWorkEligibilityRequestDto() {
        Document = new HrisCreateWorkEligibilityRequestDtoDocument() {
            Id = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            RemoteId = "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            Name = "My Document",
            Category = new HrisCreateWorkEligibilityRequestDtoCategory() {},
            CategoryId = "6530",
            CreatedAt = System.DateTime.Parse("2021-01-01T01:01:01.000Z"),
            UpdatedAt = System.DateTime.Parse("2021-01-02T01:01:01.000Z"),
            RemoteUrl = "https://example.com/file.pdf",
            FileFormat = new HrisCreateWorkEligibilityRequestDtoFileFormat() {
                Value = HrisCreateWorkEligibilityRequestDtoDocumentValue.Pdf,
                SourceValue = HrisCreateWorkEligibilityRequestDtoFileFormatSourceValueUnion.CreateStr(
                    "application/pdf"
                ),
            },
        },
        IssuedBy = new HrisCreateWorkEligibilityRequestDtoIssuedBy() {
            Value = HrisCreateWorkEligibilityRequestDtoIssuedByValue.Us,
        },
        Number = "1234567890",
        SubType = "H1B",
        Type = new HrisCreateWorkEligibilityRequestDtoType() {},
        ValidFrom = System.DateTime.Parse("2021-01-01T00:00:00.000Z"),
        ValidTo = System.DateTime.Parse("2021-01-01T00:00:00.000Z"),
        Passthrough = new Dictionary<string, object>() {
            { "other_known_names", "John Doe" },
        },
    },
};

var res = await sdk.Hris.Employees.WorkEligibility.UpdateRequestAsync(req);

// handle response

Parameters

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

Response

HrisUpdateEmployeeWorkEligibilityRequestResponse

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 */*