POST api/JobSeeker/Profile/DeleteAwardsHonors

Request Information

URI Parameters

None.

Body Parameters

AwardsHonorsInput
NameDescriptionTypeAdditional information
ID

FieldDetailsInt

None.

Organization

FieldDetailsString

None.

AwardHonor

FieldDetailsString

None.

Date

FieldDetailsDate

None.

Document

FieldDetailsInt

None.

VisibleToEmployers

FieldDetailsBool

None.

OrderNum

FieldDetailsInt

None.

Request Formats

application/json, text/json

Sample:
{
  "id": {
    "value": 1,
    "field": "sample string 2"
  },
  "organization": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "awardHonor": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "date": {
    "value": "2023-05-30T19:25:13.2239066-05:00",
    "field": "sample string 2"
  },
  "document": {
    "value": 1,
    "field": "sample string 2"
  },
  "visibleToEmployers": {
    "value": true,
    "field": "sample string 2"
  },
  "orderNum": {
    "value": 1,
    "field": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<AwardsHonorsInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.JobSeeker">
  <AwardHonor xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>sample string 1</d2p1:Value>
  </AwardHonor>
  <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>2023-05-30T19:25:13.2239066-05:00</d2p1:Value>
  </Date>
  <Document xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </Document>
  <ID xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </ID>
  <OrderNum xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </OrderNum>
  <Organization xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>sample string 1</d2p1:Value>
  </Organization>
  <VisibleToEmployers xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </VisibleToEmployers>
</AwardsHonorsInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProfileOutput
NameDescriptionTypeAdditional information
FailMessage

string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "failMessage": "sample string 1",
  "success": true
}

application/xml, text/xml

Sample:
<ProfileOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.JobSeeker">
  <FailMessage>sample string 1</FailMessage>
  <Success>true</Success>
</ProfileOutput>