Module ocs_rest_res_service

Description
Data Types
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.

Data Types

aka_cred()

aka_cred() = #aka_cred{k = binary(), opc = binary(), dif = integer()}

service_status()

Function Index

content_types_accepted/0	Provides list of resource representations accepted.
content_types_provided/0	Provides list of resource representations available.
add_service/1	Respond to `POST /serviceInventoryManagement/v2/service`.
get_service/1	Respond to `GET /serviceInventoryManagement/v2/service/{id}`.
get_services/2	Respond to `GET /serviceInventoryManagement/v2/service/`.
delete_service/1	Respond to `DELETE /serviceInventoryManagement/v2/service/{id}` request to remove a `Service Inventory`.
patch_service/3	Respond to `PATCH /serviceInventoryManagement/v2/service/{id}`.
get_service_specs/1	Respond to `GET /serviceCatalogManagement/v2/serviceSpecification/`.
get_service_spec/2	Respond to `GET /serviceCatalogManagement/v2/serviceSpecification/{id}`.
service_spec/1*	Get Service Specification by ID.
service/1	CODEC for service inventory item.
start_mode/1*	Codec for Service start mode.
service_state/1*	CODEC for life cycle status of Product instance.
service_chars/1*	CODEC for service characteristics.
radius_reserve/1*	CODEC for top up duration characteristic.

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.

add_service/1

add_service(RequestBody) -> Result

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

Respond to POST /serviceInventoryManagement/v2/service. Add a new Service Inventory.

get_service/1

get_service(Id) -> Result

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

Respond to GET /serviceInventoryManagement/v2/service/{id}. Retrieve a service inventory item.

get_services/2

get_services(Query, RequestHeaders) -> Result

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

Respond to GET /serviceInventoryManagement/v2/service/. Retrieve all Service Inventories.

delete_service/1

delete_service(Id) -> Result

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

Respond to DELETE /serviceInventoryManagement/v2/service/{id} request to remove a Service Inventory.

patch_service/3

patch_service(ServiceId, Etag, RequestBody) -> Result

ServiceId = string()
Etag = undefined | string()
RequestBody = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to PATCH /serviceInventoryManagement/v2/service/{id}. Update a Service Inventory using JSON patch method RFC6902.

get_service_specs/1

get_service_specs(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()

Respond to GET /serviceCatalogManagement/v2/serviceSpecification/. Retrieve all service specifications.

get_service_spec/2

get_service_spec(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()

Respond to GET /serviceCatalogManagement/v2/serviceSpecification/{id}. Retrieve a service specification.

service_spec/1 *

service_spec(ID) -> Result

ID = string()
Result = {struct, [tuple()]} | {error, 404}

Get Service Specification by ID

service/1

service(Service) -> Service

Service = #service{name = binary() | undefined | '_', start_date = pos_integer() | undefined | '_', end_date = pos_integer() | undefined | '_', state = service_status() | undefined | '_', password = binary() | aka_cred() | undefined | '_', attributes = [tuple()] | undefined | '_', product = (ProductRef::string() | undefined | '_'), enabled = boolean() | '_', disconnect = boolean() | '_', session_attributes = [{TS::pos_integer(), Attributes::[tuple()]}] | '_', characteristics = [{Name::string(), Value::term()}] | '_', multisession = boolean() | '_', last_modified = tuple() | undefined | '_'} | {struct, list()}

CODEC for service inventory item.

start_mode/1 *

start_mode(Mode) -> Mode

Mode = 0..5 | atom()

Codec for Service start mode

service_state/1 *

service_state(State) -> State

State = atom() | string()

CODEC for life cycle status of Product instance.

service_chars/1 *

service_chars(ServiceChars) -> ServiceChars

ServiceChars = [tuple()] | {array, list()}

CODEC for service characteristics

radius_reserve/1 *

radius_reserve(RadiusReserve) -> RadiusReserve

RadiusReserve = {struct, list()} | [tuple()]

CODEC for top up duration characteristic

Generated by EDoc