FSharp.Data


HttpRequestHeaders Module

Headers that can be sent in an HTTP request

Functions and values

Function or value Description

Accept contentType

Full Usage: Accept contentType

Parameters:
    contentType : string

Returns: string * string

Content-Types that are acceptable for the response

contentType : string
Returns: string * string

AcceptCharset characterSets

Full Usage: AcceptCharset characterSets

Parameters:
    characterSets : string

Returns: string * string

Character sets that are acceptable

characterSets : string
Returns: string * string

AcceptDatetime dateTime

Full Usage: AcceptDatetime dateTime

Parameters:
Returns: string * string

Acceptable version in time

dateTime : DateTime
Returns: string * string

AcceptEncoding encoding

Full Usage: AcceptEncoding encoding

Parameters:
    encoding : string

Returns: string * string

List of acceptable encodings. See HTTP compression.

encoding : string
Returns: string * string

AcceptLanguage language

Full Usage: AcceptLanguage language

Parameters:
    language : string

Returns: string * string

List of acceptable human languages for response

language : string
Returns: string * string

Allow methods

Full Usage: Allow methods

Parameters:
    methods : string

Returns: string * string

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

methods : string
Returns: string * string

Authorization credentials

Full Usage: Authorization credentials

Parameters:
    credentials : string

Returns: string * string

Authentication credentials for HTTP authentication

credentials : string
Returns: string * string

BasicAuth username password

Full Usage: BasicAuth username password

Parameters:
    username : string
    password : string

Returns: string * string

Authentication header using Basic Auth encoding

username : string
password : string
Returns: string * string

CacheControl control

Full Usage: CacheControl control

Parameters:
    control : string

Returns: string * string

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

control : string
Returns: string * string

Connection connection

Full Usage: Connection connection

Parameters:
    connection : string

Returns: string * string

What type of connection the user-agent would prefer

connection : string
Returns: string * string

ContentDisposition (placement, name, fileName)

Full Usage: ContentDisposition (placement, name, fileName)

Parameters:
    placement : string
    name : string option
    fileName : string option

Returns: string * string

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

placement : string
name : string option
fileName : string option
Returns: string * string

ContentEncoding encoding

Full Usage: ContentEncoding encoding

Parameters:
    encoding : string

Returns: string * string

The type of encoding used on the data

encoding : string
Returns: string * string

ContentLanguage language

Full Usage: ContentLanguage language

Parameters:
    language : string

Returns: string * string

The language the content is in

language : string
Returns: string * string

ContentLocation location

Full Usage: ContentLocation location

Parameters:
    location : string

Returns: string * string

An alternate location for the returned data

location : string
Returns: string * string

ContentMD5 md5sum

Full Usage: ContentMD5 md5sum

Parameters:
    md5sum : string

Returns: string * string

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

md5sum : string
Returns: string * string

ContentRange range

Full Usage: ContentRange range

Parameters:
    range : string

Returns: string * string

Where in a full body message this partial message belongs

range : string
Returns: string * string

ContentType contentType

Full Usage: ContentType contentType

Parameters:
    contentType : string

Returns: string * string

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

contentType : string
Returns: string * string

ContentTypeWithEncoding (contentType, charset)

Full Usage: ContentTypeWithEncoding (contentType, charset)

Parameters:
    contentType : string
    charset : Encoding

Returns: string * string

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

contentType : string
charset : Encoding
Returns: string * string

Date date

Full Usage: Date date

Parameters:
Returns: string * string

The date and time that the message was sent

date : DateTime
Returns: string * string

Expect behaviors

Full Usage: Expect behaviors

Parameters:
    behaviors : string

Returns: string * string

Indicates that particular server behaviors are required by the client

behaviors : string
Returns: string * string

Expires dateTime

Full Usage: Expires dateTime

Parameters:
Returns: string * string

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

dateTime : DateTime
Returns: string * string

From email

Full Usage: From email

