Class FormatResumeWithTemplateRequest

Namespace

Textkernel.Tx.Models.API.Formatter

Assembly

Textkernel.Tx.SDK.dll

Request body for the Format Resume With Template endpoint

public class FormatResumeWithTemplateRequest

Inheritance

object

FormatResumeWithTemplateRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FormatResumeWithTemplateRequest(ParsedResume, byte[], ResumeType)

Creates a request to call the Resume Formatter endpoint with a provided template document.

public FormatResumeWithTemplateRequest(ParsedResume resume, byte[] templateFileBytes, ResumeType docType)

Parameters

resume ParsedResume

The ResumeData from a parse API call

templateFileBytes byte[]

The bytes of the template DOCX file

docType ResumeType

The output document type

FormatResumeWithTemplateRequest(ParsedResume, string, ResumeType)

Creates a request to call the Resume Formatter endpoint with a provided template document.

public FormatResumeWithTemplateRequest(ParsedResume resume, string templatePath, ResumeType docType)

Parameters

resume ParsedResume

The ResumeData from a parse API call

templatePath string

The path to the template DOCX file on disk

docType ResumeType

The output document type

Properties

CustomData

Any data that the template needs that is not in the extracted CV data. For example:

CustomData = new 
{
    CandidateId = "12345",
    DateApplied = DateTime.Today
}

public object CustomData { get; set; }

Property Value

object

OutputType

The output document type

[JsonConverter(typeof(JsonStringEnumConverter))]
public ResumeType OutputType { get; set; }

Property Value

ResumeType

ResumeData

The ResumeData from a parse API call

public ParsedResume ResumeData { get; set; }

Property Value

ParsedResume

Template

A base64-encoded string of the DOCX template document file bytes. This should use the standard 'base64' encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant). .NET users can use the ToBase64String(byte[]) method. For more information on creating custom templates, see here.

public string Template { get; set; }

Property Value

string