Documentation
¶
Index ¶
- Constants
- type IndexOffices
- type IndexOfficesBadRequest
- type IndexOfficesHandler
- type IndexOfficesHandlerFunc
- type IndexOfficesInternalServerError
- type IndexOfficesNotFound
- type IndexOfficesOK
- func (o *IndexOfficesOK) SetContentRange(contentRange string)
- func (o *IndexOfficesOK) SetPayload(payload adminmessages.TransportationOffices)
- func (o *IndexOfficesOK) WithContentRange(contentRange string) *IndexOfficesOK
- func (o *IndexOfficesOK) WithPayload(payload adminmessages.TransportationOffices) *IndexOfficesOK
- func (o *IndexOfficesOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type IndexOfficesParams
- type IndexOfficesURL
- func (o *IndexOfficesURL) Build() (*url.URL, error)
- func (o *IndexOfficesURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *IndexOfficesURL) Must(u *url.URL, err error) *url.URL
- func (o *IndexOfficesURL) SetBasePath(bp string)
- func (o *IndexOfficesURL) String() string
- func (o *IndexOfficesURL) StringFull(scheme, host string) string
- func (o *IndexOfficesURL) WithBasePath(bp string) *IndexOfficesURL
- type IndexOfficesUnauthorized
Constants ¶
const IndexOfficesBadRequestCode int = 400
IndexOfficesBadRequestCode is the HTTP code returned for type IndexOfficesBadRequest
const IndexOfficesInternalServerErrorCode int = 500
IndexOfficesInternalServerErrorCode is the HTTP code returned for type IndexOfficesInternalServerError
const IndexOfficesNotFoundCode int = 404
IndexOfficesNotFoundCode is the HTTP code returned for type IndexOfficesNotFound
const IndexOfficesOKCode int = 200
IndexOfficesOKCode is the HTTP code returned for type IndexOfficesOK
IndexOfficesUnauthorizedCode is the HTTP code returned for type IndexOfficesUnauthorized
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IndexOffices ¶
type IndexOffices struct {
Context *middleware.Context
Handler IndexOfficesHandler
}
IndexOffices swagger:route GET /offices Transportation offices indexOffices
List Transportation Offices ¶
This endpoint returns a list of Transportation Offices. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.
func NewIndexOffices ¶
func NewIndexOffices(ctx *middleware.Context, handler IndexOfficesHandler) *IndexOffices
NewIndexOffices creates a new http.Handler for the index offices operation
func (*IndexOffices) ServeHTTP ¶
func (o *IndexOffices) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type IndexOfficesBadRequest ¶
type IndexOfficesBadRequest struct {
}
IndexOfficesBadRequest invalid request
swagger:response indexOfficesBadRequest
func NewIndexOfficesBadRequest ¶
func NewIndexOfficesBadRequest() *IndexOfficesBadRequest
NewIndexOfficesBadRequest creates IndexOfficesBadRequest with default headers values
func (*IndexOfficesBadRequest) WriteResponse ¶
func (o *IndexOfficesBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOfficesHandler ¶
type IndexOfficesHandler interface {
Handle(IndexOfficesParams) middleware.Responder
}
IndexOfficesHandler interface for that can handle valid index offices params
type IndexOfficesHandlerFunc ¶
type IndexOfficesHandlerFunc func(IndexOfficesParams) middleware.Responder
IndexOfficesHandlerFunc turns a function with the right signature into a index offices handler
func (IndexOfficesHandlerFunc) Handle ¶
func (fn IndexOfficesHandlerFunc) Handle(params IndexOfficesParams) middleware.Responder
Handle executing the request and returning a response
type IndexOfficesInternalServerError ¶
type IndexOfficesInternalServerError struct {
}
IndexOfficesInternalServerError server error
swagger:response indexOfficesInternalServerError
func NewIndexOfficesInternalServerError ¶
func NewIndexOfficesInternalServerError() *IndexOfficesInternalServerError
NewIndexOfficesInternalServerError creates IndexOfficesInternalServerError with default headers values
func (*IndexOfficesInternalServerError) WriteResponse ¶
func (o *IndexOfficesInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOfficesNotFound ¶
type IndexOfficesNotFound struct {
}
IndexOfficesNotFound Transportation Office not found
swagger:response indexOfficesNotFound
func NewIndexOfficesNotFound ¶
func NewIndexOfficesNotFound() *IndexOfficesNotFound
NewIndexOfficesNotFound creates IndexOfficesNotFound with default headers values
func (*IndexOfficesNotFound) WriteResponse ¶
func (o *IndexOfficesNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOfficesOK ¶
type IndexOfficesOK struct {
/*Used for pagination
*/
ContentRange string `json:"Content-Range"`
/*
In: Body
*/
Payload adminmessages.TransportationOffices `json:"body,omitempty"`
}
IndexOfficesOK success
swagger:response indexOfficesOK
func NewIndexOfficesOK ¶
func NewIndexOfficesOK() *IndexOfficesOK
NewIndexOfficesOK creates IndexOfficesOK with default headers values
func (*IndexOfficesOK) SetContentRange ¶
func (o *IndexOfficesOK) SetContentRange(contentRange string)
SetContentRange sets the contentRange to the index offices o k response
func (*IndexOfficesOK) SetPayload ¶
func (o *IndexOfficesOK) SetPayload(payload adminmessages.TransportationOffices)
SetPayload sets the payload to the index offices o k response
func (*IndexOfficesOK) WithContentRange ¶
func (o *IndexOfficesOK) WithContentRange(contentRange string) *IndexOfficesOK
WithContentRange adds the contentRange to the index offices o k response
func (*IndexOfficesOK) WithPayload ¶
func (o *IndexOfficesOK) WithPayload(payload adminmessages.TransportationOffices) *IndexOfficesOK
WithPayload adds the payload to the index offices o k response
func (*IndexOfficesOK) WriteResponse ¶
func (o *IndexOfficesOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOfficesParams ¶
type IndexOfficesParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*
In: query
*/
Filter *string
/*
In: query
*/
Order *bool
/*
In: query
*/
Page *int64
/*
In: query
*/
PerPage *int64
/*
In: query
*/
Sort *string
}
IndexOfficesParams contains all the bound params for the index offices operation typically these are obtained from a http.Request
swagger:parameters indexOffices
func NewIndexOfficesParams ¶
func NewIndexOfficesParams() IndexOfficesParams
NewIndexOfficesParams creates a new IndexOfficesParams object
There are no default values defined in the spec.
func (*IndexOfficesParams) BindRequest ¶
func (o *IndexOfficesParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewIndexOfficesParams() beforehand.
type IndexOfficesURL ¶
type IndexOfficesURL struct {
Filter *string
Order *bool
Page *int64
PerPage *int64
Sort *string
// contains filtered or unexported fields
}
IndexOfficesURL generates an URL for the index offices operation
func (*IndexOfficesURL) Build ¶
func (o *IndexOfficesURL) Build() (*url.URL, error)
Build a url path and query string
func (*IndexOfficesURL) BuildFull ¶
func (o *IndexOfficesURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*IndexOfficesURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*IndexOfficesURL) SetBasePath ¶
func (o *IndexOfficesURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*IndexOfficesURL) String ¶
func (o *IndexOfficesURL) String() string
String returns the string representation of the path with query string
func (*IndexOfficesURL) StringFull ¶
func (o *IndexOfficesURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*IndexOfficesURL) WithBasePath ¶
func (o *IndexOfficesURL) WithBasePath(bp string) *IndexOfficesURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type IndexOfficesUnauthorized ¶
type IndexOfficesUnauthorized struct {
}
IndexOfficesUnauthorized request requires user authentication
swagger:response indexOfficesUnauthorized
func NewIndexOfficesUnauthorized ¶
func NewIndexOfficesUnauthorized() *IndexOfficesUnauthorized
NewIndexOfficesUnauthorized creates IndexOfficesUnauthorized with default headers values
func (*IndexOfficesUnauthorized) WriteResponse ¶
func (o *IndexOfficesUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
Source Files