Module ocs_rest_res_hub_user

Function Index

content_types_accepted/0	Provides list of resource representations accepted.
content_types_provided/0	Provides list of resource representations available.
delete_hub/1	Respond to `POST /partyManagement/v1/hub/{id}`
post_hub/2	Respond to `POST /partyManagement/v1/hub`
get_hubs/0	Body producing function for `GET\|HEAD /partyManagement/v1/hub/`
get_hub/1	Body producing function for `GET\|HEAD /partyManagement/v1/hub/{id}`
hub/1	CODEC for hub.

content_types_accepted() -> ContentTypes

Provides list of resource representations accepted.

content_types_provided() -> ContentTypes

Provides list of resource representations available.

delete_hub(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 POST /partyManagement/v1/hub/{id}

post_hub(ReqBody, Authorization) -> Result

ReqBody = string()
Authorization = 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/hub

get_hubs() -> 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 GET|HEAD /partyManagement/v1/hub/

get_hub(Id) -> Result

Id = 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|HEAD /partyManagement/v1/hub/{id}

hub(Hub) -> Hub

Hub = #hub{callback = string() | undefined, id = string() | undefined, href = string() | undefined, query = string() | undefined} | #{}

CODEC for hub.

Generated by EDoc