Documentation
¶
Overview ¶
Package request provides the HTTP request functionality for the PHPIPAM API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type APIResponse ¶
type APIResponse struct {
// The HTTP result code.
Code int
// The response data. This is further unmarshaled into the data type set by
// Request.Output.
Data json.RawMessage
// The error message, if the request failed.
Message string
// Whether or not the API request was successful.
Success bool
}
APIResponse represents a PHPIPAM response body. Both successful and unsuccessful requests share the same response format.
type Request ¶
type Request struct {
// The API session.
Session *session.Session
// The request method.
Method string
// The request URI.
URI string
// The request data.
Input interface{}
// The output of the request. This corresponds to the "data" field in a
// response.
Output interface{}
}
Request represents the API request.
func NewRequest ¶
NewRequest creates a new request instance with configuration set.
Click to show internal directories.
Click to hide internal directories.