api/v1/privateapns

Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/privateapns?skip={skip}&take={take}

Summary

Get a paged list of private APNs for the current user's account.

Request Information

URI Parameters

Name	Description	Type	Additional information
skip	The number of records to skip. Optional; default: 0. Must be ≥ 0.	integer	Default value is 0
take	The number of records to return. Optional; default: 10. Range: 1–100.	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

200 OK: An array of .401 Unauthorized: Returned if the current user is not in an allowed role.

Collection of PrivateApnModel

Name	Description	Type	Additional information
Id	Unique identifier of the private APN.	integer	None.
Name	Name of the APN.	string	None.
OperatorName	Name of the mobile network operator hosting this APN.	string	None.
IpRanges	Collection of IP ranges associated with this APN.	Collection of ApnIpRangeModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "OperatorName": "sample string 3",
    "IpRanges": [
      {
        "NattedIpRange": "sample string 1",
        "RadiusIpRange": "sample string 2"
      },
      {
        "NattedIpRange": "sample string 1",
        "RadiusIpRange": "sample string 2"
      }
    ]
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "OperatorName": "sample string 3",
    "IpRanges": [
      {
        "NattedIpRange": "sample string 1",
        "RadiusIpRange": "sample string 2"
      },
      {
        "NattedIpRange": "sample string 1",
        "RadiusIpRange": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPrivateApnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.PrivateApns">
  <PrivateApnModel>
    <Id>1</Id>
    <IpRanges>
      <ApnIpRangeModel>
        <NattedIpRange>sample string 1</NattedIpRange>
        <RadiusIpRange>sample string 2</RadiusIpRange>
      </ApnIpRangeModel>
      <ApnIpRangeModel>
        <NattedIpRange>sample string 1</NattedIpRange>
        <RadiusIpRange>sample string 2</RadiusIpRange>
      </ApnIpRangeModel>
    </IpRanges>
    <Name>sample string 2</Name>
    <OperatorName>sample string 3</OperatorName>
  </PrivateApnModel>
  <PrivateApnModel>
    <Id>1</Id>
    <IpRanges>
      <ApnIpRangeModel>
        <NattedIpRange>sample string 1</NattedIpRange>
        <RadiusIpRange>sample string 2</RadiusIpRange>
      </ApnIpRangeModel>
      <ApnIpRangeModel>
        <NattedIpRange>sample string 1</NattedIpRange>
        <RadiusIpRange>sample string 2</RadiusIpRange>
      </ApnIpRangeModel>
    </IpRanges>
    <Name>sample string 2</Name>
    <OperatorName>sample string 3</OperatorName>
  </PrivateApnModel>
</ArrayOfPrivateApnModel>