Word

get

A call of a service with the method GET.

Example

TypeScript
calls: { getCharge: get('/v1/charges/{id}', { input: { id: text() } }) }

Options

OptionMeans
option.get.aboutOne sentence on what the call is for.
option.get.bodyHow the fields that are left are sent as the body.
option.get.changesThe builder's word on whether the call changes anything at the service.
option.get.filesHow a file of the answer is handed on.
option.get.headersThe fields that are sent as headers, each under its name.
option.get.inputThe fields that the call is handed.
option.get.listsHow a list is written after the question mark.
option.get.outputThe type of the answer of the call.
option.get.queryThe fields that are written after the question mark of the address.
option.get.sendsThe builder's word on whether the call sends data out.

Returns

The record of the call: its method, its path and what it states.

See also

word.service, word.request