POST api/JobSeeker/Profile/SaveReference

Request Information

URI Parameters

None.

Body Parameters

ReferencesInput
NameDescriptionTypeAdditional information
ID

FieldDetailsInt

None.

Name

FieldDetailsString

None.

RelationshipID

FieldDetailsInt

None.

Organization

FieldDetailsString

None.

PositionTitle

FieldDetailsString

None.

CountryID

FieldDetailsInt

None.

Address1

FieldDetailsString

None.

Address2

FieldDetailsString

None.

City

FieldDetailsString

None.

StateID

FieldDetailsInt

None.

Region

FieldDetailsString

None.

ZIP

FieldDetailsString

None.

Email

FieldDetailsString

None.

Phone

FieldDetailsString

None.

Extension

FieldDetailsString

None.

Document

FieldDetailsInt

None.

VisibleToEmployers

FieldDetailsBool

None.

EmployerMayContact

FieldDetailsBool

None.

OrderNum

FieldDetailsInt

None.

Request Formats

application/json, text/json

Sample:
{
  "id": {
    "value": 1,
    "field": "sample string 2"
  },
  "name": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "relationshipID": {
    "value": 1,
    "field": "sample string 2"
  },
  "organization": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "positionTitle": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "countryID": {
    "value": 1,
    "field": "sample string 2"
  },
  "address1": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "address2": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "city": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "stateID": {
    "value": 1,
    "field": "sample string 2"
  },
  "region": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "zip": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "email": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "phone": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "extension": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "document": {
    "value": 1,
    "field": "sample string 2"
  },
  "visibleToEmployers": {
    "value": true,
    "field": "sample string 2"
  },
  "employerMayContact": {
    "value": true,
    "field": "sample string 2"
  },
  "orderNum": {
    "value": 1,
    "field": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ReferencesInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.JobSeeker">
  <Address1 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>
  </Address1>
  <Address2 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>
  </Address2>
  <City 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>
  </City>
  <CountryID xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </CountryID>
  <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>
  <Email 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>
  </Email>
  <EmployerMayContact xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </EmployerMayContact>
  <Extension 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>
  </Extension>
  <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>
  <Name 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>
  </Name>
  <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>
  <Phone 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>
  </Phone>
  <PositionTitle 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>
  </PositionTitle>
  <Region 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>
  </Region>
  <RelationshipID xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </RelationshipID>
  <StateID xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </StateID>
  <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>
  <ZIP 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>
  </ZIP>
</ReferencesInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JobSeekerProfileFormOutput
NameDescriptionTypeAdditional information
results

FormSubmitOutput

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "results": {
    "errors": [
      {
        "field": "sample string 1",
        "message": "sample string 2"
      },
      {
        "field": "sample string 1",
        "message": "sample string 2"
      }
    ],
    "apiErrorMessage": "sample string 1",
    "success": false
  },
  "id": 1
}

application/xml, text/xml

Sample:
<JobSeekerProfileFormOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.JobSeeker">
  <Id>1</Id>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:ApiErrorMessage>sample string 1</d2p1:ApiErrorMessage>
    <d2p1:Errors>
      <d2p1:FieldError>
        <d2p1:Field>sample string 1</d2p1:Field>
        <d2p1:Message>sample string 2</d2p1:Message>
      </d2p1:FieldError>
      <d2p1:FieldError>
        <d2p1:Field>sample string 1</d2p1:Field>
        <d2p1:Message>sample string 2</d2p1:Message>
      </d2p1:FieldError>
    </d2p1:Errors>
  </results>
</JobSeekerProfileFormOutput>