Module ocs_rest_res_user

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.
get_users/2	Body producing function for `GET /partyManagement/v1/individual` requests.
get_user/2	Body producing function for `GET /partyManagement/v1/individual/{id}` requests.
post_user/1	Respond to `POST /partyManagement/v1/individual` and add a new `User` resource.
patch_user/4	Respond to `PATCH /partyManagement/v1/individual/{id}` request and update an existing `user`'s characteristics.
delete_user/1	Respond to `DELETE /partyManagement/v1/individual/{id}` request and delete an existing `user`.
get_params/0	Get httpd configuration parameters.
user/1	CODEC for HTTP server users.

content_types_accepted() -> ContentTypes

Provides list of resource representations accepted.

content_types_provided() -> ContentTypes

Provides list of resource representations available.

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

Body producing function for GET /partyManagement/v1/individual requests.

get_user(Id, Query) -> Result

Id = string()
Query = [{Key::string(), Value::string()}]
Result = {ok, Headers::[tuple()], Body::iolist()} | {error, ErrorCode::integer()}

Body producing function for GET /partyManagement/v1/individual/{id} requests.

post_user(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 /partyManagement/v1/individual and add a new User resource.

patch_user(ID, Etag, ContentType, ReqBody) -> Result

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

Respond to PATCH /partyManagement/v1/individual/{id} request and update an existing user's characteristics.

delete_user(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 /partyManagement/v1/individual/{id} request and delete an existing user.

get_params() -> Result

Get httpd configuration parameters.

user(User) -> User

CODEC for HTTP server users.

Generated by EDoc