POST api/Employer/UpdateSubscription

Request Information

URI Parameters

None.

Body Parameters

EmployerSubscriptionInput
NameDescriptionTypeAdditional information
Subscriptions

Collection of EmployerSubscriptionEnvelope

None.

APIToken

FieldDetailsString

None.

Request Formats

application/json, text/json

Sample:
{
  "subscriptions": [
    {
      "foreignDistrictID": {
        "value": "sample string 1",
        "field": "sample string 2"
      },
      "productId": {
        "value": 1,
        "field": "sample string 2"
      },
      "expirationDate": {
        "value": "2019-12-07T01:03:48.4732005-06:00",
        "field": "sample string 2"
      },
      "fee": {
        "value": 1,
        "field": "sample string 2"
      }
    },
    {
      "foreignDistrictID": {
        "value": "sample string 1",
        "field": "sample string 2"
      },
      "productId": {
        "value": 1,
        "field": "sample string 2"
      },
      "expirationDate": {
        "value": "2019-12-07T01:03:48.4732005-06:00",
        "field": "sample string 2"
      },
      "fee": {
        "value": 1,
        "field": "sample string 2"
      }
    }
  ],
  "apiToken": {
    "value": "sample string 1",
    "field": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<EmployerSubscriptionInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Employer">
  <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>
  <Subscriptions>
    <EmployerSubscriptionEnvelope>
      <ExpirationDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>2019-12-07T01:03:48.4732005-06:00</d4p1:Value>
      </ExpirationDate>
      <Fee xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>1</d4p1:Value>
      </Fee>
      <ForeignDistrictID xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>sample string 1</d4p1:Value>
      </ForeignDistrictID>
      <ProductId xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>1</d4p1:Value>
      </ProductId>
    </EmployerSubscriptionEnvelope>
    <EmployerSubscriptionEnvelope>
      <ExpirationDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>2019-12-07T01:03:48.4732005-06:00</d4p1:Value>
      </ExpirationDate>
      <Fee xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>1</d4p1:Value>
      </Fee>
      <ForeignDistrictID xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>sample string 1</d4p1:Value>
      </ForeignDistrictID>
      <ProductId xmlns:d4p1="http://schemas.datacontract.org/2004/07/APIService.Models.Error">
        <d4p1:Field>sample string 2</d4p1:Field>
        <d4p1:Value>1</d4p1:Value>
      </ProductId>
    </EmployerSubscriptionEnvelope>
  </Subscriptions>
</EmployerSubscriptionInput>

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>