Analytics REST API API documentation version 1

/sapc/v1/analytics/

Analytics

Document Purpose and Scope

This document describes the analytics REST API provided by the Ericsson Service-Aware Policy Controller (SAPC).

Overview

Analytics function is the process of preparing and loading data to telecom equipment to provide a set of services to its users.

Analytics data in the SAPC include the subscriber state and the subscriber information at present, which also can be extended with other contents according to customer's requirements in future.

The SAPC supports the following:

  • HTTP version 1.1 over TLS 1.2
    Note: The SAPC does not support access using not secure HTTP.
  • JSON schema draft 4
  • Basic authentication

General Considerations

Analytics data are available by means of REST resources (also known as endpoints), for example /subscribers/{subscriberId}/subscriber-state/. For information about a particular resource, click on its name (for example /subscribers/{subscriberId}/subscriber-info). Then, click on the available operations for the resource (GET). For each operation, click on Request and Response tabs for detailed information on the parameters and JSON objects (click on Schema). Response tabs describe the status codes and the returned JSON object's parameters. Examples are also provided.

URI Syntax and Character Encoding

A Uniform Resource Identifier (URI) provides a simple and extensible means for identifying a resource. According to RFC 3986, a URI is an identifier consisting of a sequence of characters matching the generic syntax defined in this RFC. The URI is composed from a limited set of characters consisting of digits, letters, and a few graphic symbols. For the resource names the SAPC supports only a group of characters from the ASCII character set.

Valid characters for resource names are the following:

   From "a" (ASCII 97) to "z" (ASCII 122)
   From "A" (ASCII 65) to "Z" (ASCII 90)
   From "0" (ASCII 48) to "9" (ASCII 57)
   "-", "_", ".", ":", "[", "]", "@", "(", ")", "!", "$", "'", "*"

Invalid words for resource names are the following:

   "select", "offset", "limit", "orderby", "asc", "desc", "search"

The use of these characters can be also percent-encoded. This means to encode these characters as a character triplet consisting of the percent character "%", followed by the two hexadecimal digits representing that octet's numeric value in the character set to be used.

The percent-encoded equivalences for the reserved characters are (UTF-8 charset):

      Character | Percent-encoded
      --------- | ---------------
         ":"    |       %3A
         "["    |       %5B
         "]"    |       %5D
         "@"    |       %40
         "("    |       %28
         ")"    |       %29
         "!"    |       %21
         "$"    |       %24
         "'"    |       %27
         "*"    |       %2A

Using UTF-8 for character encoding is strongly recommended as an easy way to get internationalization without having to worry about managing multiple encodings.

JSON Schema Considerations

