PUT Api/Applicant/Certificate/{applicantId}

Creates a new certificate for a specific applicant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicantId

The ID of the applicant.

integer

Required

Body Parameters

The certificate to create.

ApplicantCertificateParameter
NameDescriptionTypeAdditional information
Name

string

None.

Type

string

None.

Start

FlexDate

None.

End

FlexDate

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Type": "sample string 2",
  "Start": {
    "Year": 1,
    "Month": 1,
    "Day": 1,
    "IsRelativeDate": true,
    "IsValid": false,
    "IsEmpty": false
  },
  "End": {
    "Year": 1,
    "Month": 1,
    "Day": 1,
    "IsRelativeDate": true,
    "IsValid": false,
    "IsEmpty": false
  }
}

application/xml, text/xml

Sample:
<ApplicantCertificateParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <End xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api">
    <d2p1:Day>1</d2p1:Day>
    <d2p1:IsRelativeDate>true</d2p1:IsRelativeDate>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:Year>1</d2p1:Year>
  </End>
  <Name>sample string 1</Name>
  <Start xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api">
    <d2p1:Day>1</d2p1:Day>
    <d2p1:IsRelativeDate>true</d2p1:IsRelativeDate>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:Year>1</d2p1:Year>
  </Start>
  <Type>sample string 2</Type>
</ApplicantCertificateParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The newly created applicant certificate.

ApplicantCertificateResponse
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Type

string

None.

Start

FlexDate

None.

End

FlexDate

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Type": "sample string 3",
  "Start": {
    "Year": 1,
    "Month": 1,
    "Day": 1,
    "IsRelativeDate": true,
    "IsValid": false,
    "IsEmpty": false
  },
  "End": {
    "Year": 1,
    "Month": 1,
    "Day": 1,
    "IsRelativeDate": true,
    "IsValid": false,
    "IsEmpty": false
  }
}

application/xml, text/xml

Sample:
<ApplicantCertificateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <End xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:Day>1</d2p1:Day>
    <d2p1:IsRelativeDate>true</d2p1:IsRelativeDate>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:Year>1</d2p1:Year>
  </End>
  <Name xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 2</Name>
  <Start xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:Day>1</d2p1:Day>
    <d2p1:IsRelativeDate>true</d2p1:IsRelativeDate>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:Year>1</d2p1:Year>
  </Start>
  <Type xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 3</Type>
  <Id>1</Id>
</ApplicantCertificateResponse>