POST v1/accounts/{foreignaccountkey}/networks/{foreignkey}/datacontrol/groups

Create a new data control group on the network. The group name can then be used to set membership for APNDevices by setting their DataControlGroup property<br/> The Group has the following properties:-<br/> 1) ApnNetworkBlackList. This can hold a list of MCC &amp; MNC pairs from which devices belonging to thsi group caqnnot connect<br/> 2) DefaultAccessPolicy. This contains the default access policy to be applied toa device<br/> 3) TimeofDayPolicy. This can contains a list of times when devices may not connect. By default devices can connect at anytime.<br/> 4) LinkedDomainFilterPloicy. This can contain the name of a Domain filter policy to be applied be default.<br/> 5) DefaultZone. This specifies the name of a zone to use when a device's MCC &amp; MNC pair are not part of any predefined zone.<br/> 6) UnknownZone. This specifies the name of a zone to use when a device presents no MCC &amp; MNC pair at session start.<br/> Note that is endpoint returns a 202 code as the request is queued. A status url is returned in the return meta-data that can be used to poll the status of this request. When the Group is created successfully on the Asavie network it's Status property will be set as 'complete'

Request Information

URI Parameters

NameDescriptionTypeAdditional information
foreignaccountkey

The Api Account to use

string

Required

foreignkey

The network on the account to use

string

Required

Body Parameters

The details of the new group

DataControlGroup
NameDescriptionTypeAdditional information
Name

The unique name for the data control group

string

None.

Enabled

Gets and sets whether the group is enabled on the Passbridge core. If disabled then no devices in the group can connect

boolean

None.

ApnNetworkBlackList

Gets and sets a blacklist of MCC/MNC pairs from which devices will not be allowed to connect to the Passbridge core.

Collection of ApnNetworkEntry

None.

ApnNetworkWhiteList

Collection of ApnNetworkEntry

None.

DefaultAccessPolicy

Gets and sets the default policy for the group.

DataControlAccessPolicy

None.

TimeOfDayPolicy

Gets and sets the time based access policy for devices in the group

TimeOfDayPolicy

None.

DefaultZone

Gets and sets the default zone for the group. This is used when a device connects but not from and pre-defined zone

string

None.

UnknownZone

Gets and sets the unknown zone. This is used when a device connected without presenting and MNC/MCC

string

None.

LinkedDomainFilterPolicy

Gets and sets the link to a domain filter policy. if domain filtering is required then the group is linked to a Domain filter policy here

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Enabled": true,
  "ApnNetworkBlackList": [
    {
      "MCC": "sample string 1",
      "MNC": "sample string 2"
    },
    {
      "MCC": "sample string 1",
      "MNC": "sample string 2"
    }
  ],
  "ApnNetworkWhiteList": [
    {
      "MCC": "sample string 1",
      "MNC": "sample string 2"
    },
    {
      "MCC": "sample string 1",
      "MNC": "sample string 2"
    }
  ],
  "DefaultAccessPolicy": {
    "Enabled": true,
    "AccessRate": 2,
    "UpstreamFirewall": "sample string 3",
    "DownstreamFirewall": "sample string 4",
    "LinkedDomainFilterPolicy": "sample string 5"
  },
  "TimeOfDayPolicy": {
    "UtcBased": true,
    "Monday": [
      true,
      true
    ],
    "Tuesday": [
      true,
      true
    ],
    "Wednesday": [
      true,
      true
    ],
    "Thursday": [
      true,
      true
    ],
    "Friday": [
      true,
      true
    ],
    "Saturday": [
      true,
      true
    ],
    "Sunday": [
      true,
      true
    ]
  },
  "DefaultZone": "sample string 3",
  "UnknownZone": "sample string 4",
  "LinkedDomainFilterPolicy": "sample string 5"
}

application/xml, text/xml

Sample:
<DataControlGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <PbnbId>6</PbnbId>
  <ApnNetworkBlackList>
    <ApnNetworkEntry>
      <MCC>sample string 1</MCC>
      <MNC>sample string 2</MNC>
    </ApnNetworkEntry>
    <ApnNetworkEntry>
      <MCC>sample string 1</MCC>
      <MNC>sample string 2</MNC>
    </ApnNetworkEntry>
  </ApnNetworkBlackList>
  <ApnNetworkWhiteList>
    <ApnNetworkEntry>
      <MCC>sample string 1</MCC>
      <MNC>sample string 2</MNC>
    </ApnNetworkEntry>
    <ApnNetworkEntry>
      <MCC>sample string 1</MCC>
      <MNC>sample string 2</MNC>
    </ApnNetworkEntry>
  </ApnNetworkWhiteList>
  <DefaultAccessPolicy>
    <PbnbId>6</PbnbId>
    <AccessRate>2</AccessRate>
    <DownstreamFirewall>sample string 4</DownstreamFirewall>
    <Enabled>true</Enabled>
    <LinkedDomainFilterPolicy>sample string 5</LinkedDomainFilterPolicy>
    <UpstreamFirewall>sample string 3</UpstreamFirewall>
  </DefaultAccessPolicy>
  <DefaultZone>sample string 3</DefaultZone>
  <Enabled>true</Enabled>
  <LinkedDomainFilterPolicy>sample string 5</LinkedDomainFilterPolicy>
  <Name>sample string 1</Name>
  <TimeOfDayPolicy>
    <Friday xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </Friday>
    <Monday xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </Monday>
    <Saturday xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </Saturday>
    <Sunday xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </Sunday>
    <Thursday xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </Thursday>
    <Tuesday xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </Tuesday>
    <UtcBased>true</UtcBased>
    <Wednesday xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </Wednesday>
  </TimeOfDayPolicy>
  <UnknownZone>sample string 4</UnknownZone>