For string attribute values the SAPC is case sensitive. To include double quote (") character string attributes, use backlash character () to escape them. As an example, see attrValue parameter:

{
    "result":"permit",
    "attrName":"adc-redirect",
    "attrValue":"\"doNotRedirect\""
}

HTTP Status Codes

The SAPC supports the HTTP status codes explicitly specified for each resource. For status code 400 (wrong JSON format) and 422 (wrong semantic), the SAPC also includes an additional information string, as help to solve the problem whenever is possible.

Base URI

The VIP and port defined in the Provisioning Base URI are reused in Analytics Base URI.

<SAPC Provisioning VIP>:8443/analytics/v1/

Resources

Translate session IP address to IMSI

Get IMSIs from ongoing sessions with input IP address, APN (if available) and/or PCEF (if available).

get

The SAPC retrieves IMSIs from ongoing sessions with an IP address. An IMSI list will be returned. If no IMSI is found, then an empty list is returned.

get

Get IMSI from ongoing session with IP Address.

Get IMSI from ongoing session with IP Address.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication

URI Parameters

  • ipaddr: required (string)

    Specific the IPv4 address or IPv6 prefix

HTTP status code 200

Body

Type: application/json

Schema:

 {
   "$schema":"http://json-schema.org/draft-04/schema#",
   "type":"object",
   "additionalProperties":false,
   "properties":{
      "IMSIList":{
         "type": "array",
         "description": "List of IMSIs retrieved from ongoing sessions using given IP address, APN (if available) and/or PCEF (if available).",
         "items":{ "type": "string" }
      }
   },
   "required":["IMSIList"]
}

HTTP status code 400

Wrong format IPv4 address or IPv6 prefix

Body

Type: application/json

Example:

{
   "error":
   {
      "code": 400,
      "description": "Wrong URI format: IPv4 address or IPv6 prefix is not correct.",
      "associatedRequest": "HTTP method and URI used in the request"
   }
}

HTTP status code 405

PUT and DELETE operations are not allowed

Body

Type: application/json

Example:

{
   "error":
   {
      "code": 405,
      "description": "Http operation not allowed.",
      "associatedRequest": "HTTP method and URI used in the request"
   }
}

HTTP status code 500

Internal database error

Body

Type: application/json

Example:

{
   "error":
   {
      "code": 500,
      "description": "DBS generic error.",
      "associatedRequest": "HTTP method and URI used in the request"
   }
}

Secured by basicAuth

Headers

  • Authorization: (string)

    Used to send the Base64 encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

get

The SAPC retrieves IMSIs from ongoing sessions with IP Address, APN (if available) and/or PCEF (if available). An IMSI list will be returned. If no IMSI is found, then an empty list is returned.

get

Get IMSI from ongoing session with IP Address, APN (if available) and/or PCEF (if available).

Get IMSI from ongoing session with IP Address, APN (if available) and/or PCEF (if available).

Secured by basicAuth

Each request must contain the headers necessary for basic authentication

URI Parameters

  • ipaddr: required (string)

    Specific the IPv4 address or IPv6 prefix

Query Parameters

  • APN: (string)

    Specific the access point node

  • PCEF: (string)

    Specific the origin state id

HTTP status code 200

Body

Type: application/json

Schema:

 {
   "$schema":"http://json-schema.org/draft-04/schema#",
   "type":"object",
   "additionalProperties":false,
   "properties":{
      "IMSIList":{
         "type": "array",
         "description": "List of IMSIs retrieved from ongoing sessions using given IP address, APN (if available) and/or PCEF (if available).",
         "items":{ "type": "string" }
      }
   },
   "required":["IMSIList"]
}

HTTP status code 400

Wrong format IPv4 address, IPv6 prefix and/or query parameter

Body

Type: application/json

Example:

{
   "error":
   {
      "code": 400,
      "description": "Wrong URI format: IPv4 address or IPv6 prefix is not correct.",
      "associatedRequest": "HTTP method and URI used in the request"
   }
}
{
   "error":
   {
      "code": 400,
      "description": "Wrong URI format: Parameter format is not correct.",
      "associatedRequest": "HTTP method and URI used in the request"
   }
}

HTTP status code 405

PUT and DELETE operations are not allowed

Body

Type: application/json

Example:

{
   "error":
   {
      "code": 405,
      "description": "Http operation not allowed.",
      "associatedRequest": "HTTP method and URI used in the request"
   }
}

HTTP status code 500

Internal database error

Body

Type: application/json

Example:

{
   "error":
   {
      "code": 500,
      "description": "DBS generic error.",
      "associatedRequest": "HTTP method and URI used in the request"
   }
}

Secured by basicAuth

Headers

  • Authorization: (string)

    Used to send the Base64 encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Subscriber State

The SAPC deduces the subscriber state according to whether the subscriber has at least one ongoing IP-CAN session.
If there are no ongoing IP-CAN sessions for the subscriber in the SAPC, the state is offline. Otherwise, the state is online.

get

get

Get the subscriber state.

Get the subscriber state.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication

URI Parameters

  • subscriberId: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
   "$schema":"http://json-schema.org/draft-04/schema#",
   "type":"object",
   "additionalProperties":false,
   "properties":{
      "subscriberId":{
         "type": "string",
         "description": "Administrative identifier of a subscriber."
      },
      "subscriberState":{
         "type": "string",
         "description": "Indicates whether the subscriber has an ongoing session in SAPC.",
         "enum":["offline","online"]
      }
   }
}

Secured by basicAuth

Headers

  • Authorization: (string)

    Used to send the Base64 encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Subscriber Info

