Module ocs_rest_res_usage

Description
Function Index
Function Details

This library module implements resource handling functions for a REST server in the ocs application.

Description

This library module implements resource handling functions for a REST server in the ocs application.

Function Index

content_types_accepted/0	Provides list of resource representations accepted.
content_types_provided/0	Provides list of resource representations available.
get_usage/3	Body producing function for `GET /usageManagement/v1/usage/{id}` requests.
get_usagespec/1	Body producing function for `GET /usageManagement/v1/usageSpecification` requests.
get_usagespec/2	Body producing function for `GET /usageManagement/v1/usageSpecification/{id}` requests.
get_ipdr/2	Body producing function for `GET /ocs/v1/log/ipdr/{Type}` requests.
spec_voip/0*
spec_voip6/1*
char_attr_context/2*
characteristic/6*	Construct a log event filter.
build_var_match/1*
merge/2*	Merge a `Match` with existing `Matches`.
operator/1*	Map query filter operatot to match specification guard function.

Function Details

content_types_accepted/0

content_types_accepted() -> ContentTypes

ContentTypes = list()

Provides list of resource representations accepted.

content_types_provided/0

content_types_provided() -> ContentTypes

ContentTypes = list()

Provides list of resource representations available.

get_usage/3

get_usage(Id, Query, Headers) -> Result

Id = string()
Query = [{Key, Value}]
Key = string()
Value = string()
Headers = [tuple()]
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for GET /usageManagement/v1/usage/{id} requests.

get_usagespec/1

get_usagespec(Query) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for GET /usageManagement/v1/usageSpecification requests.

To do

http transfer usage spec

get_usagespec/2

get_usagespec(Id, Query) -> Result

Id = string()
Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for GET /usageManagement/v1/usageSpecification/{id} requests.

To do

http transfer usage spec

get_ipdr/2

get_ipdr(Type, Query) -> Result

Type = wlan | voip
Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for GET /ocs/v1/log/ipdr/{Type} requests.

spec_voip/0 *

spec_voip() -> any()

spec_voip6/1 *

spec_voip6(Acc) -> any()

char_attr_context/2 *

char_attr_context(CCR, Acc) -> any()

characteristic/6 *

characteristic(Filters, Protocols, Types, MatchRequest, MatchResponse, VarNum) -> Result

Filters = [Filter]
Filter = Simple | Complex | Array
Simple = {LHS, Operator, RHS}
LHS = string()
Operator = exact | notexact | like | lt | lte | gt | gte
RHS = integer() | string() | boolean() | Complex | Filters
Complex = {complex, Filters}
Array = {array, Filters}
Protocols = [ocs_log:protocol()] | '_'
Types = [ocs_log:acct_type()] | '_'
MatchRequest = [tuple()] | '_'
MatchResponse = [tuple()] | '_'
VarNum = pos_integer()
Result = {Protocols, Types, MatchRequest, MatchResponse}

throws {error, 400 | 500}

Construct a log event filter.

Filters is as defined in ocs_rest_query_parser.

VarNum is the next available number for a MatchVariable.

Result is used in ocs_log:acct_query/6.

build_var_match/1 *

build_var_match(N) -> any()

merge/2 *

merge(Match, Matches) -> Matches

Matches = [Match] | '_'
Match = RadiusMatch | DiameterMatchSpec | NrfMatchSpec
RadiusMatch = {Attribute, AttributeMatch}
Attribute = byte()
AttributeMatch = tuple()
DiameterMatchSpec = {DiameterMatchHead, MatchConditions}
DiameterMatchHead = #'3gpp_ro_CCR'{} | #'3gpp_ro_CCA'{} | #'3gpp_ro_RAR'{} | #'3gpp_ro_RAA'{} | #'3gpp_gx_CCR'{} | #'3gpp_gx_CCA'{} | #'3gpp_gx_RAR'{} | #'3gpp_gx_RAA'{}
NrfMatchSpec = {NrfMatchHead, MatchConditions}
NrfMatchHead = map()
MatchConditions = [tuple()]

throws {error, 400}

Merge a Match with existing Matches.

operator/1 *

operator(Operator) -> GuardFunction

Operator = exact | notexact | lt | lte | gt | gte
GuardFunction = '=:=' | '=/=' | '>' | '=<' | '<' | '>='

Map query filter operatot to match specification guard function.

An Operator is as defined in ocs_rest_query_parser.

A GuardFunction is a term comparison guard function as defined in match_spec().

Generated by EDoc