PUT api/AutomaticOnBoarding/Activation

Perform the activation of the specified services with the corresponding service parameters.

Request Information

URI Parameters

None.

Body Parameters

ActivateRequest
NameDescriptionTypeAdditional information
AgencyId

integer

Required

Services

Collection of ActivationServiceRequest

Required

Request Formats

application/json, text/json

Sample:
{
  "AgencyId": 1,
  "Services": [
    {
      "ServiceName": "sample string 1",
      "Parameters": [
        {
          "Key": "sample string 1",
          "Value": {}
        },
        {
          "Key": "sample string 1",
          "Value": {}
        }
      ]
    },
    {
      "ServiceName": "sample string 1",
      "Parameters": [
        {
          "Key": "sample string 1",
          "Value": {}
        },
        {
          "Key": "sample string 1",
          "Value": {}
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<ActivateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutomaticOnboarding.Models">
  <AgencyId>1</AgencyId>
  <Services>
    <ActivationServiceRequest>
      <Parameters xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:KeyValuePairOfstringanyType>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value />
        </d4p1:KeyValuePairOfstringanyType>
        <d4p1:KeyValuePairOfstringanyType>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value />
        </d4p1:KeyValuePairOfstringanyType>
      </Parameters>
      <ServiceName>sample string 1</ServiceName>
    </ActivationServiceRequest>
    <ActivationServiceRequest>
      <Parameters xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:KeyValuePairOfstringanyType>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value />
        </d4p1:KeyValuePairOfstringanyType>
        <d4p1:KeyValuePairOfstringanyType>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value />
        </d4p1:KeyValuePairOfstringanyType>
      </Parameters>
      <ServiceName>sample string 1</ServiceName>
    </ActivationServiceRequest>
  </Services>
</ActivateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActivationResponse
NameDescriptionTypeAdditional information
Responses

Collection of ActivationServiceResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Responses": [
    {
      "agencyId": 1,
      "serviceName": "sample string 2",
      "accepted": true
    },
    {
      "agencyId": 1,
      "serviceName": "sample string 2",
      "accepted": true
    }
  ]
}

application/xml, text/xml

Sample:
<ActivationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutomaticOnboarding.Models">
  <Responses>
    <ActivationServiceResponse>
      <Accepted>true</Accepted>
      <AgencyId>1</AgencyId>
      <ServiceName>sample string 2</ServiceName>
    </ActivationServiceResponse>
    <ActivationServiceResponse>
      <Accepted>true</Accepted>
      <AgencyId>1</AgencyId>
      <ServiceName>sample string 2</ServiceName>
    </ActivationServiceResponse>
  </Responses>
</ActivationResponse>