The SAPC collects the subscriber information when it is stored in the internal repository.
The subscriber information includes session information and accumulated consumed usage (if available) of the subscriber.
The accumulated consumed usage equals to the accumulated usage in the subscriber's usage-accumulators in Provisioning REST API.

get

get

Get the subscriber information.

Get the subscriber information.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication

URI Parameters

  • subscriberId: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
	"$schema":"http://json-schema.org/draft-04/schema#",
	"type":"object",
	"additionalProperties":false,
	"properties":{
		"subscriberId":{
			"type": "string",
			"description": "Administrative identifier of a subscriber."
		},
		"ongoingSession":{
			"type":"array",
			"description":"Contains the ongoing session information.",
			"uniqueItems":true,
			"additionalProperties":true,
			"items":{
				"type":"object",
				"additionalProperties":false,
				"properties":{
					"trafficId":{
						"type":"object ",
						"additionalProperties":false,
						"properties":{
							"idType":{
								"type":"string",
								"enum":[
								   "imsi",
								   "msisdn"
								]
							},
							"idValue":{
								"type":"string"
							}
						}
					},
					"apn":{
						"type":"string"
					},
					"ipv4Addr":{
						"type":"string",
						"description":"UE's IPv4 address."
					},
					"ipv6Prefix":{
						"type":"string",
						"description":"UE's IPv6 prefix."
					},
					"startTime":{
						"type":"string",
						"description":"Start date and time when the session is established.",
						"pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
					},
					"updateTime":{
						"type":"string",
						"description":"Last update date and time when the session is modified.",
						"pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
					},
					"mnc":{
						"type":"string"
					},
					"mcc":{
						"type":"string"
					},
					"ratType":{
						"type":"string",
						"enum":[
							"Wlan",
							"Virtual",
							"Utran",
							"Geran",
							"Gan",
							"HspaEvolution",
							"Eutran",
							"EutranNbIot",
							"Cdma2000",
							"Hrpd",
							"Umb",
							"Ehrpd"
						]
					},
					"pccRules":{
						"type":"object",
						"additionalProperties ":false,
						"properties":{
							"pccRuleIds ":{
							   "type":"array ",
							   "uniqueItems":true,
							   "items":{
								  "type":"string"
							   }
							},
							"time":{
							  "type":"string",
							  "description":"Last update date and time when PCC rule list is modified.",
							  "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
							}
						}
					},
					"qos":{
						"type":"object",
						"description":"Accepted QoS and bandwidth.",
						"properties":{
							"qci":{
								"type":"integer",
								"minimum":1,
								"maximum":254,
								"exclusiveMaximum":false,
								"exclusiveMinimum":false,
								"description":"Authorized QoS Class Identifier for the default bearer."
							},
							"apnAmbrDl":{
							   "type":"integer",
							   "description":"Authorized maximum aggregate bit rate (in Kbits per second) for the downlink across all non-GBR bearers related with the same APN."
							},
							"apnAmbrUl":{
							   "type":"integer",
							   "description":"Authorized maximum aggregate bit rate (in Kbits per second) for the uplink across all non-GBR bearers related with the same APN."
							},
							"bearerId":{
							   "type":"string",
							   "description":"The identifier for the IP-CAN bearer. It’s in hexadecimal format with 0x as the prefix."
							},
							"mbrDl":{
							   "type":"integer",
							   "description":"Authorized maximum bit rate (in Kbits per second) for the downlink."
							},
							"mbrUl":{
							   "type":"integer",
							   "description":"Authorized maximum bit rate (in Kbits per second) for the uplink."
							},
							"arpPrio":{
							   "type":"integer",
							   "description":"Priority for Allocation Retention Priority (ARP).",
							   "minimum":1,
							   "maximum":15,
							   "exclusiveMaximum":false,
							   "exclusiveMinimum":false
							},
							"arpPvi":{
							   "type":"boolean",
							   "description":"Values: false = PRE-EMPTION_VULNERABILITY_ENABLED (0); true = PRE-EMPTION_VULNERABILITY_DISABLED (1)."
							},
							"arpPci":{
							   "type":"boolean",
							   "description":"Values: false = PRE-EMPTION_CAPABILITY_ENABLED (0); true = PRE-EMPTION_CAPABILITY_DISABLED (1)."
							}
						}
					},
					"pra":{
						"type":"object",
						"additionalProperties":false,
						"properties":{
							"praId":{
								"type":"integer",
								"description":"Name of PRA (Presence Reporting Area).",
								"minimum":0,
								"maximum":16777215
							},
							"praStatus":{
								"type":"string",
								"description":"Indicates the UE is inside (In) or outside (Out) of the PRA. Before received the report from PCEF, the status is Unknown.",
								"enum":[
								   "Unknown",
								   "In",
								   "Out"
								]
							}
						}
					}
				}
			}
		},
		"closedSession":{
			"type":"array",
			"description":"Contains the ongoing session information.",
			"uniqueItems":true,
			"additionalProperties":true,
			"items":{
				"type":"object",
				"additionalProperties":false,
				"properties":{
					"trafficId":{
						"type":"object ",
						"additionalProperties":false,
						"properties":{
							"idType":{
								"type":"string",
								"enum":[
								   "imsi",
								   "msisdn"
								]
							},
							"idValue":{
								"type":"string"
							}
						}
					},
					"apn":{
						"type":"string"
					},
					"ipv4Addr":{
						"type":"string",
						"description":"UE's IPv4 address."
					},
					"ipv6Prefix":{
						"type":"string",
						"description":"UE's IPv6 prefix."
					},
					"startTime":{
						"type":"string",
						"description":"Start date and time when the session is established.",
						"pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
					},
					"updateTime":{
						"type":"string",
						"description":"Last update date and time when the session is modified.",
						"pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
					},
					"mnc":{
						"type":"string"
					},
					"mcc":{
						"type":"string"
					},
					"ratType":{
						"type":"string",
						"enum":[
							"Wlan",
							"Virtual",
							"Utran",
							"Geran",
							"Gan",
							"HspaEvolution",
							"Eutran",
							"EutranNbIot",
							"Cdma2000",
							"Hrpd",
							"Umb",
							"Ehrpd"
						]
					},
					"pccRules":{
						"type":"object",
						"additionalProperties ":false,
						"properties":{
							"pccRuleIds ":{
							   "type":"array ",
							   "uniqueItems":true,
							   "items":{
								  "type":"string"
							   }
							},
							"time":{
							  "type":"string",
							  "description":"Last update date and time when PCC rule list is modified.",
							  "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
							}
						}
					},
					"qos":{
						"type":"object",
						"description":"Accepted QoS and bandwidth.",
						"properties":{
							"qci":{
								"type":"integer",
								"minimum":1,
								"maximum":254,
								"exclusiveMaximum":false,
								"exclusiveMinimum":false,
								"description":"Authorized QoS Class Identifier for the default bearer."
							},
							"apnAmbrDl":{
							   "type":"integer",
							   "description":"Authorized maximum aggregate bit rate (in Kbits per second) for the downlink across all non-GBR bearers related with the same APN."
							},
							"apnAmbrUl":{
							   "type":"integer",
							   "description":"Authorized maximum aggregate bit rate (in Kbits per second) for the uplink across all non-GBR bearers related with the same APN."
							},
							"bearerId":{
							   "type":"string",
							   "description":"The identifier for the IP-CAN bearer. It’s in hexadecimal format with 0x as the prefix."
							},
							"mbrDl":{
							   "type":"integer",
							   "description":"Authorized maximum bit rate (in Kbits per second) for the downlink."
							},
							"mbrUl":{
							   "type":"integer",
							   "description":"Authorized maximum bit rate (in Kbits per second) for the uplink."
							},
							"arpPrio":{
							   "type":"integer",
							   "description":"Priority for Allocation Retention Priority (ARP).",
							   "minimum":1,
							   "maximum":15,
							   "exclusiveMaximum":false,
							   "exclusiveMinimum":false
							},
							"arpPvi":{
							   "type":"boolean",
							   "description":"Values: false = PRE-EMPTION_VULNERABILITY_ENABLED (0); true = PRE-EMPTION_VULNERABILITY_DISABLED (1)."
							},
							"arpPci":{
							   "type":"boolean",
							   "description":"Values: false = PRE-EMPTION_CAPABILITY_ENABLED (0); true = PRE-EMPTION_CAPABILITY_DISABLED (1)."
							}
						}
					},
					"pra":{
						"type":"object",
						"additionalProperties":false,
						"properties":{
							"praId":{
								"type":"integer",
								"description":"Name of PRA (Presence Reporting Area).",
								"minimum":0,
								"maximum":16777215
							},
							"praStatus":{
								"type":"string",
								"description":"Indicates the UE is inside (In) or outside (Out) of the PRA. Before received the report from PCEF, the status is Unknown.",
								"enum":[
								   "Unknown",
								   "In",
								   "Out"
								]
							}
						}
					}
				}
			}
		},
		"usageAccumulators":{
			"type":"array",
			"minItems": 1,
			"uniqueItems": true,
			"additionalItems":false,
			"items":{
				"type":"object",
				"additionalProperties":false,
				"properties":{
					"name":{
					  "type":"string",
					  "description": "Reporting group identifier."
					},
					"restartInfo":{
					  "type":"string",
					  "description": "Copy of the start date applicable for the subscriber group usage accumulator. If startDate is modified, the usage accumulator is reset."
					},
					"subscriptionDate":{
					 "type":"string",
					 "description": "Start date and time when the reporting group is controlled. If the optional time part (Thh[:mm[:ss]]) is not specified, 00:00:00 is considered.",
					 "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
					},
					"subscriberGroupName":{
					  "type":"string",
					  "description": "It contains the dataplan name which the usage limit has been taken from."
					},
					"selected":{
					  "type":"string",
					  "description": "In the case of having separate accumulators depending on the subscriber group the subscriber belongs to, it indicates if the accumulated value is chosen for accumulation or not (depending on the active subscriber group). In case of multiple IP sessions, its value corresponds to the last IP sessions that received Usage Reporting.",
					  "enum":["yes","no"]
					},
					"validityTime":{
					  "type":"integer",
					  "description": "Internally used to handle time events making use of Time Trigger functionality."
					},
					"absoluteAccumulated":{
					  "type":"object",
					  "description": "Block containing the accumulated consumed usages for a specific period.",
					  "additionalProperties":false,
					  "properties":{
						 "reportingLevel":{
							"type":"string",
							"enum":["totalTraffic","perReportingGroup"]
						 },
						 "ulVolume":{
							 "type":"integer",
							 "description": "Uplink volume accumulated.",
							 "minimum": 0
						 },
						 "dlVolume":{
							 "type":"integer",
							 "description": "Downlink volume accumulated.",
							 "minimum": 0
						 },
						 "bidirVolume":{
							 "type":"integer",
							 "description": "Bidirectional volume accumulated.",
							 "minimum": 0
						 },
						 "time":{
							"type":"integer",
							"description": "Time of accumulated",
							"minimun": 0
						 },
						 "expiryDate":{
							"type":"object",
							"description": "Date and time when the absolute accumulated consumed usages are reset for postpaid subscriptions, or valid for prepaid ones.",
							"additionalProperties":false,
							"properties":{
							   "volume":{
								  "type":"string",
								  "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
							   },
							   "time":{
								  "type":"string",
								  "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
							   }
							}
						 },
						 "previousExpiryDate":{
							"type":"object",
							"description": "At creation time of the accumulatedUsage entry, subscriptionDate value (or startDate or system date) is copied in this attribute. It is updated with the expiry date from the previous period.",
							"additionalProperties":false,
							"properties":{
							   "volume":{
								  "type":"string",
								  "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
							   },
							   "time":{
								  "type":"string",
								  "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
							   }
							}
						 },
						 "resetPeriod":{
							"type":"object",
							"description": "Time period to reset all accumulated consumed usages for postpaid reporting groups (usage information is automatically reset when previous expiration date + resetPeriod is reached).",
							"additionalProperties":false,
							"properties":{
							   "volume":{"type":"string"},
							   "time":{"type":"string"}
							}
						 },
						 "counters":{
							"type":"array",
							"description": "Block containing the complementary accumulated consumed usages.",
							"additionalItems":false,
							"items":{
							   "type":"object",
							   "additionalProperties":false,
							   "properties":{
								  "name":{
									"type":"string"
								  },
								  "ulVolume":{
									"type":"integer",
									"description": "Uplink volume accumulated.",
									"minimum": 0
								  },
								  "dlVolume":{
									"type":"integer",
									"description": "Downlink volume accumulated.",
									"minimum": 0
								  },
								  "bidirVolume":{
									"type":"integer",
									"description": "Bidirectional volume accumulated.",
									"minimum": 0
								  },
								  "time":{
									"type":"integer",
									"description": "Time of accumulated",
									"minimum": 0
								  },
								  "expiryDate":{
									 "type":"object",
									 "description": "Date and time when the complementary accumulated consumed usages are reset for postpaid subscriptions, or valid for prepaid ones.",
									 "additionalProperties":false,
									 "properties":{
										"volume":{
										   "type":"string",
										   "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
										},
										"time":{
										   "type":"string",
										   "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
										}
									 }
								  },
								  "previousExpiryDate":{
									 "type":"object",
									 "description": "At creation time of the accumulatedUsage entry, subscriptionDate value (or startDate or system date) is copied in this attribute. It is updated with the expiry date from the previous period.",
									 "additionalProperties":false,
									 "properties":{
										"volume":{
										   "type":"string",
										   "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
										},
										"time":{
										   "type":"string",
										   "pattern":"^(0[1-9]|[1-2][0-9]|3[0-1])-(0[1-9]|1[0-2])-[1-2][0-9]{3}(T([0-1][0-9]|2[0-3])(:[0-5][0-9]){0,2})?$"
										}
									 }
								  },
								  "resetPeriod":{
									 "type":"object",
									 "description": "Time period to reset all accumulated consumed usages for postpaid reporting groups (usage information is automatically reset when previous expiration date + resetPeriod is reached).",
									 "additionalProperties":false,
									 "properties":{
										"volume":{"type":"string"},
										"time":{"type":"string"}
									 }
								  }
							   }
							}
						 }
					  }
					},
					"sessionAccumulated":{
					  "type":"array",
					  "description": "Block containing the accumulated consumed usages for an IP session.",
					  "additionalItems":false,
					  "items":{
						 "type":"object",
						 "additionalProperties":false,
						 "properties":{
							"session":{
							   "type":"string"
							},
							"reportingLevel":{
							   "type":"string",
							   "description": "totalTraffic Fair Usage is related to the total traffic (IP session). perReportingGroup Fair Usage is related to a specific reporting group (service level). If reportingLevel is not provisioned, perReportingGroup (default value) is assumed.",
							   "enum":["totalTraffic","perReportingGroup"]
							},
							"ulVolume":{
							   "type":"integer",
							   "description": "Uplink volume accumulated.",
							   "minimum": 0
							},
							"dlVolume":{
							   "type":"integer",
							   "description":"Downlink volume accumulated.",
							   "minimum": 0
							},
							"bidirVolume":{
							   "type":"integer",
							   "description": "Bidirectional volume accumulated.",
							   "minimum": 0
							},
							"time":{
							   "type":"integer",
							   "description": "Time of accumulated",
							   "minimum": 0
							},
							"counters":{
							   "type":"array",
							   "description": "Block containing the complementary accumulated consumed usages.",
							   "additionalItems":false,
							   "items":{
								  "type":"object",
								  "additionalProperties":false,
								  "properties":{
									 "name":{
									   "type":"string"
									 },
									 "ulVolume":{
									   "type":"integer",
									   "description": "Uplink volume accumulated.",
									   "minimum": 0
									 },
									 "dlVolume":{
									   "type":"integer",
									   "description": "Downlink volume accumulated.",
									   "minimum": 0
									 },
									 "bidirVolume":{
									   "type":"integer",
									   "description": "Bidirectional volume accumulated.",
									   "minimum": 0
									 },
									 "time":{
									   "type":"integer",
									   "description": "Time of accumulated",
									   "minimum": 0
									 }
								  }
							   }
							}
						 }
					  }
					}
				}
			}
		},
		"version":{
			"type":"string",
			"description": "2.2. Internally used to know about the json format syntax of accumulated attribute, as it can be expanded in each release of the SAPC."
		}
	}
}

Secured by basicAuth

Headers

  • Authorization: (string)

    Used to send the Base64 encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.