POST api/CVParsing

Request Information

URI Parameters

None.

Body Parameters

ParseCVData
NameDescriptionTypeAdditional information
Field

string

None.

Base64DataUrl

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Field": "sample string 1",
  "Base64DataUrl": "sample string 2"
}

application/xml, text/xml

Sample:
<ParseCVData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrismAPI.Controllers">
  <Base64DataUrl>sample string 2</Base64DataUrl>
  <Field>sample string 1</Field>
</ParseCVData>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ParseCVData'.

Response Information

Resource Description

ParsedCV
NameDescriptionTypeAdditional information
FirstName

string

None.

MiddleName

string

None.

LastName

string

None.

Sex

Sex

None.

FormattedName

string

None.

Title

string

None.

Affix

string

None.

AddressLine1

string

None.

AddressLine2

string

None.

Town

string

None.

Region

string

None.

Postcode

string

None.

Country

string

None.

HomeTel

string

None.

OfficeTel

string

None.

MobileTel

string

None.

Email1

string

None.

Email2

string

None.

Objective

string

None.

ExecutiveSummary

string

None.

Dob

date

None.

DesiredSalaryAmount

decimal number

None.

DesiredSalaryPeriod

SalaryPeriod

None.

FullCVAsTxt

string

None.

Checksum

string

None.

EmploymentHistories

Collection of ParsedEmploymentHistory

None.

EducationHistories

Collection of ParsedEducationHistory

None.

Competencies

Collection of ParsedCompetency

None.

JobTitle

string

None.

Response Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "Sex": 161820000,
  "FormattedName": "sample string 4",
  "Title": "sample string 5",
  "Affix": "sample string 6",
  "AddressLine1": "sample string 7",
  "AddressLine2": "sample string 8",
  "Town": "sample string 9",
  "Region": "sample string 10",
  "Postcode": "sample string 11",
  "Country": "sample string 12",
  "HomeTel": "sample string 13",
  "OfficeTel": "sample string 14",
  "MobileTel": "sample string 15",
  "Email1": "sample string 16",
  "Email2": "sample string 17",
  "Objective": "sample string 18",
  "ExecutiveSummary": "sample string 19",
  "Dob": "2025-12-11T13:58:42.5055375+00:00",
  "DesiredSalaryAmount": 1.0,
  "DesiredSalaryPeriod": 161820000,
  "FullCVAsTxt": "sample string 20",
  "Checksum": "sample string 21",
  "EmploymentHistories": [
    {
      "Id": "11b7a404-cc8b-4960-b198-a028e0b4e2dc",
      "Name": "sample string 2",
      "JobTitle": "sample string 3",
      "OrgName": "sample string 4",
      "JobType": 161820000,
      "Description": "sample string 5",
      "AddressLine1": "sample string 6",
      "AddressLine2": "sample string 7",
      "Town": "sample string 8",
      "Region": "sample string 9",
      "Postcode": "sample string 10",
      "Country": "sample string 11",
      "StartDate": "2025-12-11T13:58:42.5055375+00:00",
      "EndDate": "2025-12-11T13:58:42.5055375+00:00",
      "CvId": "e44ba981-fc3f-40b2-904b-895cf976d9e4"
    },
    {
      "Id": "11b7a404-cc8b-4960-b198-a028e0b4e2dc",
      "Name": "sample string 2",
      "JobTitle": "sample string 3",
      "OrgName": "sample string 4",
      "JobType": 161820000,
      "Description": "sample string 5",
      "AddressLine1": "sample string 6",
      "AddressLine2": "sample string 7",
      "Town": "sample string 8",
      "Region": "sample string 9",
      "Postcode": "sample string 10",
      "Country": "sample string 11",
      "StartDate": "2025-12-11T13:58:42.5055375+00:00",
      "EndDate": "2025-12-11T13:58:42.5055375+00:00",
      "CvId": "e44ba981-fc3f-40b2-904b-895cf976d9e4"
    }
  ],
  "EducationHistories": [
    {
      "Name": "sample string 1",
      "DegreeType": "sample string 2",
      "MajorSubject": "sample string 3",
      "Comment": "sample string 4",
      "StartDate": "2025-12-11T13:58:42.5055375+00:00",
      "EndDate": "2025-12-11T13:58:42.5055375+00:00",
      "CvId": "6dc92084-a719-4e30-97c6-a6bdaf2058ed",
      "Id": "a739f296-666f-43fe-b17c-3b0bcca53b3f"
    },
    {
      "Name": "sample string 1",
      "DegreeType": "sample string 2",
      "MajorSubject": "sample string 3",
      "Comment": "sample string 4",
      "StartDate": "2025-12-11T13:58:42.5055375+00:00",
      "EndDate": "2025-12-11T13:58:42.5055375+00:00",
      "CvId": "6dc92084-a719-4e30-97c6-a6bdaf2058ed",
      "Id": "a739f296-666f-43fe-b17c-3b0bcca53b3f"
    }
  ],
  "Competencies": [
    {
      "Name": "sample string 1",
      "FormattedName": "sample string 2",
      "Type": 161820000,
      "Description": "sample string 3",
      "SkillLevel": 1,
      "Proficiency": 161820000,
      "Evidence": [
        {
          "Name": "sample string 1",
          "EvidenceType": 161820000,
          "ExtentType": 161820000,
          "ExtentValue": 1.1,
          "ExtentModifier": 161820000
        },
        {
          "Name": "sample string 1",
          "EvidenceType": 161820000,
          "ExtentType": 161820000,
          "ExtentValue": 1.1,
          "ExtentModifier": 161820000
        }
      ],
      "CvId": "62064afb-59f8-41a3-b896-fa60a8041ace",
      "Id": "acea95e2-772d-4dc7-97d7-40ce719b66c1"
    },
    {
      "Name": "sample string 1",
      "FormattedName": "sample string 2",
      "Type": 161820000,
      "Description": "sample string 3",
      "SkillLevel": 1,
      "Proficiency": 161820000,
      "Evidence": [
        {
          "Name": "sample string 1",
          "EvidenceType": 161820000,
          "ExtentType": 161820000,
          "ExtentValue": 1.1,
          "ExtentModifier": 161820000
        },
        {
          "Name": "sample string 1",
          "EvidenceType": 161820000,
          "ExtentType": 161820000,
          "ExtentValue": 1.1,
          "ExtentModifier": 161820000
        }
      ],
      "CvId": "62064afb-59f8-41a3-b896-fa60a8041ace",
      "Id": "acea95e2-772d-4dc7-97d7-40ce719b66c1"
    }
  ],
  "JobTitle": "sample string 22"
}

