Class FormatResumeWithTemplateRequest
Request body for the Format Resume With Template endpoint
Inheritance
Inherited Members
Namespace: Textkernel.Tx.Models.API.Formatter
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class FormatResumeWithTemplateRequest
Constructors
| Improve this Doc View SourceFormatResumeWithTemplateRequest(ParsedResume, Byte[], ResumeType)
Creates a request to call the Resume Formatter endpoint with a provided template document.
Declaration
public FormatResumeWithTemplateRequest(ParsedResume resume, byte[] templateFileBytes, ResumeType docType)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The ResumeData from a parse API call |
System.Byte[] | templateFileBytes | The bytes of the template DOCX file |
ResumeType | docType | The output document type |
FormatResumeWithTemplateRequest(ParsedResume, String, ResumeType)
Creates a request to call the Resume Formatter endpoint with a provided template document.
Declaration
public FormatResumeWithTemplateRequest(ParsedResume resume, string templatePath, ResumeType docType)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The ResumeData from a parse API call |
System.String | templatePath | The path to the template DOCX file on disk |
ResumeType | docType | The output document type |
Properties
| Improve this Doc View SourceCustomData
Any data that the template needs that is not in the extracted CV data. For example:
CustomData = new
{
CandidateId = "12345",
DateApplied = DateTime.Today
}
Declaration
public object CustomData { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
OutputType
The output document type
Declaration
[JsonConverter(typeof(JsonStringEnumConverter))]
public ResumeType OutputType { get; set; }
Property Value
Type | Description |
---|---|
ResumeType |
ResumeData
The ResumeData from a parse API call
Declaration
public ParsedResume ResumeData { get; set; }
Property Value
Type | Description |
---|---|
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 System.Convert.ToBase64String(System.Byte[]) method. For more information on creating custom templates, see here.
Declaration
public string Template { get; set; }
Property Value
Type | Description |
---|---|
System.String |