F# Data


HttpRequestHeaders

Namespace: FSharp.Data

Headers that can be sent in an HTTP request

Functions and values

Function or valueDescription
Accept(contentType)
Signature: contentType:string -> string * string

Content-Types that are acceptable for the response

AcceptCharset(characterSets)
Signature: characterSets:string -> string * string

Character sets that are acceptable

AcceptDatetime(dateTime)
Signature: dateTime:DateTime -> string * string

Acceptable version in time

AcceptEncoding(encoding)
Signature: encoding:string -> string * string

List of acceptable encodings. See HTTP compression.

AcceptLanguage(language)
Signature: language:string -> string * string

List of acceptable human languages for response

Allow(methods)
Signature: methods:string -> string * string

The Allow header, which specifies the set of HTTP methods supported.

Authorization(credentials)
Signature: credentials:string -> string * string

Authentication credentials for HTTP authentication

BasicAuth username password
Signature: username:string -> password:string -> string * string

Authentication header using Basic Auth encoding

CacheControl(control)
Signature: control:string -> string * string

Used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain

Connection(connection)
Signature: connection:string -> string * string

What type of connection the user-agent would prefer

ContentDisposition(...)
Signature: (placement:string * name:string option * fileName:string option) -> string * string

Describes the placement of the content. Valid dispositions are: inline, attachment, form-data

ContentEncoding(encoding)
Signature: encoding:string -> string * string

The type of encoding used on the data

ContentLanguage(language)
Signature: language:string -> string * string

The language the content is in

ContentLocation(location)
Signature: location:string -> string * string

An alternate location for the returned data

ContentMD5(md5sum)
Signature: md5sum:string -> string * string

A Base64-encoded binary MD5 sum of the content of the request body

ContentRange(range)
Signature: range:string -> string * string

Where in a full body message this partial message belongs

ContentType(contentType)
Signature: contentType:string -> string * string

The MIME type of the body of the request (used with POST and PUT requests)

ContentTypeWithEncoding(...)
Signature: (contentType:string * charset:Encoding) -> string * string

The MIME type of the body of the request (used with POST and PUT requests) with an explicit encoding

Date(date)
Signature: date:DateTime -> string * string

The date and time that the message was sent

Expect(behaviors)
Signature: behaviors:string -> string * string

Indicates that particular server behaviors are required by the client

Expires(dateTime)
Signature: dateTime:DateTime -> string * string

Gives the date/time after which the response is considered stale

From(email)
Signature: email:string -> string * string

The email address of the user making the request

Host(host)
Signature: host:string -> string * string

The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. The port number may be omitted if the port is the standard port for the service requested.

IfMatch(entity)
Signature: entity:string -> string * string

Only perform the action if the client supplied entity matches the same entity on the server. This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it. If-Match: "737060cd8c284d8af7ad3082f209582d" Permanent

IfModifiedSince(dateTime)
Signature: dateTime:DateTime -> string * string

Allows a 304 Not Modified to be returned if content is unchanged

IfNoneMatch(etag)
Signature: etag:string -> string * string

Allows a 304 Not Modified to be returned if content is unchanged

IfRange(range)
Signature: range:string -> string * string

If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity

IfUnmodifiedSince(dateTime)
Signature: dateTime:DateTime -> string * string

Only send the response if the entity has not been modified since a specific time

KeepAlive(keepAlive)
Signature: keepAlive:string -> string * string

Specifies a parameter used into order to maintain a persistent connection

LastModified(dateTime)
Signature: dateTime:DateTime -> string * string

Specifies the date and time at which the accompanying body data was last modified

MaxForwards(count)
Signature: count:int -> string * string

Limit the number of times the message can be forwarded through proxies or gateways

Origin(origin)
Signature: origin:string -> string * string

Initiates a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response header)

Pragma(pragma)
Signature: pragma:string -> string * string

Implementation-specific headers that may have various effects anywhere along the request-response chain.

Prefer(prefer)
Signature: prefer:string -> string * string

Optional instructions to the server to control request processing. See RFC https://tools.ietf.org/html/rfc7240 for more details

ProxyAuthorization(credentials)
Signature: credentials:string -> string * string

Authorization credentials for connecting to a proxy.

Range(start, finish)
Signature: (start:int64 * finish:int64) -> string * string

Request only part of an entity. Bytes are numbered from 0

Referer(referer)
Signature: referer:string -> string * string

This is the address of the previous web page from which a link to the currently requested page was followed. (The word "referrer" is misspelled in the RFC as well as in most implementations.)

TE(te)
Signature: te:string -> string * string

The transfer encodings the user agent is willing to accept: the same values as for the response header Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the server it expects to receive additional headers (the trailers) after the last, zero-sized, chunk.

Trailer(trailer)
Signature: trailer:string -> string * string

The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer-coding

TransferEncoding(directive)
Signature: directive:string -> string * string

The TransferEncoding header indicates the form of encoding used to safely transfer the entity to the user. The valid directives are one of: chunked, compress, deflate, gzip, or identity.

Translate(translate)
Signature: translate:string -> string * string

Microsoft extension to the HTTP specification used in conjunction with WebDAV functionality.

Upgrade(upgrade)
Signature: upgrade:string -> string * string

Specifies additional communications protocols that the client supports.

UserAgent(userAgent)
Signature: userAgent:string -> string * string

The user agent string of the user agent

Via(server)
Signature: server:string -> string * string

Informs the server of proxies through which the request was sent

Warning(message)
Signature: message:string -> string * string

A general warning about possible problems with the entity body

XHTTPMethodOverride(httpMethod)
Signature: httpMethod:string -> string * string

Override HTTP method.

Fork me on GitHub