Module ocs_rest_res_role

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.

Handle Role collection.

content_types_accepted/0	Returns list of resource representations accepted.
content_types_provided/0	Returns list of resource representations available.
post_role/1	Handle `POST` request on `Role` collection.
delete_role/1	Handle `DELETE` request on a `Role` resource.
get_roles/2	Handle `GET` request on `Role` collection.
get_role/2	Handle `GET` request on a `Role` resource.
role/1*	CODEC for HTTP server users.

content_types_accepted() -> ContentTypes

Returns list of resource representations accepted.

content_types_provided() -> ContentTypes

Returns list of resource representations available.

post_role(RequestBody) -> Result

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

Handle POST request on Role collection. Respond to POST /partyRoleManagement/v4/partyRole request.

delete_role(Name) -> Result

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

Handle DELETE request on a Role resource. Respond to DELETE /partyRoleManagement/v4/partyRole/{Name} request.

get_roles(Query, Headers) -> Result

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

Handle GET request on Role collection. Respond to GET /partyRoleManagement/v4/partyRole/ request.

get_role(Name, Query) -> Result

Name = 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()

Handle GET request on a Role resource. Respond to GET /partyRoleManagement/v4/partyRole/{Name} request.

role(Role) -> Role

CODEC for HTTP server users.

Generated by EDoc