Parameters:
    email : string

Returns: string * string

The email address of the user making the request

email : string
Returns: string * string

Host host

Full Usage: Host host

Parameters:
    host : string

Returns: 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.

host : string
Returns: string * string

IfMatch entity

Full Usage: IfMatch entity

Parameters:
    entity : string

Returns: 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

entity : string
Returns: string * string

IfModifiedSince dateTime

Full Usage: IfModifiedSince dateTime

Parameters:
Returns: string * string

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

dateTime : DateTime
Returns: string * string

IfNoneMatch etag

Full Usage: IfNoneMatch etag

Parameters:
    etag : string

Returns: string * string

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

etag : string
Returns: string * string

IfRange range

Full Usage: IfRange range

Parameters:
    range : string

Returns: string * string

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

range : string
Returns: string * string

IfUnmodifiedSince dateTime

Full Usage: IfUnmodifiedSince dateTime

Parameters:
Returns: string * string

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

dateTime : DateTime
Returns: string * string

KeepAlive keepAlive

Full Usage: KeepAlive keepAlive

Parameters:
    keepAlive : string

Returns: string * string

Specifies a parameter used into order to maintain a persistent connection

keepAlive : string
Returns: string * string

LastModified dateTime

Full Usage: LastModified dateTime

Parameters:
Returns: string * string

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

dateTime : DateTime
Returns: string * string

MaxForwards count

Full Usage: MaxForwards count

Parameters:
    count : int

Returns: string * string

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

count : int
Returns: string * string

Origin origin

Full Usage: Origin origin

Parameters:
    origin : string

Returns: string * string

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

origin : string
Returns: string * string

Pragma pragma

Full Usage: Pragma pragma

Parameters:
    pragma : string

Returns: string * string

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

pragma : string
Returns: string * string

Prefer prefer

Full Usage: Prefer prefer

Parameters:
    prefer : string

Returns: string * string

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

prefer : string
Returns: string * string

ProxyAuthorization credentials

Full Usage: ProxyAuthorization credentials

Parameters:
    credentials : string

Returns: string * string

Authorization credentials for connecting to a proxy.

credentials : string
Returns: string * string

Range (start, finish)

Full Usage: Range (start, finish)

Parameters:
    start : int64
    finish : int64

Returns: string * string

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

start : int64
finish : int64
Returns: string * string

Referer referer

Full Usage: Referer referer

Parameters:
    referer : string

Returns: 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.)

referer : string
Returns: string * string

TE te

Full Usage: TE te

Parameters:
    te : string

Returns: 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.

te : string
Returns: string * string

Trailer trailer

Full Usage: Trailer trailer

Parameters:
    trailer : string

Returns: 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

trailer : string
Returns: string * string

TransferEncoding directive

Full Usage: TransferEncoding directive

Parameters:
    directive : string

Returns: 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.

directive : string
Returns: string * string

Translate translate

Full Usage: Translate translate

Parameters:
    translate : string

Returns: string * string

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

translate : string
Returns: string * string

Upgrade upgrade

Full Usage: Upgrade upgrade

Parameters:
    upgrade : string

Returns: string * string

Specifies additional communications protocols that the client supports.

upgrade : string
Returns: string * string

UserAgent userAgent

Full Usage: UserAgent userAgent

Parameters:
    userAgent : string

Returns: string * string

The user agent string of the user agent

userAgent : string
Returns: string * string

Via server

Full Usage: Via server

Parameters:
    server : string

Returns: string * string

Informs the server of proxies through which the request was sent

server : string
Returns: string * string

Warning message

Full Usage: Warning message

Parameters:
    message : string

Returns: string * string

A general warning about possible problems with the entity body

message : string
Returns: string * string

XHTTPMethodOverride httpMethod

Full Usage: XHTTPMethodOverride httpMethod

Parameters:
    httpMethod : string

Returns: string * string

Override HTTP method.

httpMethod : string
Returns: string * string