Child pages
  • Response

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryNeeds to be called when not reading content via getResponseBody or getMediaData to be able to reuse the client.Get the charset of the response body.Get the content of response as binary data.Get the content of the response as String.Gets the headers of the response as name/value arrays.Gets the headers of the response as name/value arrays.Gets the status code of the response, the list of the possible values is in HTTP_STATUS constants.Gets the status code's reason phrase.

functionservoy sDetail2100%height:30px2Methods Detailsclosename

close()

dessIndent
Needs to be called when not reading content via getResponseBody or getMediaData
to be able to reuse the client.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetCharsetname

getCharset()

dessIndent
Get the charset of the response body.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMediaDataname

getMediaData()

dessIndent
Get the content of response as binary data. It also supports gzip-ed content.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getResponseBodyname

getResponseBody()

dessIndent
Get the content of the response as String.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getResponseHeadersname

getResponseHeaders()

dessIndent
Gets the headers of the response as name/value arrays.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getResponseHeadersname

getResponseHeaders(headerName)

dessIndent
Gets the headers of the response as name/value arrays.
prs

Parameters

sIndentheaderName ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getStatusCodename

getStatusCode()

dessIndent
Gets the status code of the response, the list of the possible values is in HTTP_STATUS constants.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getStatusReasonPhrasename

getStatusReasonPhrase()

dessIndent
Gets the status code's reason phrase. For example if a response contains status code 403 (Forbidden) it might be useful to know why.

For example a Jenkins API req. could answer with "403 No valid crumb was included in the request" which will let you know
that you simply have to reques a crumb and then put that in the request headers as "Jenkins-Crumb". But you could not know that from 403 status alone...
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow