Module ocs_rest_res_client

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.
head_client/0	Body producing function for `HEAD /ocs/v1/client` requests.
get_clients/2	Body producing function for `GET /ocs/v1/client` requests.
get_client/2	Body producing function for `GET /ocs/v1/client/{id}` requests.
post_client/1	Respond to `POST /ocs/v1/client` and add a new `client` resource.
patch_client/4	Respond to `PATCH /ocs/v1/client/{id}` request and Updates a existing `client`'s password or attributes.
patch_client1/4*
delete_client/1	Respond to `DELETE /ocs/v1/client/{address}` request and deletes a `client` resource.
client/1*

content_types_accepted() -> ContentTypes

Provides list of resource representations accepted.

content_types_provided() -> ContentTypes

Provides list of resource representations available.

head_client() -> Result

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

Body producing function for HEAD /ocs/v1/client requests.

get_clients(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 /ocs/v1/client requests.

get_client(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 /ocs/v1/client/{id} requests.

post_client(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 /ocs/v1/client and add a new client resource.

patch_client(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 /ocs/v1/client/{id} request and Updates a existing client's password or attributes.

patch_client1(Id, Etag, CType, Operations) -> any()

delete_client(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 /ocs/v1/client/{address} request and deletes a client resource. If the deletion is successful return true.

client(Client) -> Result

Client = #client{address = inet:ip_address() | undefined | '_', identifier = binary() | '_', port = inet:port_number() | undefined | '_', protocol = radius | diameter | undefined | '_', secret = binary() | undefined | '_', password_required = boolean() | '_', trusted = boolean() | '_', last_modified = tuple() | undefined | '_'} | {struct, list()}
Result = {struct, list()} | #client{address = inet:ip_address() | undefined | '_', identifier = binary() | '_', port = inet:port_number() | undefined | '_', protocol = radius | diameter | undefined | '_', secret = binary() | undefined | '_', password_required = boolean() | '_', trusted = boolean() | '_', last_modified = tuple() | undefined | '_'}

Generated by EDoc