POST v1/accounts/{foreignaccountkey}/networks/{foreignkey}/datacontrol/zones/apnzones

Create a new APN Zone on this network.<br/> The APN Zone has the following properties:-<br/> 1) Name. The unique name for this zone. Zones are references by this name.<br/> 2) ApnNetworkList. The list of MCC (mobile country code) &amp; MNC (mobile network code) pairs<br/><br/>

Request Information

URI Parameters

NameDescriptionTypeAdditional information
foreignaccountkey

The Api Account to query

string

Required

foreignkey

The network on the account to query

string

Required

Body Parameters

The details of the new APN Zpne

DataControlAPNZone
NameDescriptionTypeAdditional information
Name

The unique name for the zone

string

None.

ApnNetworkList

Get and sets the list of MCC/MNC pairs that define the zone

Collection of ApnNetworkEntry

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "ApnNetworkList": [
    {
      "MCC": "sample string 1",
      "MNC": "sample string 2"
    },
    {
      "MCC": "sample string 1",
      "MNC": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<DataControlAPNZone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <PbnbId>2</PbnbId>
  <ApnNetworkList>
    <ApnNetworkEntry>
      <MCC>sample string 1</MCC>
      <MNC>sample string 2</MNC>
    </ApnNetworkEntry>
    <ApnNetworkEntry>
      <MCC>sample string 1</MCC>
      <MNC>sample string 2</MNC>
    </ApnNetworkEntry>
  </ApnNetworkList>
  <Name>sample string 1</Name>
</DataControlAPNZone>

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 'DataControlAPNZone'.

Response Information

Resource Description

The newly created APN Zone

PBPRReturnOfDataControlAPNZone
NameDescriptionTypeAdditional information
Data

DataControlAPNZone

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",
    "ApnNetworkList": [
      {
        "MCC": "sample string 1",
        "MNC": "sample string 2"
      },
      {
        "MCC": "sample string 1",
        "MNC": "sample string 2"
      }
    ]
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "orTl%2BLChjPDb6La%2Bv%2FXj0Q%3D%3D"
}

application/xml, text/xml

Sample:
<PBPRReturnOfDataControlAPNZone7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>orTl%2BLChjPDb6La%2Bv%2FXj0Q%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>2</PbnbId>
    <ApnNetworkList>
      <ApnNetworkEntry>
        <MCC>sample string 1</MCC>
        <MNC>sample string 2</MNC>
      </ApnNetworkEntry>
      <ApnNetworkEntry>
        <MCC>sample string 1</MCC>
        <MNC>sample string 2</MNC>
      </ApnNetworkEntry>
    </ApnNetworkList>
    <Name>sample string 1</Name>
  </Data>
</PBPRReturnOfDataControlAPNZone7NMnQmOk>