Module ocs_rest_res_nrf

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.

content_types_accepted/0	Provides list of resource representations accepted.
content_types_provided/0	Provides list of resource representations available.
initial_nrf/2	Respond to `POST /nrf-rating/v1/ratingdata`.
update_nrf/3	Respond to `POST /nrf-rating/v1/ratingdata/{RatingDataRef}/update`.
release_nrf/3	Respond to `POST /nrf-rating/v1/ratingdata/{RatingDataRef}/release`.
session_id/3*	Construct session attributes which uniquely identify a rating session.

content_types_accepted() -> ContentTypes

Provides list of resource representations accepted.

content_types_provided() -> ContentTypes

Provides list of resource representations available.

initial_nrf(ModData, RatingDataRequest) -> RatingDataResponse

RatingDataRequest = iolist()
ModData = #mod{}
RatingDataResponse = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to POST /nrf-rating/v1/ratingdata.

Rate an intial Nrf Request.

To do

update_nrf(ModData, RatingDataRef, RatingDataRequest) -> RatingDataResponse

ModData = #mod{}
RatingDataRef = string()
RatingDataRequest = iolist()
RatingDataResponse = {200, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to POST /nrf-rating/v1/ratingdata/{RatingDataRef}/update. Rate an interim Nrf Request.

release_nrf(ModData, RatingDataRef, RatingDataRequest) -> RatingDataResponse

ModData = #mod{}
RatingDataRequest = iolist()
RatingDataRef = string()
RatingDataResponse = {200, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to POST /nrf-rating/v1/ratingdata/{RatingDataRef}/release.

Rate a final Nrf Request.

session_id(RatingDataRef, ChargingKeyArg, UpfIdArg) -> SessionAttributes

Construct session attributes which uniquely identify a rating session.

Generated by EDoc