application/xml, text/xml

Sample:
<ParsedCV xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrismAPI.Code">
  <AddressLine1>sample string 7</AddressLine1>
  <AddressLine2>sample string 8</AddressLine2>
  <Affix>sample string 6</Affix>
  <Checksum>sample string 21</Checksum>
  <Competencies>
    <ParsedCompetency>
      <CvId>62064afb-59f8-41a3-b896-fa60a8041ace</CvId>
      <Description>sample string 3</Description>
      <Evidence>
        <ParsedCompetencyEvidence>
          <EvidenceType>ExtentofExperience</EvidenceType>
          <ExtentModifier>Greater</ExtentModifier>
          <ExtentType>Year</ExtentType>
          <ExtentValue>1.1</ExtentValue>
          <Name>sample string 1</Name>
        </ParsedCompetencyEvidence>
        <ParsedCompetencyEvidence>
          <EvidenceType>ExtentofExperience</EvidenceType>
          <ExtentModifier>Greater</ExtentModifier>
          <ExtentType>Year</ExtentType>
          <ExtentValue>1.1</ExtentValue>
          <Name>sample string 1</Name>
        </ParsedCompetencyEvidence>
      </Evidence>
      <FormattedName>sample string 2</FormattedName>
      <Id>acea95e2-772d-4dc7-97d7-40ce719b66c1</Id>
      <Name>sample string 1</Name>
      <Proficiency>Good</Proficiency>
      <SkillLevel>1</SkillLevel>
      <Type>Qualification</Type>
    </ParsedCompetency>
    <ParsedCompetency>
      <CvId>62064afb-59f8-41a3-b896-fa60a8041ace</CvId>
      <Description>sample string 3</Description>
      <Evidence>
        <ParsedCompetencyEvidence>
          <EvidenceType>ExtentofExperience</EvidenceType>
          <ExtentModifier>Greater</ExtentModifier>
          <ExtentType>Year</ExtentType>
          <ExtentValue>1.1</ExtentValue>
          <Name>sample string 1</Name>
        </ParsedCompetencyEvidence>
        <ParsedCompetencyEvidence>
          <EvidenceType>ExtentofExperience</EvidenceType>
          <ExtentModifier>Greater</ExtentModifier>
          <ExtentType>Year</ExtentType>
          <ExtentValue>1.1</ExtentValue>
          <Name>sample string 1</Name>
        </ParsedCompetencyEvidence>
      </Evidence>
      <FormattedName>sample string 2</FormattedName>
      <Id>acea95e2-772d-4dc7-97d7-40ce719b66c1</Id>
      <Name>sample string 1</Name>
      <Proficiency>Good</Proficiency>
      <SkillLevel>1</SkillLevel>
      <Type>Qualification</Type>
    </ParsedCompetency>
  </Competencies>
  <Country>sample string 12</Country>
  <DesiredSalaryAmount>1</DesiredSalaryAmount>
  <DesiredSalaryPeriod>Hour</DesiredSalaryPeriod>
  <Dob>2025-12-11T13:58:42.5055375+00:00</Dob>
  <EducationHistories>
    <ParsedEducationHistory>
      <Comment>sample string 4</Comment>
      <CvId>6dc92084-a719-4e30-97c6-a6bdaf2058ed</CvId>
      <DegreeType>sample string 2</DegreeType>
      <EndDate>2025-12-11T13:58:42.5055375+00:00</EndDate>
      <Id>a739f296-666f-43fe-b17c-3b0bcca53b3f</Id>
      <MajorSubject>sample string 3</MajorSubject>
      <Name>sample string 1</Name>
      <StartDate>2025-12-11T13:58:42.5055375+00:00</StartDate>
    </ParsedEducationHistory>
    <ParsedEducationHistory>
      <Comment>sample string 4</Comment>
      <CvId>6dc92084-a719-4e30-97c6-a6bdaf2058ed</CvId>
      <DegreeType>sample string 2</DegreeType>
      <EndDate>2025-12-11T13:58:42.5055375+00:00</EndDate>
      <Id>a739f296-666f-43fe-b17c-3b0bcca53b3f</Id>
      <MajorSubject>sample string 3</MajorSubject>
      <Name>sample string 1</Name>
      <StartDate>2025-12-11T13:58:42.5055375+00:00</StartDate>
    </ParsedEducationHistory>
  </EducationHistories>
  <Email1>sample string 16</Email1>
  <Email2>sample string 17</Email2>
  <EmploymentHistories>
    <ParsedEmploymentHistory>
      <AddressLine1>sample string 6</AddressLine1>
      <AddressLine2>sample string 7</AddressLine2>
      <Country>sample string 11</Country>
      <CvId>e44ba981-fc3f-40b2-904b-895cf976d9e4</CvId>
      <Description>sample string 5</Description>
      <EndDate>2025-12-11T13:58:42.5055375+00:00</EndDate>
      <Id>11b7a404-cc8b-4960-b198-a028e0b4e2dc</Id>
      <JobTitle>sample string 3</JobTitle>
      <JobType>Permanent</JobType>
      <Name>sample string 2</Name>
      <OrgName>sample string 4</OrgName>
      <Postcode>sample string 10</Postcode>
      <Region>sample string 9</Region>
      <StartDate>2025-12-11T13:58:42.5055375+00:00</StartDate>
      <Town>sample string 8</Town>
    </ParsedEmploymentHistory>
    <ParsedEmploymentHistory>
      <AddressLine1>sample string 6</AddressLine1>
      <AddressLine2>sample string 7</AddressLine2>
      <Country>sample string 11</Country>
      <CvId>e44ba981-fc3f-40b2-904b-895cf976d9e4</CvId>
      <Description>sample string 5</Description>
      <EndDate>2025-12-11T13:58:42.5055375+00:00</EndDate>
      <Id>11b7a404-cc8b-4960-b198-a028e0b4e2dc</Id>
      <JobTitle>sample string 3</JobTitle>
      <JobType>Permanent</JobType>
      <Name>sample string 2</Name>
      <OrgName>sample string 4</OrgName>
      <Postcode>sample string 10</Postcode>
      <Region>sample string 9</Region>
      <StartDate>2025-12-11T13:58:42.5055375+00:00</StartDate>
      <Town>sample string 8</Town>
    </ParsedEmploymentHistory>
  </EmploymentHistories>
  <ExecutiveSummary>sample string 19</ExecutiveSummary>
  <FirstName>sample string 1</FirstName>
  <FormattedName>sample string 4</FormattedName>
  <FullCVAsTxt>sample string 20</FullCVAsTxt>
  <HomeTel>sample string 13</HomeTel>
  <JobTitle>sample string 22</JobTitle>
  <LastName>sample string 3</LastName>
  <MiddleName>sample string 2</MiddleName>
  <MobileTel>sample string 15</MobileTel>
  <Objective>sample string 18</Objective>
  <OfficeTel>sample string 14</OfficeTel>
  <Postcode>sample string 11</Postcode>
  <Region>sample string 10</Region>
  <Sex>Male</Sex>
  <Title>sample string 5</Title>
  <Town>sample string 9</Town>
</ParsedCV>