HP 3PAR StoreServ 7450 4-node HP 3PAR Web Service API 1.2 Developer's - Page 12

Protocol and Message Format, Client HTTP Headers

Page 12 highlights

Protocol and Message Format Clients communicate with the WSAPI server using HTTPS and data structures represented with JSON. The supported JSON character encodings include the following formats: • ASCII • ISO-8859-1 • US-ASCII • UTF-8 • UTF-16 • UTF-32 • UTF-16BE • UTF-32BE • UTF-16LE • UTF-32LE Client HTTP Headers The HTTP requests that clients make to the API server include HTTP headers. Table 1 (page 12) shows the required and optional HTTP headers. Optional headers, when present, must be one of the values listed in the Values column. For example: Accept: application/json; charset=UTF-8 Table 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests Header Accept Description The response format the client can accept. Values Required One of the following: No • application/json • application/* • application/json* • application/+json • */json • */* • */json* • */+json where * is literally an asterisk (*) and is any string of characters. Accept-Language Content-Length The response language the One of the following: client can accept. •* • en • en* The length of the content in Number of bytes bytes. No Yes, for requests with a message body. 12 Accessing the WSAPI

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107

Protocol and Message Format
Clients communicate with the WSAPI server using HTTPS and data structures represented with
JSON. The supported JSON character encodings include the following formats:
ASCII
ISO-8859-1
US-ASCII
UTF-8
UTF-16
UTF-32
UTF-16BE
UTF-32BE
UTF-16LE
UTF-32LE
Client HTTP Headers
The HTTP requests that clients make to the API server include HTTP headers.
Table 1 (page 12)
shows the required and optional HTTP headers. Optional headers, when present, must be one of
the values listed in the
Values
column. For example:
Accept: application/json; charset=UTF-8
Table 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests
Required
Values
Description
Header
No
One of the following:
The response format the
client can accept.
Accept
application/json
application/*
application/json*
application/<anything>+json
*/json
*/*
*/json*
*/<anything>+json
where
*
is literally an asterisk (*)
and
<anything>
is any string of
characters.
No
One of the following:
The response language the
client can accept.
Accept-Language
*
en
en*
Yes, for requests
with a message
body.
Number of bytes
The length of the content in
bytes.
Content-Length
12
Accessing the WSAPI