MPX v0.1.4 Mpx.Http
Provides the base http functionality for Ministry PLatform access including GET, POST, PUT and DELETE
Summary
Functions
Wrapper for the Ministry Platform DELETE Api call
Wrapper for the Ministry Platform GET Api call
Wrapper for the Ministry Platform POST Api call
Wrapper for the Ministry Platform PUT Api call
Types
http :: {atom, map | list} | {atom, term}
Specifies what is returned from all of the HTTP calls
Functions
Specs
delete(binary, binary, Mpx.Tables.delete_options) :: http
Wrapper for the Ministry Platform DELETE Api call
Takes optional keyword list of options:
[ "$select": "The_columns_to_select",
"$filter": "The filter to apply",
etc...
]
see swagger for a complete list of parameters that the MP rest api takes
Returns an HTTPoison.Response
or HTTPoison.Error
Specs
get(binary, binary, keyword(binary)) :: http
Wrapper for the Ministry Platform GET Api call.
Takes optional keyword list of options:
[ "$select": "The_columns_to_select",
"$filter": "The filter to apply",
etc...
]
See swagger for a complete list of parameters that the MP rest api takes.
Returns an HTTPoison.Response
or HTTPoison.Error
Specs
post(binary, binary, map | list, keyword(binary)) :: http
Wrapper for the Ministry Platform POST Api call
Takes optional keyword list of options:
[ "$select": "The_columns_to_select",
"$filter": "The filter to apply",
etc...
]
see swagger for a complete list of parameters that the MP rest api takes.
Returns an HTTPoison.Response
or HTTPoison.Error
Specs
put(binary, binary, map | list, keyword(binary)) :: http
Wrapper for the Ministry Platform PUT Api call
Takes optional keyword list of options:
[ "$select": "The_columns_to_select",
"$filter": "The filter to apply",
etc...
]
see the swagger documentation for a
complete list of parameters that the MP rest api takes.
Returns an HTTPoison.Response
or HTTPoison.Error