POST api/RegisterEmployer/RegisterEmployer

Request Information

URI Parameters

None.

Body Parameters

EmployerInput
NameDescriptionTypeAdditional information
PortalUrl

FieldDetailsString

None.

UserName

FieldDetailsString

None.

Password

FieldDetailsString

None.

ConfirmPassword

FieldDetailsString

None.

SecurityQuestionId

FieldDetailsInt

None.

SecurityAnswer

FieldDetailsString

None.

FirstName

FieldDetailsString

None.

LastName

FieldDetailsString

None.

Email

FieldDetailsString

None.

JobTitle

FieldDetailsString

None.

PhoneNumber

FieldDetailsString

None.

TimeZoneId

FieldDetailsInt

None.

ShowBilling

FieldDetailsBool

None.

BillingMethodId

FieldDetailsInt

None.

BillingContactSameAsPrimary

FieldDetailsBool

None.

BillingFirstName

FieldDetailsString

None.

BillingLastName

FieldDetailsString

None.

BillingEmail

FieldDetailsString

None.

BillingPhoneNumber

FieldDetailsString

None.

EmployerName

FieldDetailsString

None.

EmployerCountryId

FieldDetailsInt

None.

EmployerStreetAddress

FieldDetailsString

None.

EmployerStreetAddress2

FieldDetailsString

None.

EmployerZipCode

FieldDetailsString

None.

EmployerCity

FieldDetailsString

None.

EmployerState

FieldDetailsString

None.

EmployerWebsite

FieldDetailsString

None.

EmployerTypeId

FieldDetailsInt

None.

EmployerCommunityRural

FieldDetailsBool

None.

EmployerCommunitySuburban

FieldDetailsBool

None.

EmployerCommunityUrban

FieldDetailsBool

None.

EmployerNumberOfShools

FieldDetailsInt

None.

EmployerNumberOfStudents

FieldDetailsInt

None.

PrivacyPolicy

FieldDetailsBool

None.

APIToken

FieldDetailsString

None.

ForeignDistrictID

FieldDetailsString

None.

ForeignLocationID

FieldDetailsString

None.

ProductId

FieldDetailsInt

None.

Request Formats

application/json, text/json

Sample:
{
  "portalUrl": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "userName": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "password": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "confirmPassword": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "securityQuestionId": {
    "value": 1,
    "field": "sample string 2"
  },
  "securityAnswer": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "firstName": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "lastName": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "email": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "jobTitle": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "phoneNumber": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "timeZoneId": {
    "value": 1,
    "field": "sample string 2"
  },
  "showBilling": {
    "value": true,
    "field": "sample string 2"
  },
  "billingMethodId": {
    "value": 1,
    "field": "sample string 2"
  },
  "billingContactSameAsPrimary": {
    "value": true,
    "field": "sample string 2"
  },
  "billingFirstName": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "billingLastName": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "billingEmail": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "billingPhoneNumber": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerName": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerCountryId": {
    "value": 1,
    "field": "sample string 2"
  },
  "employerStreetAddress": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerStreetAddress2": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerZipCode": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerCity": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerState": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerWebsite": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "employerTypeId": {
    "value": 1,
    "field": "sample string 2"
  },
  "employerCommunityRural": {
    "value": true,
    "field": "sample string 2"
  },
  "employerCommunitySuburban": {
    "value": true,
    "field": "sample string 2"
  },
  "employerCommunityUrban": {
    "value": true,
    "field": "sample string 2"
  },
  "employerNumberOfShools": {
    "value": 1,
    "field": "sample string 2"
  },
  "employerNumberOfStudents": {
    "value": 1,
    "field": "sample string 2"
  },
  "privacyPolicy": {
    "value": true,
    "field": "sample string 2"
  },
  "apiToken": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "foreignDistrictID": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "foreignLocationID": {
    "value": "sample string 1",
    "field": "sample string 2"
  },
  "productId": {
    "value": 1,
    "field": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<EmployerInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.Public">
  <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>
  <BillingContactSameAsPrimary xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </BillingContactSameAsPrimary>
  <BillingEmail 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>
  </BillingEmail>
  <BillingFirstName 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>
  </BillingFirstName>
  <BillingLastName 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>
  </BillingLastName>
  <BillingMethodId xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </BillingMethodId>
  <BillingPhoneNumber 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>
  </BillingPhoneNumber>
  <ConfirmPassword 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>
  </ConfirmPassword>
  <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>
  <EmployerCity 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>
  </EmployerCity>
  <EmployerCommunityRural xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </EmployerCommunityRural>
  <EmployerCommunitySuburban xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </EmployerCommunitySuburban>
  <EmployerCommunityUrban xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </EmployerCommunityUrban>
  <EmployerCountryId xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </EmployerCountryId>
  <EmployerName 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>
  </EmployerName>
  <EmployerNumberOfShools xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </EmployerNumberOfShools>
  <EmployerNumberOfStudents xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </EmployerNumberOfStudents>
  <EmployerState 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>
  </EmployerState>
  <EmployerStreetAddress 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>
  </EmployerStreetAddress>
  <EmployerStreetAddress2 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>
  </EmployerStreetAddress2>
  <EmployerTypeId xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </EmployerTypeId>
  <EmployerWebsite 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>
  </EmployerWebsite>
  <EmployerZipCode 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>
  </EmployerZipCode>
  <FirstName 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>
  </FirstName>
  <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>
  <JobTitle 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>
  </JobTitle>
  <LastName 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>
  </LastName>
  <Password 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>
  </Password>
  <PhoneNumber 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>
  </PhoneNumber>
  <PortalUrl 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>
  </PortalUrl>
  <PrivacyPolicy xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </PrivacyPolicy>
  <ProductId xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </ProductId>
  <SecurityAnswer 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>
  </SecurityAnswer>
  <SecurityQuestionId xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </SecurityQuestionId>
  <ShowBilling xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>true</d2p1:Value>
  </ShowBilling>
  <TimeZoneId xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
    <d2p1:Field>sample string 2</d2p1:Field>
    <d2p1:Value>1</d2p1:Value>
  </TimeZoneId>
  <UserName 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>
  </UserName>
</EmployerInput>

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>