POST api/Employer/Location/Create

Request Information

URI Parameters

None.

Body Parameters

LocationInput
NameDescriptionTypeAdditional information
Name

FieldDetailsString

None.

CountryId

FieldDetailsInt

None.

StreetAddress

FieldDetailsString

None.

StreetAddress2

FieldDetailsString

None.

ZipCode

FieldDetailsString

None.

City

FieldDetailsString

None.

State

FieldDetailsString

None.

NeighborhoodTypeID

FieldDetailsInt

None.

WebSite

FieldDetailsString

None.

IsPrimaryLocation

FieldDetailsBool

None.

ForeignDistrictID

FieldDetailsString

None.

ForeignLocationID

FieldDetailsString

None.

APIToken

FieldDetailsString

None.

Request Formats

application/json, text/json

Sample:
{
  "name": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "countryId": {
    "value": 1,
    "field": "sample string 2"
  },
  "streetAddress": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "streetAddress2": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "zipCode": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "city": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "state": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "neighborhoodTypeID": {
    "value": 1,
    "field": "sample string 2"
  },
  "webSite": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "isPrimaryLocation": {
    "value": true,
    "field": "sample string 2"
  },
  "foreignDistrictID": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "foreignLocationID": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "apiToken": {
    "value": "sample string 1",
    "field": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<LocationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Employer.Location">
  <APIToken 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>
  </APIToken>
  <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>
  <ForeignDistrictID 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>
  </ForeignDistrictID>
  <ForeignLocationID 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>
  </ForeignLocationID>
  <IsPrimaryLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </IsPrimaryLocation>
  <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>
  <NeighborhoodTypeID xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </NeighborhoodTypeID>
  <State 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>
  </State>
  <StreetAddress 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>
  </StreetAddress>
  <StreetAddress2 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>
  </StreetAddress2>
  <WebSite 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>
  </WebSite>
  <ZipCode 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>
  </ZipCode>
</LocationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FormSubmitOutput
NameDescriptionTypeAdditional information
Errors

Collection of FieldError

None.

ApiErrorMessage

string

None.

Success

boolean

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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