components: schemas: ApnLog: properties: username: type: string description: The subscriber's username for the APN connection. example: '4474740000001' networkCode: type: string description: The Mobile Country Code and Mobile Network Code that together identify the network (if provided by the network operator). 'N/A' indicates that the operator has not provided these codes. example: N/A startTime: oneOf: - format: date type: string - format: date-time type: string description: The session start date and time. example: '2018-02-11T10:33:30.000Z' stopTime: oneOf: - format: date type: string - format: date-time type: string description: 'The session end date and time. If blank, the subscriber''s session is still active.' example: '2018-02-11T10:33:30.000Z' mobileOriginatedData: type: string description: 'The total amount of mobile originated (MO) data transferred during the session, in bytes.' example: '40238' mobileTerminatedData: type: string description: 'The total amount of mobile terminated (MT) data transferred during the session, in bytes.' example: '10253' reason: type: string description: '<p>The reason the session was terminated&#58;</p> <ul> <li><em>User-Request</em> - the subscriber successfully closed the session.</li> <li><em>Access-Accept</em> - the session is ongoing.</li> <li><em>Access-Reject</em> - the subscriber was refused access to the APN due to invalid user credentials.</li> <li><em>Admin-Reset</em> - the session was terminated by the network, possibly due to a location update.</li> <li><em>NAS-Error</em> - the subscriber could not connect to the APN due to a network authentication server error.</li> </ul>' example: User-Request subscriberIp: type: string description: 'The subscriber''s static IP address, or the word "dynamic" to indicate a dynamic IP address.' example: 10.0.0.1 password: type: string description: The subscriber's APN password. example: Il0v3c@ts! required: - username - networkCode - startTime - stopTime - mobileOriginatedData - mobileTerminatedData - reason - subscriberIp - password type: object ApnDetail: properties: apnName: type: string description: The name of the APN to which the subscriber connected. example: examplename username: type: string description: The subscriber's APN username. example: '4474740000001' password: type: string description: The subscriber's APN password. example: Il0v3c@ts! internetAccessStatus: type: string description: 'The subscriber''s outbound internet access, either enabled or disabled.' example: enabled privateIpAddress: type: string description: The subscriber's private IP address. example: 192.168.0.1 required: - apnName - username - password - internetAccessStatus - privateIpAddress type: object info: title: APN log version: 4.0.0 description: |- <p>Retrieve a subscriber's APN session log or APN connection details for a specified time frame.</p><p>You can use these endpoints to retrieve the APN information, and sort and filter the returned results.</p> <p>The <em>APN log</em> is a historical record of the subscriber-generated IP traffic. The log includes the following information&#58;</p> <ul> <li>Subscriber credentials used to access the APN</li> <li>Start and stop dates and times for each session</li> <li>Mobile codes that identify the network accessed during each session (if provided by the network operator)</li> <li>Subscriber's IP address, either fixed or dynamic</li> <li>Total amount of data the subscriber sent during the session (MO data)</li> <li>Total amount of data the subscriber received during the session (MT data)</li> <li>Reason for the termination of each session</li> </ul> <p>The <em>APN details</em> include the following information&#58;</p> <ul> <li>Name of the APN</li> <li>Subscriber credentials used to access the APN</li> <li>Internet access status</li> <li>Subscriber's private IP address</li> </ul> servers: - url: 'https://api.iot-x.com' openapi: 3.0.0 paths: '/{physicalId}/logs': get: operationId: ApnInformationController.getAll parameters: - in: path name: physicalId required: true schema: type: string description: The unique subscriber identifier. - name: orderBy in: query description: 'Order the results by a particular field in either ascending or descending order.</p><p>This parameter supports multiple fields for sorting, for example, ''name ASC, created DESC''.' schema: type: string - name: offset in: query description: 'Offsets the returned results to begin at particular record count. <p>For example, setting this to 10 causes the query to skip the first ten records in the data set.</p>' schema: type: number default: 0 - name: limit in: query description: 'Specifies the upper limit of the number of results to return. This filter has an upper limit of 100.<p>For example, setting this to 10 limits the query to returning a maximum of ten records.</p>If no limit is set, the query will return a maximum of 25 records.</p>' schema: type: number maximum: 100 default: 25 - name: filter in: query description: 'Filter the results the query returns. <p>For example, to retrieve all users called Tom, with an age above 21, set the filter to - ''name eq "Tom" and age gt 21''.' schema: type: string responses: '200': content: application/json: schema: type: object properties: content: type: array items: $ref: '#/components/schemas/ApnLog' description: Success - returns the subscriber's APN log. summary: Retrieves the APN log for the specified subscriber. tags: - APN log description: '<p>You must provide the subscriber''s <em>physicalId</em> as a parameter in the request. This value varies depending on the subscriber type&#58;</p><ul><li><em>Cellular</em> - use the ICCID</li><li><em>Non-IP</em> - use the Device EUI</li><li><em>Satellite</em> - use the IMEI</li></ul><p>To use this endpoint, your user account must have the <strong>View APN Logs</strong>, <strong>View Subscriber</strong> and <strong>View the APN Details of a Subscriber</strong> permissions enabled.</p><br><p>The response breaks down data usage into two categories&#58; <ul><li><em>Mobile Originated (MO) data</em> is the amount of data sent from the subscriber.</li><li><em>Mobile Terminated (MT) data</em> is the amount of data received by the subscriber.</li></ul></p>' '/{physicalId}/apn-details': get: operationId: ApnInformationController.getSubscriberApnDetails parameters: - in: path name: physicalId required: true schema: type: string description: The unique subscriber identifier. responses: '200': content: application/json: schema: type: object properties: content: type: array items: $ref: '#/components/schemas/ApnDetail' description: Success - returns the subscriber's APN details. summary: Retrieves the APN details for the specified subscriber. tags: - APN log description: '<p>You must provide the subscriber''s <em>physicalId</em> as a parameter in the request. This value varies depending on the subscriber type&#58;</p><ul><li><em>Cellular</em> - use the ICCID</li><li><em>Non-IP</em> - use the Device EUI</li><li><em>Satellite</em> - use the IMEI</li></ul><p>To use this endpoint, your user account must have the <strong>View Subscriber</strong> and <strong>View the APN Details of a Subscriber</strong> permissions enabled.</p>'