</DataControlGroup>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataControlGroup'.

Response Information

Resource Description

The newly created Group

PBPRReturnOfDataControlGroup
NameDescriptionTypeAdditional information
Data

DataControlGroup

None.

Success

Gets the success status of the API call

boolean

None.

Meta

Gets the optional meta-data

Dictionary of string [key] and string [value]

None.

Code

Get the http code of the API call e.g. 200, 202, 409

integer

None.

ErrorCode

Get the failure error code of the API call. This is available if Success is false

integer

None.

ErrorSubCode

Gets the error sub code if available

integer

None.

ErrorDescription

Gets a textual description of the error

string

None.

StatusUrl

Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided

string

None.

ContinuationToken

Gets the token to be used for paged queries

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Meta": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 2,
  "ErrorCode": 3,
  "Data": {
    "Name": "sample string 1",
    "Enabled": true,
    "ApnNetworkBlackList": [
      {
        "MCC": "sample string 1",
        "MNC": "sample string 2"
      },
      {
        "MCC": "sample string 1",
        "MNC": "sample string 2"
      }
    ],
    "ApnNetworkWhiteList": [
      {
        "MCC": "sample string 1",
        "MNC": "sample string 2"
      },
      {
        "MCC": "sample string 1",
        "MNC": "sample string 2"
      }
    ],
    "DefaultAccessPolicy": {
      "Enabled": true,
      "AccessRate": 2,
      "UpstreamFirewall": "sample string 3",
      "DownstreamFirewall": "sample string 4",
      "LinkedDomainFilterPolicy": "sample string 5"
    },
    "TimeOfDayPolicy": {
      "UtcBased": true,
      "Monday": [
        true,
        true
      ],
      "Tuesday": [
        true,
        true
      ],
      "Wednesday": [
        true,
        true
      ],
      "Thursday": [
        true,
        true
      ],
      "Friday": [
        true,
        true
      ],
      "Saturday": [
        true,
        true
      ],
      "Sunday": [
        true,
        true
      ]
    },
    "DefaultZone": "sample string 3",
    "UnknownZone": "sample string 4",
    "LinkedDomainFilterPolicy": "sample string 5"
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "ChxNUBgJJFhzQB4WF11LeQ%3D%3D"
}

application/xml, text/xml

Sample:
<PBPRReturnOfDataControlGroup7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>ChxNUBgJJFhzQB4WF11LeQ%3D%3D</ContinuationToken>
  <ErrorCode>3</ErrorCode>
  <ErrorDescription>sample string 5</ErrorDescription>
  <ErrorSubCode>4</ErrorSubCode>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <StatusUrl>sample string 6</StatusUrl>
  <Success>true</Success>
  <Data>
    <PbnbId>6</PbnbId>
    <ApnNetworkBlackList>
      <ApnNetworkEntry>
        <MCC>sample string 1</MCC>
        <MNC>sample string 2</MNC>
      </ApnNetworkEntry>
      <ApnNetworkEntry>
        <MCC>sample string 1</MCC>
        <MNC>sample string 2</MNC>
      </ApnNetworkEntry>
    </ApnNetworkBlackList>
    <ApnNetworkWhiteList>
      <ApnNetworkEntry>
        <MCC>sample string 1</MCC>
        <MNC>sample string 2</MNC>
      </ApnNetworkEntry>
      <ApnNetworkEntry>
        <MCC>sample string 1</MCC>
        <MNC>sample string 2</MNC>
      </ApnNetworkEntry>
    </ApnNetworkWhiteList>
    <DefaultAccessPolicy>
      <PbnbId>6</PbnbId>
      <AccessRate>2</AccessRate>
      <DownstreamFirewall>sample string 4</DownstreamFirewall>
      <Enabled>true</Enabled>
      <LinkedDomainFilterPolicy>sample string 5</LinkedDomainFilterPolicy>
      <UpstreamFirewall>sample string 3</UpstreamFirewall>
    </DefaultAccessPolicy>
    <DefaultZone>sample string 3</DefaultZone>
    <Enabled>true</Enabled>
    <LinkedDomainFilterPolicy>sample string 5</LinkedDomainFilterPolicy>
    <Name>sample string 1</Name>
    <TimeOfDayPolicy>
      <Friday xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:boolean>true</d4p1:boolean>
        <d4p1:boolean>true</d4p1:boolean>
      </Friday>
      <Monday xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:boolean>true</d4p1:boolean>
        <d4p1:boolean>true</d4p1:boolean>
      </Monday>
      <Saturday xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:boolean>true</d4p1:boolean>
        <d4p1:boolean>true</d4p1:boolean>
      </Saturday>
      <Sunday xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:boolean>true</d4p1:boolean>
        <d4p1:boolean>true</d4p1:boolean>
      </Sunday>
      <Thursday xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:boolean>true</d4p1:boolean>
        <d4p1:boolean>true</d4p1:boolean>
      </Thursday>
      <Tuesday xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:boolean>true</d4p1:boolean>
        <d4p1:boolean>true</d4p1:boolean>
      </Tuesday>
      <UtcBased>true</UtcBased>
      <Wednesday xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:boolean>true</d4p1:boolean>
        <d4p1:boolean>true</d4p1:boolean>
      </Wednesday>
    </TimeOfDayPolicy>
    <UnknownZone>sample string 4</UnknownZone>
  </Data>
</PBPRReturnOfDataControlGroup7NMnQmOk>