Http.Request

Http.Request allows you to create http requests with jsonapi objects.

The request functions will return a RemoteData with a jsonapi Document. The content-type used in the request headers is application/vnd.api+json according to the jsonapi specification.

Definitions

type alias Request meta data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

}

Defines a Request with a url, some headers, a body, and a jsonapi document decoder. metaand data are types used by the jsonapi document that represent the meta object you would like to decode, and the data object you would like to decode

type alias RequestCustomData data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder : Decoder (Result (List Error) data)

}

Defines a Request with a url, some headers, a body, and a custom decoder. data is the type of the object you would like to decode.

type alias RequestNoContent =

{ url : Url

, headers : List Header

, body : Value

}

Defines a Request with a url, some headers, and a body. There is no content decoder. Useful for DELETE requests for instance.

type alias RequestFiles meta data msg =

{ url : Url

, headers : List Header

, multipartNames : List String

, files : List File

, multipartEncoder : String -> File -> Part

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

, tracker : Maybe String

, msg : RemoteData RequestError (Document meta data) -> msg

}

Defines a Request with a url, some headers, a list of files, and a custom decoder. data is the type of the object you would like to decode.

type alias RequestAdv meta data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

, risky : Bool

}

Defines a RequestAdv with a url, some headers, a body, and a jsonapi document decoder. metaand data are types used by the jsonapi document that represent the meta object you would like to decode, and the data object you would like to decode? Risky uses the withCredentials

type alias RequestEx meta data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

, extractHeaders : List String

}

Defines a RequestEx with a url, some headers, a body, and a jsonapi document decoder. metaand data are types used by the jsonapi document that represent the meta object you would like to decode, and the data object you would like to decode. You can also extract some response headers to use them later

type alias RequestCustomDataEx data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder : Decoder (Result (List Error) data)

, extractHeaders : List String

}

Defines a Request with a url, some headers, a body, and a custom decoder. data is the type of the object you would like to decode. You can also extract some response headers to use them later

type alias RequestNoContentEx =

{ url : Url

, headers : List Header

, body : Value

, extractHeaders : List String

}

Defines a Request with a url, some headers, and a body. There is no content decoder. Useful for DELETE requests for instance. You can also extract some response headers to use them later

type alias RequestFilesEx meta data msg =

{ url : Url

, headers : List Header

, multipartNames : List String

, files : List File

, multipartEncoder : String -> File -> Part

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

, tracker : Maybe String

, extractHeaders : List String

, msg :

RemoteData

( RequestError, List ( String, String ) )

( Document meta data, List ( String, String ) )

-> msg

}

Defines a Request with a url, some headers, a list of files, and a custom decoder. data is the type of the object you would like to decode. You can also extract some response headers to use them later

type alias RequestAdvEx meta data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

, extractHeaders : List String

, risky : Bool

}

Defines a RequestAdvEx with a url, some headers, a body, and a jsonapi document decoder. metaand data are types used by the jsonapi document that represent the meta object you would like to decode, and the data object you would like to decode. You can also extract some response headers to use them later Risky uses the withCredentials

type alias RequestFilesAdv meta data msg =

{ url : Url

, headers : List Header

, multipartNames : List String

, files : List File

, multipartEncoder : String -> File -> Part

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

, tracker : Maybe String

, msg : RemoteData RequestError (Document meta data) -> msg

, risky : Bool

}

Defines an advance Request with a url, some headers, a list of files, and a custom decoder. data is the type of the object you would like to decode. Risky uses the withCredentials

type alias RequestFilesAdvEx meta data msg =

{ url : Url

, headers : List Header

, multipartNames : List String

, files : List File

, multipartEncoder : String -> File -> Part

, documentDecoder :

Decoder (Result (List Error) (Document meta data))

, tracker : Maybe String

, extractHeaders : List String

, msg :

RemoteData

( RequestError, List ( String, String ) )

( Document meta data, List ( String, String ) )

-> msg

, risky : Bool

}

Defines an advance Request with a url, some headers, a list of files, and a custom decoder. data is the type of the object you would like to decode. You can also extract some response headers to use them later Risky uses the withCredentials

type alias RequestCustomDataAdv data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder : Decoder (Result (List Error) data)

, risky : Bool

}

Defines an advance Request with a url, some headers, a body, and a custom decoder. data is the type of the object you would like to decode. Risky uses the withCredentials

type alias RequestCustomDataAdvEx data =

{ url : Url

, headers : List Header

, body : Value

, documentDecoder : Decoder (Result (List Error) data)

, extractHeaders : List String

, risky : Bool

}

Defines an advance Request with a url, some headers, a body, and a custom decoder. data is the type of the object you would like to decode. You can also extract some response headers to use them later Risky uses the withCredentials

type AdvanceContent meta data

= DocumentContent (Document meta data)

| NoContent

Type used to specify the content received from an advanced request like requestAdv or requestAdvEx Possible values are:

We received a JsonAPI Document
We received no content (a 204 response from the API)

Requests

request :

Request meta data

-> Task Never (RemoteData RequestError (Document meta data))

Create a request task that will decode a jsonapi object

requestCustomData :

RequestCustomData data

-> Task Never (RemoteData RequestError data)

Create a request task that will decode a custom object

requestNoContent : RequestNoContent -> Task Never (RemoteData RequestError ())

Create a request task that will expect nothing to decode

requestFiles : RequestFiles meta data msg -> Cmd msg

Create a request files that will decode a jsonapi object

requestAdv :

RequestAdv meta data

-> Task Never (RemoteData RequestError (AdvanceContent meta data))

Create an advanced request task that will decode an advance content: a jsonapi document or no content

requestEx :

RequestEx meta data

-> Task

Never

(RemoteData

( RequestError, List ( String, String ) )

( Document meta data, List ( String, String ) )

)

Create a request task that will decode a jsonapi object. It will also return in the msg the list of extracted headers.

requestCustomDataEx :

RequestCustomDataEx data

-> Task

Never

(RemoteData

( RequestError, List ( String, String ) )

( data, List ( String, String ) )

)

Create a request task that will decode a custom object. It will also return in the msg the list of extracted headers.

requestNoContentEx :

RequestNoContentEx

-> Task

Never

(RemoteData

( RequestError, List ( String, String ) )

(List ( String, String ))

)

Create a request task that will expect nothing to decode. It will also return in the msg the list of extracted headers.

requestFilesEx : RequestFilesEx meta data msg -> Cmd msg

Create a request files that will decode a jsonapi object. It will also return in the msg the list of extracted headers.

requestAdvEx :

RequestAdvEx meta data

-> Task

Never

(RemoteData

( RequestError, List ( String, String ) )

( AdvanceContent meta data, List ( String, String ) )

)

Create a request task that will decode an advance content: a jsonapi document or no content. It will also return in the msg the list of extracted headers.

requestCustomDataAdv :

RequestCustomDataAdv data

-> Task Never (RemoteData RequestError data)

Create a request task that will decode a custom object

requestCustomDataAdvEx :

RequestCustomDataAdvEx data

-> Task

Never

(RemoteData

( RequestError, List ( String, String ) )

( data, List ( String, String ) )

)

Create a request task that will decode a custom object. It will also return in the msg the list of extracted headers.

requestFilesAdv : RequestFilesAdv meta data msg -> Cmd msg

Create a request files that will decode a jsonapi object

requestFilesAdvEx : RequestFilesAdvEx meta data msg -> Cmd msg

Create a request files that will decode a jsonapi object. It will also return in the msg the list of extracted headers.

FabienHenon/jsonapi-http/2.0.0

Http.Request

Definitions

Requests

Modules