Resource URI: {api_root}/{resourcePath}
in which
{api_root}: {server}/{server_root}/{api_name}/{api_version}
{resourcePath}: {resource}/{id}
{server} : This value is the “https:\\<address>:[<port>]” of the server where the API implementation resides, for example “https:\\10.10.5.10:8080”. If port not specified, default ports for the applications are assumed.
{server_root}: The root URL on which the API is deployed.
{api_name}: The name of the REST API.
{api_version}: The version of the API to be used.
{resource} : A resource associated with an entity of the API.
{id} : An ID to uniquely identify an instance of the resource. When it is omitted in GET request, all instance of the resource will be returned.
For this API, the {api_root} is set as following:
{server} | The <port> of listening requests to this API is 27030. The <address> of the service could be either the IP address of external Load Balancer or DNS name of the server. This API support both HTTP and HTTPs as access schema. |
{server_root} | {server_root} shall be set to rest |
{api_name} | {api_name} shall be set to accountInfo |
{api_version} | Currently, the {api_version} is v1 |
example: | https://ece.example.com:27030/rest/accountInfo/v1/ |
Resources
| API | URL | Method |
Get Details | /rest/AccountInfo | GET |
Account
The account resource represents the partner’s account in charging system. One account resource contains information related to a specific partner. The information includes remaining credit, life cycle parameters, offers/products and a series of resources that attach to offer, e.g. Dedicated Account and Usage Counters / Usage Threshold.
Parameters of Account resource is listed as following table.
| Parameter Name | Type | Superior Parameter | Description |
accountInfo | object | n/a | Account Information. It contains all information related to the specific partner. |
id | string | accountInfo | Unique Identity of the account. Its value is equal to the Identifier of the partner as register in ESIF nodes (e.g. MSDP, ECM, EOC and Charging System) |
activationStatus | boolean | accountInfo | Activation Status. It indicates if an account is activated or not.
|
activationDate | string | accountInfo | Activation Date. It contains the activation date of an account. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateToday |
accountValue | array of object | accountInfo | Balance of this account in monetary units. It contains maximum 2 elements which represents balance in different currency. |
accountValueByCurrency | object | accountValue | Balance of the account counted by specific Currency |
currency | string | accountValueByCurrency | Currency Type. The currency used to present the balance value. Encoding Format: Characters according to the ISO 4217 standard, see Codes for the representation of currencies and funds. |
mainAccountValue | number | accountValueByCurrency | Balance of the partner’s master account. This is not taking in consideration any ongoing chargeable events. Encoding Format: The Price is a numeric value plus the minus sign " - " in case of a negative value. The value is provided in the lowest denomination of the currency. Value Range: -999 999 999 999 to 999 999 999 999 |
aggregatedBalance | number | accountValueByCurrency | Aggregated Balance. It contains aggregated balance for the partner. This is not taking in consideration any ongoing chargeable events. Aggregated balance is used to display the total balance of real money on the subscribers account. Real money can be seen as money added to the account by the subscriber and does not include various bonuses or promotions. Subscribers aggregated balance is the sum of main account value and the dedicated accounts marked if it is counted by real money. Encoding Format: The Price is a numeric value plus the minus sign " - " in case of a negative value. The value is provided in the lowest denomination of the currency. Value Range: -999 999 999 999 to 999 999 999 999 |
supervisionExpiryDate | string | accountInfo | It indicates the expiry date of the supervision period. The supervision period is the time period when a service is available to the subscriber before a refill has to be made. When the supervision period expires, the credit clearance period is started. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateToday |
creditClearanceDate | string | accountInfo | It indicates the date when the credit clearance period will expire. A credit clearance period starts when the supervision period expires. If no refill is made before the credit clearance period has expired, the account is set for credit clearance, which means that any credit on the main account and all available Dedicated Accounts (DAs) are cleared Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateToday |
productList | array | accountInfo | A list of offer/product that attach to the partner’s account. |
product | object | productList | it contains a product or offer that attaches to the partner’s account. |
offerID | number | product | It contains an internal identity of an offer in charging system. Value range: 1 to 2147483647 |
productID | number | product | It contains an internal unique identity of product in charging system. Product is an instance of an offer. Value Range: 1 to 2147483647 |
productIdentifier | string | product | It contains the external identifier of the product. The identifier is allocated and used in ECM and EOC, and passed to charging system within the flexible field ADMIN_External_Product_Identifier. |
productName | string | product | It contains the external name of the product. The name is allocated and used in ECM and EOC, and passed to charging system within the flexible field ADMIN_Product_Name. |
productOwner | string | product | It contains the owner of this product. This parameter is set by ECM and passed to charging system within the flexible field ADMIN_Product_Owner |
priceFee | array | product | It contains a list of price attribute of the product that defined in ECM and EOC. These attribute are passed to charging system over flexible fields PRICE_FEES_<attribute_name>. |
<attibute> | string | priceFee | It contains a specific price attribute that is indicated by flexible field. The parameter name is identical the part of <attribute_name> of the flexible field. |
startDate | string | product | It contains the date when an offer will be considered as active. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateToday |
expiryDate | string | product | It contains the date when an offer will be considered as expiry. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateToday |
startDateTime | string | product | It contains the start date and time for an offer. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateMax or DateBeginningOfTime |
expiryDateTime | string | product | It contains the expiry date and time for an offer. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateMax or DateBeginningOfTime |
offerState | number | product | It specifies the actual offer state. Value Range: 0 = Enabled offer state 1= Disabled offer state 2-99 = Reserved for future use |
resource | object | product | It contains resources attached to the offer. Resource including DedicatedAccount, UsageCounter, PeriodicAccountManagement. |
dedicatedAccount | array | resource | It contains the dedicatedAccounts attached to the Offer. |
dedicatedAccountUnitType | number | dedicatedAccount | It contains the unit of the dedicated account values. Value Range: 0 = The account contains time. 1 = The account contains money. 2 = The account contains total octets (Not used, reserved for future use). 3 = The account contains input octets (Not used, reserved for future use). 4 = The account contains output octets (Not used, reserved for future use). 5 = The account contains service specific units. 6 = The account contains volume. |
accountValue | object | dedicatedAccount | It contains the total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events. If the unit type that is indicated by parameter dedicatedAccountUnitType is not money, only one element is include. If the unit type is Money, there are possible maximum 2 elements with different currency in the array. |
value | number | accountValue | it contains amount of the balance of the dedicated account. If the unit type that is indicated by parameter dedicatedAccountUnitType is not money, this parameter contains the sum of the valid units. When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. Value Range: 0 to 9 223 372 036 854 775 807 |
currency | string | accountValue | Currency Type. The currency used to present the balance value of this dedicatedAccount. Encoding Format: Characters according to the ISO 4217 standard, see Codes for the representation of currencies and funds. |
dedicatedReservation | string | accountValue | It contains contain the number of units that are reserved on the a dedicated account. If the unit type is not money, it contains the sum of the valid reserved units. If the unit type is money, the parameter can contain both an integer part and a decimal part. There is no decimal separator; the decimal part is given directly to the right of the integer part. Value Range: 0 to 9 223 372 036 854 775 807 |
closestExpiryValue | string | accountValue | It states the balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated account. If the unit type is not money, it contains the amount of the units to be expiry. If the unit type is money, the parameter can contain both an integer part and a decimal part. There is no decimal separator; the decimal part is given directly to the right of the integer part. Value Range: -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 |
closetAccessibleValue | string | accountValue | It states the balance of the sub dedicated account(s) with the closest start date. If the unit type is not money, it contains the amount of the units to be valid. Value Range: -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 |
activeValue | string | accountValue | It contains contains a dedicated account balance that can be consumed right now. If the unit type is not money, it contains the amount of the valid unit. Value Range: 0 to 9 223 372 036 854 775 807 |
expiryDate | string | dedicatedAccount | It contains the expiry date for a dedicated account. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateMax or DateInfinite |
startDate | string | dedicatedAccount | It contains the date when an dedicated account will be considered as active. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateMax or DateInfinite |
subDedicatedAccount | array | dedicatedAccount | It contains a groups sub dedicated accounts that attach to the main dedicated account, if any. |
accountValue | array | subDedicatedAccount | It contains the total balance of the sub dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events. If the unit type that is indicated by parameter dedicatedAccountUnitType is not money, only one element is included. If the unit type is Money, there are possible maximum 2 elements with different currency in the array. |
value | number | accountValue | It contains amount of the balance of the sub dedicated account. If the unit type that is indicated by parameter dedicatedAccountUnitType is not money, this parameter contains the sum of the valid units. When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. Value Range: 0 to 9 223 372 036 854 775 807 |
currency | string | accountValue | Encoding Format: Characters according to the ISO 4217 standard, see Codes for the representation of currencies and funds |
startDate | string | subDedicatedAccount | It contains the date when the sub dedicated account will be considered as active. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateMax or DateInfinite |
expiryDate | string | subDedicatedAccount | It contains the expiry date for a sub dedicated account. Encoding Format: <dateTime.iso8601> Value Range: DateMin to DateMax or DateInfinite |
periodicAccountManagementInfo | object | subDedicatedAccount |
|
Example Get Details
Request
GET /rest/AccountInfo Accept: application/json Authorization: Basic RVNJRl9BUFBfQUNDT1VOVElORk86UGFzc3dvcmQ= Host: ece.example.com:38080 Accept: application/json |
1.1.1.1.2 Response
HTTP/1.1 200 OK Date: Mon, 13 Apr 2015 03:54:27 GMT Content-Type: application/json {"id":"ESIF_SP_ACCOUNTINFO", "activationStatus":false, "activationDate":"20150302T08:00:00", "creditClearancePeriod":0, "creditClearanceDate":"20150610T08:00:00", "accountValue":[{"currency":"EUR", "mainAccountValue":"-3000" }], "productsList":[{"offerID":200, "productName":"productName555", "productIdentifier":"productIdentifier555", "productOwner":"owner555", "productFee":[{"attributeName":"PRICE_FEES_productFee1", "attributeValueDecimal":{"attributeValueNumber":"5", "numberOfDecimals":5 }, "attributeSource":0 }], "productID":555, "startDate":"20150302T08:00:00", "expiryDate":"99991231T08:00:00", "startDateTime":"20150302T08:00:00", "expiryDateTime":"20150610T08:00:00", "offerState":0, "resource":{"dedicateAccount":[{"dedicatedAccountUnitType":1, "accountValue":[{"value":"15", "currency":"EUR", "dedicatedReservation":"134", "closestExpiryValue":"0.11", "closestAccessibleValue":"0.11", "activeValue":"0.11" },{"value":"25", "currency":"RMB", "dedicatedReservation":"234", "closestExpiryValue":"0.22", "closestAccessibleValue":"0.22", "activeValue":"0.22" }], "expiryDate":"20150309T10:33:40", "startDate":"20150309T10:33:40", "offerID":111, "productID":111, "subDedicatedAccount":[{"accountValue":[{"currency":"EUR", "value":"11" },{"currency":"RMB", "value":"111" }], "expiryDate":"99991231T08:00:00", "startDate":"99991231T08:00:00" },{"accountValue":[{"currency":"EUR", "value":"22" },{"currency":"RMB", "value":"222" }], "expiryDate":"99991231T08:00:00", "startDate":"99991231T08:00:00" }], "periodicAccountManagementInfo":{"currentPamPeriod":"3", "deferredToDate":"99991231T08:00:00", "lastEvaluationDate":"99991231T08:00:00" }}], "usageCounter":[{"usageCounterID":1, "usageCounterValue":"aaaa", "usageCounterNominalValue":"0.1", "monetaryValue":[{"currency":"EUR", "usageCounterMonetaryValue":"0.1", "usageCounterMonetaryNominalValue":"0.1" },{"currency":"RMB", "usageCounterMonetaryValue":"0.2", "usageCounterMonetaryNominalValue":"0.2" }], "usageThreshold":[{"usageThresholdID":1, "usageThresholdValue":"1", "monetaryValue":[{"currency":"EUR", "usageThresholdMonetaryValue":"1" },{"currency":"RMB", "usageThresholdMonetaryValue":"2" }]}]}]}, "periodicAccountManagementInfo":{"currentPamPeriod":"1", "deferredToDate":"99991231T08:00:00", "lastEvaluationDate":"99991231T08:00:00" }},{"offerID":210, "productName":"productName22", "productIdentifier":"productIdentifier22", "productOwner":"owner22", "productFee":[{"attributeName":"PRICE_FEES_productFee2", "attributeValueDecimal":{"attributeValueNumber":"123455676", "numberOfDecimals":4 }, "attributeSource":0 }], "productID":222, "startDate":"20150302T08:00:00", "expiryDate":"99991231T08:00:00", "offerState":0, "resource":{"dedicateAccount":[{"dedicatedAccountUnitType":1, "accountValue":[{"value":"123", "currency":"RMB" }], "expiryDate":"20150309T10:33:40", "startDate":"20150309T10:33:40", "offerID":222, "productID":0 }]}, "periodicAccountManagementInfo":{"currentPamPeriod":"2", "deferredToDate":"99991231T08:00:00", "lastEvaluationDate":"99991231T08:00:00" }}] } |