Documentation ¶
Index ¶
- Constants
- Variables
- type CreateMTOServiceItem
- type CreateMTOServiceItemBadRequest
- func (o *CreateMTOServiceItemBadRequest) SetPayload(payload *primemessages.ClientError)
- func (o *CreateMTOServiceItemBadRequest) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemBadRequest
- func (o *CreateMTOServiceItemBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateMTOServiceItemConflict
- func (o *CreateMTOServiceItemConflict) SetPayload(payload *primemessages.ClientError)
- func (o *CreateMTOServiceItemConflict) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemConflict
- func (o *CreateMTOServiceItemConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateMTOServiceItemForbidden
- func (o *CreateMTOServiceItemForbidden) SetPayload(payload *primemessages.ClientError)
- func (o *CreateMTOServiceItemForbidden) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemForbidden
- func (o *CreateMTOServiceItemForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateMTOServiceItemHandler
- type CreateMTOServiceItemHandlerFunc
- type CreateMTOServiceItemInternalServerError
- func (o *CreateMTOServiceItemInternalServerError) SetPayload(payload *primemessages.Error)
- func (o *CreateMTOServiceItemInternalServerError) WithPayload(payload *primemessages.Error) *CreateMTOServiceItemInternalServerError
- func (o *CreateMTOServiceItemInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateMTOServiceItemNotFound
- func (o *CreateMTOServiceItemNotFound) SetPayload(payload *primemessages.ClientError)
- func (o *CreateMTOServiceItemNotFound) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemNotFound
- func (o *CreateMTOServiceItemNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateMTOServiceItemOK
- type CreateMTOServiceItemParams
- type CreateMTOServiceItemURL
- func (o *CreateMTOServiceItemURL) Build() (*url.URL, error)
- func (o *CreateMTOServiceItemURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *CreateMTOServiceItemURL) Must(u *url.URL, err error) *url.URL
- func (o *CreateMTOServiceItemURL) SetBasePath(bp string)
- func (o *CreateMTOServiceItemURL) String() string
- func (o *CreateMTOServiceItemURL) StringFull(scheme, host string) string
- func (o *CreateMTOServiceItemURL) WithBasePath(bp string) *CreateMTOServiceItemURL
- type CreateMTOServiceItemUnauthorized
- func (o *CreateMTOServiceItemUnauthorized) SetPayload(payload *primemessages.ClientError)
- func (o *CreateMTOServiceItemUnauthorized) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemUnauthorized
- func (o *CreateMTOServiceItemUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateMTOServiceItemUnprocessableEntity
- func (o *CreateMTOServiceItemUnprocessableEntity) SetPayload(payload *primemessages.ValidationError)
- func (o *CreateMTOServiceItemUnprocessableEntity) WithPayload(payload *primemessages.ValidationError) *CreateMTOServiceItemUnprocessableEntity
- func (o *CreateMTOServiceItemUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceRequestDocumentUpload
- type CreateServiceRequestDocumentUploadBadRequest
- func (o *CreateServiceRequestDocumentUploadBadRequest) SetPayload(payload *primemessages.ClientError)
- func (o *CreateServiceRequestDocumentUploadBadRequest) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadBadRequest
- func (o *CreateServiceRequestDocumentUploadBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceRequestDocumentUploadCreated
- func (o *CreateServiceRequestDocumentUploadCreated) SetPayload(payload *primemessages.UploadWithOmissions)
- func (o *CreateServiceRequestDocumentUploadCreated) WithPayload(payload *primemessages.UploadWithOmissions) *CreateServiceRequestDocumentUploadCreated
- func (o *CreateServiceRequestDocumentUploadCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceRequestDocumentUploadForbidden
- func (o *CreateServiceRequestDocumentUploadForbidden) SetPayload(payload *primemessages.ClientError)
- func (o *CreateServiceRequestDocumentUploadForbidden) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadForbidden
- func (o *CreateServiceRequestDocumentUploadForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceRequestDocumentUploadHandler
- type CreateServiceRequestDocumentUploadHandlerFunc
- type CreateServiceRequestDocumentUploadInternalServerError
- func (o *CreateServiceRequestDocumentUploadInternalServerError) SetPayload(payload *primemessages.Error)
- func (o *CreateServiceRequestDocumentUploadInternalServerError) WithPayload(payload *primemessages.Error) *CreateServiceRequestDocumentUploadInternalServerError
- func (o *CreateServiceRequestDocumentUploadInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceRequestDocumentUploadNotFound
- func (o *CreateServiceRequestDocumentUploadNotFound) SetPayload(payload *primemessages.ClientError)
- func (o *CreateServiceRequestDocumentUploadNotFound) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadNotFound
- func (o *CreateServiceRequestDocumentUploadNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceRequestDocumentUploadParams
- type CreateServiceRequestDocumentUploadURL
- func (o *CreateServiceRequestDocumentUploadURL) Build() (*url.URL, error)
- func (o *CreateServiceRequestDocumentUploadURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *CreateServiceRequestDocumentUploadURL) Must(u *url.URL, err error) *url.URL
- func (o *CreateServiceRequestDocumentUploadURL) SetBasePath(bp string)
- func (o *CreateServiceRequestDocumentUploadURL) String() string
- func (o *CreateServiceRequestDocumentUploadURL) StringFull(scheme, host string) string
- func (o *CreateServiceRequestDocumentUploadURL) WithBasePath(bp string) *CreateServiceRequestDocumentUploadURL
- type CreateServiceRequestDocumentUploadUnauthorized
- func (o *CreateServiceRequestDocumentUploadUnauthorized) SetPayload(payload *primemessages.ClientError)
- func (o *CreateServiceRequestDocumentUploadUnauthorized) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadUnauthorized
- func (o *CreateServiceRequestDocumentUploadUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceRequestDocumentUploadUnprocessableEntity
- func (o *CreateServiceRequestDocumentUploadUnprocessableEntity) SetPayload(payload *primemessages.ValidationError)
- func (o *CreateServiceRequestDocumentUploadUnprocessableEntity) WithPayload(payload *primemessages.ValidationError) *CreateServiceRequestDocumentUploadUnprocessableEntity
- func (o *CreateServiceRequestDocumentUploadUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItem
- type UpdateMTOServiceItemBadRequest
- func (o *UpdateMTOServiceItemBadRequest) SetPayload(payload *primemessages.ClientError)
- func (o *UpdateMTOServiceItemBadRequest) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemBadRequest
- func (o *UpdateMTOServiceItemBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItemConflict
- func (o *UpdateMTOServiceItemConflict) SetPayload(payload *primemessages.ClientError)
- func (o *UpdateMTOServiceItemConflict) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemConflict
- func (o *UpdateMTOServiceItemConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItemForbidden
- func (o *UpdateMTOServiceItemForbidden) SetPayload(payload *primemessages.ClientError)
- func (o *UpdateMTOServiceItemForbidden) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemForbidden
- func (o *UpdateMTOServiceItemForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItemHandler
- type UpdateMTOServiceItemHandlerFunc
- type UpdateMTOServiceItemInternalServerError
- func (o *UpdateMTOServiceItemInternalServerError) SetPayload(payload *primemessages.Error)
- func (o *UpdateMTOServiceItemInternalServerError) WithPayload(payload *primemessages.Error) *UpdateMTOServiceItemInternalServerError
- func (o *UpdateMTOServiceItemInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItemNotFound
- func (o *UpdateMTOServiceItemNotFound) SetPayload(payload *primemessages.ClientError)
- func (o *UpdateMTOServiceItemNotFound) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemNotFound
- func (o *UpdateMTOServiceItemNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItemOK
- type UpdateMTOServiceItemParams
- type UpdateMTOServiceItemPreconditionFailed
- func (o *UpdateMTOServiceItemPreconditionFailed) SetPayload(payload *primemessages.ClientError)
- func (o *UpdateMTOServiceItemPreconditionFailed) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemPreconditionFailed
- func (o *UpdateMTOServiceItemPreconditionFailed) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItemURL
- func (o *UpdateMTOServiceItemURL) Build() (*url.URL, error)
- func (o *UpdateMTOServiceItemURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *UpdateMTOServiceItemURL) Must(u *url.URL, err error) *url.URL
- func (o *UpdateMTOServiceItemURL) SetBasePath(bp string)
- func (o *UpdateMTOServiceItemURL) String() string
- func (o *UpdateMTOServiceItemURL) StringFull(scheme, host string) string
- func (o *UpdateMTOServiceItemURL) WithBasePath(bp string) *UpdateMTOServiceItemURL
- type UpdateMTOServiceItemUnauthorized
- func (o *UpdateMTOServiceItemUnauthorized) SetPayload(payload *primemessages.ClientError)
- func (o *UpdateMTOServiceItemUnauthorized) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemUnauthorized
- func (o *UpdateMTOServiceItemUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOServiceItemUnprocessableEntity
- func (o *UpdateMTOServiceItemUnprocessableEntity) SetPayload(payload *primemessages.ValidationError)
- func (o *UpdateMTOServiceItemUnprocessableEntity) WithPayload(payload *primemessages.ValidationError) *UpdateMTOServiceItemUnprocessableEntity
- func (o *UpdateMTOServiceItemUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
Constants ¶
const CreateMTOServiceItemBadRequestCode int = 400
CreateMTOServiceItemBadRequestCode is the HTTP code returned for type CreateMTOServiceItemBadRequest
const CreateMTOServiceItemConflictCode int = 409
CreateMTOServiceItemConflictCode is the HTTP code returned for type CreateMTOServiceItemConflict
const CreateMTOServiceItemForbiddenCode int = 403
CreateMTOServiceItemForbiddenCode is the HTTP code returned for type CreateMTOServiceItemForbidden
const CreateMTOServiceItemInternalServerErrorCode int = 500
CreateMTOServiceItemInternalServerErrorCode is the HTTP code returned for type CreateMTOServiceItemInternalServerError
const CreateMTOServiceItemNotFoundCode int = 404
CreateMTOServiceItemNotFoundCode is the HTTP code returned for type CreateMTOServiceItemNotFound
const CreateMTOServiceItemOKCode int = 200
CreateMTOServiceItemOKCode is the HTTP code returned for type CreateMTOServiceItemOK
CreateMTOServiceItemUnauthorizedCode is the HTTP code returned for type CreateMTOServiceItemUnauthorized
const CreateMTOServiceItemUnprocessableEntityCode int = 422
CreateMTOServiceItemUnprocessableEntityCode is the HTTP code returned for type CreateMTOServiceItemUnprocessableEntity
const CreateServiceRequestDocumentUploadBadRequestCode int = 400
CreateServiceRequestDocumentUploadBadRequestCode is the HTTP code returned for type CreateServiceRequestDocumentUploadBadRequest
const CreateServiceRequestDocumentUploadCreatedCode int = 201
CreateServiceRequestDocumentUploadCreatedCode is the HTTP code returned for type CreateServiceRequestDocumentUploadCreated
const CreateServiceRequestDocumentUploadForbiddenCode int = 403
CreateServiceRequestDocumentUploadForbiddenCode is the HTTP code returned for type CreateServiceRequestDocumentUploadForbidden
const CreateServiceRequestDocumentUploadInternalServerErrorCode int = 500
CreateServiceRequestDocumentUploadInternalServerErrorCode is the HTTP code returned for type CreateServiceRequestDocumentUploadInternalServerError
const CreateServiceRequestDocumentUploadNotFoundCode int = 404
CreateServiceRequestDocumentUploadNotFoundCode is the HTTP code returned for type CreateServiceRequestDocumentUploadNotFound
CreateServiceRequestDocumentUploadUnauthorizedCode is the HTTP code returned for type CreateServiceRequestDocumentUploadUnauthorized
const CreateServiceRequestDocumentUploadUnprocessableEntityCode int = 422
CreateServiceRequestDocumentUploadUnprocessableEntityCode is the HTTP code returned for type CreateServiceRequestDocumentUploadUnprocessableEntity
const UpdateMTOServiceItemBadRequestCode int = 400
UpdateMTOServiceItemBadRequestCode is the HTTP code returned for type UpdateMTOServiceItemBadRequest
const UpdateMTOServiceItemConflictCode int = 409
UpdateMTOServiceItemConflictCode is the HTTP code returned for type UpdateMTOServiceItemConflict
const UpdateMTOServiceItemForbiddenCode int = 403
UpdateMTOServiceItemForbiddenCode is the HTTP code returned for type UpdateMTOServiceItemForbidden
const UpdateMTOServiceItemInternalServerErrorCode int = 500
UpdateMTOServiceItemInternalServerErrorCode is the HTTP code returned for type UpdateMTOServiceItemInternalServerError
const UpdateMTOServiceItemNotFoundCode int = 404
UpdateMTOServiceItemNotFoundCode is the HTTP code returned for type UpdateMTOServiceItemNotFound
const UpdateMTOServiceItemOKCode int = 200
UpdateMTOServiceItemOKCode is the HTTP code returned for type UpdateMTOServiceItemOK
const UpdateMTOServiceItemPreconditionFailedCode int = 412
UpdateMTOServiceItemPreconditionFailedCode is the HTTP code returned for type UpdateMTOServiceItemPreconditionFailed
UpdateMTOServiceItemUnauthorizedCode is the HTTP code returned for type UpdateMTOServiceItemUnauthorized
const UpdateMTOServiceItemUnprocessableEntityCode int = 422
UpdateMTOServiceItemUnprocessableEntityCode is the HTTP code returned for type UpdateMTOServiceItemUnprocessableEntity
Variables ¶
var CreateServiceRequestDocumentUploadMaxParseMemory int64 = 32 << 20
CreateServiceRequestDocumentUploadMaxParseMemory sets the maximum size in bytes for the multipart form parser for this operation.
The default value is 32 MB. The multipart parser stores up to this + 10MB.
Functions ¶
This section is empty.
Types ¶
type CreateMTOServiceItem ¶
type CreateMTOServiceItem struct { Context *middleware.Context Handler CreateMTOServiceItemHandler }
CreateMTOServiceItem swagger:route POST /mto-service-items mtoServiceItem createMTOServiceItem
createMTOServiceItem
Creates one or more MTOServiceItems. Not all service items may be created, please see details below.
This endpoint supports different body definitions. In the modelType field below, select the modelType corresponding
to the service item you wish to create and the documentation will update with the new definition.
Upon creation these items are associated with a Move Task Order and an MTO Shipment. The request must include UUIDs for the MTO and MTO Shipment connected to this service item. Some service item types require additional service items to be autogenerated when added - all created service items, autogenerated included, will be returned in the response.
To update a service item, please use [updateMTOServiceItem](#operation/updateMTOServiceItem) endpoint.
---
**`MTOServiceItemOriginSIT`**
MTOServiceItemOriginSIT is a subtype of MTOServiceItem.
This model type describes a domestic origin SIT service item. Items can be created using this model type with the following codes:
**DOFSIT**
**1st day origin SIT service item**. When a DOFSIT is requested, the API will auto-create the following group of service items:
- DOFSIT - Domestic origin 1st day SIT
- DOASIT - Domestic origin Additional day SIT
- DOPSIT - Domestic origin SIT pickup
- DOSFSC - Domestic origin SIT fuel surcharge
**DOASIT**
**Addt'l days origin SIT service item**. This represents an additional day of storage for the same item. Additional DOASIT service items can be created and added to an existing shipment that **includes a DOFSIT service item**.
---
**`MTOServiceItemDestSIT`**
MTOServiceItemDestSIT is a subtype of MTOServiceItem.
This model type describes a domestic destination SIT service item. Items can be created using this model type with the following codes:
**DDFSIT**
**1st day destination SIT service item**.
These additional fields are optional for creating a DDFSIT:
- `firstAvailableDeliveryDate1`
- string <date>
- First available date that Prime can deliver SIT service item.
- firstAvailableDeliveryDate1, dateOfContact1, and timeMilitary1 are required together
- `dateOfContact1`
- string <date>
- Date of attempted contact by the prime corresponding to `timeMilitary1`
- dateOfContact1, timeMilitary1, and firstAvailableDeliveryDate1 are required together
- `timeMilitary1`
- string\d{4}Z
- Time of attempted contact corresponding to `dateOfContact1`, in military format.
- timeMilitary1, dateOfContact1, and firstAvailableDeliveryDate1 are required together
- `firstAvailableDeliveryDate2`
- string <date>
- Second available date that Prime can deliver SIT service item.
- firstAvailableDeliveryDate2, dateOfContact2, and timeMilitary2 are required together
- `dateOfContact2`
- string <date>
- Date of attempted contact delivery by the prime corresponding to `timeMilitary2`
- dateOfContact2, timeMilitary2, and firstAvailableDeliveryDate2 are required together
- `timeMilitary2`
- string\d{4}Z
- Time of attempted contact corresponding to `dateOfContact2`, in military format.
- timeMilitary2, dateOfContact2, and firstAvailableDeliveryDate2 are required together
When a DDFSIT is requested, the API will auto-create the following group of service items:
- DDFSIT - Domestic destination 1st day SIT
- DDASIT - Domestic destination Additional day SIT
- DDDSIT - Domestic destination SIT delivery
- DDSFSC - Domestic destination SIT fuel surcharge
**DDASIT**
**Addt'l days destination SIT service item**. This represents an additional day of storage for the same item. Additional DDASIT service items can be created and added to an existing shipment that **includes a DDFSIT service item**.
func NewCreateMTOServiceItem ¶
func NewCreateMTOServiceItem(ctx *middleware.Context, handler CreateMTOServiceItemHandler) *CreateMTOServiceItem
NewCreateMTOServiceItem creates a new http.Handler for the create m t o service item operation
func (*CreateMTOServiceItem) ServeHTTP ¶
func (o *CreateMTOServiceItem) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type CreateMTOServiceItemBadRequest ¶
type CreateMTOServiceItemBadRequest struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
CreateMTOServiceItemBadRequest The request payload is invalid.
swagger:response createMTOServiceItemBadRequest
func NewCreateMTOServiceItemBadRequest ¶
func NewCreateMTOServiceItemBadRequest() *CreateMTOServiceItemBadRequest
NewCreateMTOServiceItemBadRequest creates CreateMTOServiceItemBadRequest with default headers values
func (*CreateMTOServiceItemBadRequest) SetPayload ¶
func (o *CreateMTOServiceItemBadRequest) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create m t o service item bad request response
func (*CreateMTOServiceItemBadRequest) WithPayload ¶
func (o *CreateMTOServiceItemBadRequest) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemBadRequest
WithPayload adds the payload to the create m t o service item bad request response
func (*CreateMTOServiceItemBadRequest) WriteResponse ¶
func (o *CreateMTOServiceItemBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateMTOServiceItemConflict ¶
type CreateMTOServiceItemConflict struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
CreateMTOServiceItemConflict The request could not be processed because of conflict in the current state of the resource.
swagger:response createMTOServiceItemConflict
func NewCreateMTOServiceItemConflict ¶
func NewCreateMTOServiceItemConflict() *CreateMTOServiceItemConflict
NewCreateMTOServiceItemConflict creates CreateMTOServiceItemConflict with default headers values
func (*CreateMTOServiceItemConflict) SetPayload ¶
func (o *CreateMTOServiceItemConflict) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create m t o service item conflict response
func (*CreateMTOServiceItemConflict) WithPayload ¶
func (o *CreateMTOServiceItemConflict) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemConflict
WithPayload adds the payload to the create m t o service item conflict response
func (*CreateMTOServiceItemConflict) WriteResponse ¶
func (o *CreateMTOServiceItemConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateMTOServiceItemForbidden ¶
type CreateMTOServiceItemForbidden struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
CreateMTOServiceItemForbidden The request was denied.
swagger:response createMTOServiceItemForbidden
func NewCreateMTOServiceItemForbidden ¶
func NewCreateMTOServiceItemForbidden() *CreateMTOServiceItemForbidden
NewCreateMTOServiceItemForbidden creates CreateMTOServiceItemForbidden with default headers values
func (*CreateMTOServiceItemForbidden) SetPayload ¶
func (o *CreateMTOServiceItemForbidden) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create m t o service item forbidden response
func (*CreateMTOServiceItemForbidden) WithPayload ¶
func (o *CreateMTOServiceItemForbidden) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemForbidden
WithPayload adds the payload to the create m t o service item forbidden response
func (*CreateMTOServiceItemForbidden) WriteResponse ¶
func (o *CreateMTOServiceItemForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateMTOServiceItemHandler ¶
type CreateMTOServiceItemHandler interface {
Handle(CreateMTOServiceItemParams) middleware.Responder
}
CreateMTOServiceItemHandler interface for that can handle valid create m t o service item params
type CreateMTOServiceItemHandlerFunc ¶
type CreateMTOServiceItemHandlerFunc func(CreateMTOServiceItemParams) middleware.Responder
CreateMTOServiceItemHandlerFunc turns a function with the right signature into a create m t o service item handler
func (CreateMTOServiceItemHandlerFunc) Handle ¶
func (fn CreateMTOServiceItemHandlerFunc) Handle(params CreateMTOServiceItemParams) middleware.Responder
Handle executing the request and returning a response
type CreateMTOServiceItemInternalServerError ¶
type CreateMTOServiceItemInternalServerError struct { /* In: Body */ Payload *primemessages.Error `json:"body,omitempty"` }
CreateMTOServiceItemInternalServerError A server error occurred.
swagger:response createMTOServiceItemInternalServerError
func NewCreateMTOServiceItemInternalServerError ¶
func NewCreateMTOServiceItemInternalServerError() *CreateMTOServiceItemInternalServerError
NewCreateMTOServiceItemInternalServerError creates CreateMTOServiceItemInternalServerError with default headers values
func (*CreateMTOServiceItemInternalServerError) SetPayload ¶
func (o *CreateMTOServiceItemInternalServerError) SetPayload(payload *primemessages.Error)
SetPayload sets the payload to the create m t o service item internal server error response
func (*CreateMTOServiceItemInternalServerError) WithPayload ¶
func (o *CreateMTOServiceItemInternalServerError) WithPayload(payload *primemessages.Error) *CreateMTOServiceItemInternalServerError
WithPayload adds the payload to the create m t o service item internal server error response
func (*CreateMTOServiceItemInternalServerError) WriteResponse ¶
func (o *CreateMTOServiceItemInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateMTOServiceItemNotFound ¶
type CreateMTOServiceItemNotFound struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
CreateMTOServiceItemNotFound The requested resource wasn't found.
swagger:response createMTOServiceItemNotFound
func NewCreateMTOServiceItemNotFound ¶
func NewCreateMTOServiceItemNotFound() *CreateMTOServiceItemNotFound
NewCreateMTOServiceItemNotFound creates CreateMTOServiceItemNotFound with default headers values
func (*CreateMTOServiceItemNotFound) SetPayload ¶
func (o *CreateMTOServiceItemNotFound) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create m t o service item not found response
func (*CreateMTOServiceItemNotFound) WithPayload ¶
func (o *CreateMTOServiceItemNotFound) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemNotFound
WithPayload adds the payload to the create m t o service item not found response
func (*CreateMTOServiceItemNotFound) WriteResponse ¶
func (o *CreateMTOServiceItemNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateMTOServiceItemOK ¶
type CreateMTOServiceItemOK struct { /* In: Body */ Payload []primemessages.MTOServiceItem `json:"body,omitempty"` }
CreateMTOServiceItemOK Successfully created an MTO service item.
swagger:response createMTOServiceItemOK
func NewCreateMTOServiceItemOK ¶
func NewCreateMTOServiceItemOK() *CreateMTOServiceItemOK
NewCreateMTOServiceItemOK creates CreateMTOServiceItemOK with default headers values
func (*CreateMTOServiceItemOK) SetPayload ¶
func (o *CreateMTOServiceItemOK) SetPayload(payload []primemessages.MTOServiceItem)
SetPayload sets the payload to the create m t o service item o k response
func (*CreateMTOServiceItemOK) WithPayload ¶
func (o *CreateMTOServiceItemOK) WithPayload(payload []primemessages.MTOServiceItem) *CreateMTOServiceItemOK
WithPayload adds the payload to the create m t o service item o k response
func (*CreateMTOServiceItemOK) WriteResponse ¶
func (o *CreateMTOServiceItemOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateMTOServiceItemParams ¶
type CreateMTOServiceItemParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /* In: body */ Body primemessages.MTOServiceItem }
CreateMTOServiceItemParams contains all the bound params for the create m t o service item operation typically these are obtained from a http.Request
swagger:parameters createMTOServiceItem
func NewCreateMTOServiceItemParams ¶
func NewCreateMTOServiceItemParams() CreateMTOServiceItemParams
NewCreateMTOServiceItemParams creates a new CreateMTOServiceItemParams object
There are no default values defined in the spec.
func (*CreateMTOServiceItemParams) BindRequest ¶
func (o *CreateMTOServiceItemParams) 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 NewCreateMTOServiceItemParams() beforehand.
type CreateMTOServiceItemURL ¶
type CreateMTOServiceItemURL struct {
// contains filtered or unexported fields
}
CreateMTOServiceItemURL generates an URL for the create m t o service item operation
func (*CreateMTOServiceItemURL) Build ¶
func (o *CreateMTOServiceItemURL) Build() (*url.URL, error)
Build a url path and query string
func (*CreateMTOServiceItemURL) BuildFull ¶
func (o *CreateMTOServiceItemURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*CreateMTOServiceItemURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*CreateMTOServiceItemURL) SetBasePath ¶
func (o *CreateMTOServiceItemURL) 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 (*CreateMTOServiceItemURL) String ¶
func (o *CreateMTOServiceItemURL) String() string
String returns the string representation of the path with query string
func (*CreateMTOServiceItemURL) StringFull ¶
func (o *CreateMTOServiceItemURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*CreateMTOServiceItemURL) WithBasePath ¶
func (o *CreateMTOServiceItemURL) WithBasePath(bp string) *CreateMTOServiceItemURL
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 CreateMTOServiceItemUnauthorized ¶
type CreateMTOServiceItemUnauthorized struct { primemessages.ClientError `json:"body,omitempty"` }Payload *
CreateMTOServiceItemUnauthorized The request was denied.
swagger:response createMTOServiceItemUnauthorized
func NewCreateMTOServiceItemUnauthorized ¶
func NewCreateMTOServiceItemUnauthorized() *CreateMTOServiceItemUnauthorized
NewCreateMTOServiceItemUnauthorized creates CreateMTOServiceItemUnauthorized with default headers values
func (*CreateMTOServiceItemUnauthorized) SetPayload ¶
func (o *CreateMTOServiceItemUnauthorized) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create m t o service item unauthorized response
func (*CreateMTOServiceItemUnauthorized) WithPayload ¶
func (o *CreateMTOServiceItemUnauthorized) WithPayload(payload *primemessages.ClientError) *CreateMTOServiceItemUnauthorized
WithPayload adds the payload to the create m t o service item unauthorized response
func (*CreateMTOServiceItemUnauthorized) WriteResponse ¶
func (o *CreateMTOServiceItemUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateMTOServiceItemUnprocessableEntity ¶
type CreateMTOServiceItemUnprocessableEntity struct { /* In: Body */ Payload *primemessages.ValidationError `json:"body,omitempty"` }
CreateMTOServiceItemUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.
swagger:response createMTOServiceItemUnprocessableEntity
func NewCreateMTOServiceItemUnprocessableEntity ¶
func NewCreateMTOServiceItemUnprocessableEntity() *CreateMTOServiceItemUnprocessableEntity
NewCreateMTOServiceItemUnprocessableEntity creates CreateMTOServiceItemUnprocessableEntity with default headers values
func (*CreateMTOServiceItemUnprocessableEntity) SetPayload ¶
func (o *CreateMTOServiceItemUnprocessableEntity) SetPayload(payload *primemessages.ValidationError)
SetPayload sets the payload to the create m t o service item unprocessable entity response
func (*CreateMTOServiceItemUnprocessableEntity) WithPayload ¶
func (o *CreateMTOServiceItemUnprocessableEntity) WithPayload(payload *primemessages.ValidationError) *CreateMTOServiceItemUnprocessableEntity
WithPayload adds the payload to the create m t o service item unprocessable entity response
func (*CreateMTOServiceItemUnprocessableEntity) WriteResponse ¶
func (o *CreateMTOServiceItemUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceRequestDocumentUpload ¶
type CreateServiceRequestDocumentUpload struct { Context *middleware.Context Handler CreateServiceRequestDocumentUploadHandler }
CreateServiceRequestDocumentUpload swagger:route POST /mto-service-items/{mtoServiceItemID}/uploads mtoServiceItem createServiceRequestDocumentUpload
createServiceRequestDocumentUpload
### Functionality
This endpoint **uploads** a Service Request document for a ServiceItem.
The ServiceItem should already exist.
ServiceItems are created with the [createMTOServiceItem](#operation/createMTOServiceItem) endpoint.
func NewCreateServiceRequestDocumentUpload ¶
func NewCreateServiceRequestDocumentUpload(ctx *middleware.Context, handler CreateServiceRequestDocumentUploadHandler) *CreateServiceRequestDocumentUpload
NewCreateServiceRequestDocumentUpload creates a new http.Handler for the create service request document upload operation
func (*CreateServiceRequestDocumentUpload) ServeHTTP ¶
func (o *CreateServiceRequestDocumentUpload) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type CreateServiceRequestDocumentUploadBadRequest ¶
type CreateServiceRequestDocumentUploadBadRequest struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
CreateServiceRequestDocumentUploadBadRequest The request payload is invalid.
swagger:response createServiceRequestDocumentUploadBadRequest
func NewCreateServiceRequestDocumentUploadBadRequest ¶
func NewCreateServiceRequestDocumentUploadBadRequest() *CreateServiceRequestDocumentUploadBadRequest
NewCreateServiceRequestDocumentUploadBadRequest creates CreateServiceRequestDocumentUploadBadRequest with default headers values
func (*CreateServiceRequestDocumentUploadBadRequest) SetPayload ¶
func (o *CreateServiceRequestDocumentUploadBadRequest) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create service request document upload bad request response
func (*CreateServiceRequestDocumentUploadBadRequest) WithPayload ¶
func (o *CreateServiceRequestDocumentUploadBadRequest) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadBadRequest
WithPayload adds the payload to the create service request document upload bad request response
func (*CreateServiceRequestDocumentUploadBadRequest) WriteResponse ¶
func (o *CreateServiceRequestDocumentUploadBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceRequestDocumentUploadCreated ¶
type CreateServiceRequestDocumentUploadCreated struct { /* In: Body */ Payload *primemessages.UploadWithOmissions `json:"body,omitempty"` }
CreateServiceRequestDocumentUploadCreated Successfully created upload of digital file.
swagger:response createServiceRequestDocumentUploadCreated
func NewCreateServiceRequestDocumentUploadCreated ¶
func NewCreateServiceRequestDocumentUploadCreated() *CreateServiceRequestDocumentUploadCreated
NewCreateServiceRequestDocumentUploadCreated creates CreateServiceRequestDocumentUploadCreated with default headers values
func (*CreateServiceRequestDocumentUploadCreated) SetPayload ¶
func (o *CreateServiceRequestDocumentUploadCreated) SetPayload(payload *primemessages.UploadWithOmissions)
SetPayload sets the payload to the create service request document upload created response
func (*CreateServiceRequestDocumentUploadCreated) WithPayload ¶
func (o *CreateServiceRequestDocumentUploadCreated) WithPayload(payload *primemessages.UploadWithOmissions) *CreateServiceRequestDocumentUploadCreated
WithPayload adds the payload to the create service request document upload created response
func (*CreateServiceRequestDocumentUploadCreated) WriteResponse ¶
func (o *CreateServiceRequestDocumentUploadCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceRequestDocumentUploadForbidden ¶
type CreateServiceRequestDocumentUploadForbidden struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
CreateServiceRequestDocumentUploadForbidden The request was denied.
swagger:response createServiceRequestDocumentUploadForbidden
func NewCreateServiceRequestDocumentUploadForbidden ¶
func NewCreateServiceRequestDocumentUploadForbidden() *CreateServiceRequestDocumentUploadForbidden
NewCreateServiceRequestDocumentUploadForbidden creates CreateServiceRequestDocumentUploadForbidden with default headers values
func (*CreateServiceRequestDocumentUploadForbidden) SetPayload ¶
func (o *CreateServiceRequestDocumentUploadForbidden) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create service request document upload forbidden response
func (*CreateServiceRequestDocumentUploadForbidden) WithPayload ¶
func (o *CreateServiceRequestDocumentUploadForbidden) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadForbidden
WithPayload adds the payload to the create service request document upload forbidden response
func (*CreateServiceRequestDocumentUploadForbidden) WriteResponse ¶
func (o *CreateServiceRequestDocumentUploadForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceRequestDocumentUploadHandler ¶
type CreateServiceRequestDocumentUploadHandler interface {
Handle(CreateServiceRequestDocumentUploadParams) middleware.Responder
}
CreateServiceRequestDocumentUploadHandler interface for that can handle valid create service request document upload params
type CreateServiceRequestDocumentUploadHandlerFunc ¶
type CreateServiceRequestDocumentUploadHandlerFunc func(CreateServiceRequestDocumentUploadParams) middleware.Responder
CreateServiceRequestDocumentUploadHandlerFunc turns a function with the right signature into a create service request document upload handler
func (CreateServiceRequestDocumentUploadHandlerFunc) Handle ¶
func (fn CreateServiceRequestDocumentUploadHandlerFunc) Handle(params CreateServiceRequestDocumentUploadParams) middleware.Responder
Handle executing the request and returning a response
type CreateServiceRequestDocumentUploadInternalServerError ¶
type CreateServiceRequestDocumentUploadInternalServerError struct { /* In: Body */ Payload *primemessages.Error `json:"body,omitempty"` }
CreateServiceRequestDocumentUploadInternalServerError A server error occurred.
swagger:response createServiceRequestDocumentUploadInternalServerError
func NewCreateServiceRequestDocumentUploadInternalServerError ¶
func NewCreateServiceRequestDocumentUploadInternalServerError() *CreateServiceRequestDocumentUploadInternalServerError
NewCreateServiceRequestDocumentUploadInternalServerError creates CreateServiceRequestDocumentUploadInternalServerError with default headers values
func (*CreateServiceRequestDocumentUploadInternalServerError) SetPayload ¶
func (o *CreateServiceRequestDocumentUploadInternalServerError) SetPayload(payload *primemessages.Error)
SetPayload sets the payload to the create service request document upload internal server error response
func (*CreateServiceRequestDocumentUploadInternalServerError) WithPayload ¶
func (o *CreateServiceRequestDocumentUploadInternalServerError) WithPayload(payload *primemessages.Error) *CreateServiceRequestDocumentUploadInternalServerError
WithPayload adds the payload to the create service request document upload internal server error response
func (*CreateServiceRequestDocumentUploadInternalServerError) WriteResponse ¶
func (o *CreateServiceRequestDocumentUploadInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceRequestDocumentUploadNotFound ¶
type CreateServiceRequestDocumentUploadNotFound struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
CreateServiceRequestDocumentUploadNotFound The requested resource wasn't found.
swagger:response createServiceRequestDocumentUploadNotFound
func NewCreateServiceRequestDocumentUploadNotFound ¶
func NewCreateServiceRequestDocumentUploadNotFound() *CreateServiceRequestDocumentUploadNotFound
NewCreateServiceRequestDocumentUploadNotFound creates CreateServiceRequestDocumentUploadNotFound with default headers values
func (*CreateServiceRequestDocumentUploadNotFound) SetPayload ¶
func (o *CreateServiceRequestDocumentUploadNotFound) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create service request document upload not found response
func (*CreateServiceRequestDocumentUploadNotFound) WithPayload ¶
func (o *CreateServiceRequestDocumentUploadNotFound) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadNotFound
WithPayload adds the payload to the create service request document upload not found response
func (*CreateServiceRequestDocumentUploadNotFound) WriteResponse ¶
func (o *CreateServiceRequestDocumentUploadNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceRequestDocumentUploadParams ¶
type CreateServiceRequestDocumentUploadParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*The file to upload. Required: true In: formData */ File io.ReadCloser /*UUID of the service item to use. Required: true In: path */ MtoServiceItemID string }
CreateServiceRequestDocumentUploadParams contains all the bound params for the create service request document upload operation typically these are obtained from a http.Request
swagger:parameters createServiceRequestDocumentUpload
func NewCreateServiceRequestDocumentUploadParams ¶
func NewCreateServiceRequestDocumentUploadParams() CreateServiceRequestDocumentUploadParams
NewCreateServiceRequestDocumentUploadParams creates a new CreateServiceRequestDocumentUploadParams object
There are no default values defined in the spec.
func (*CreateServiceRequestDocumentUploadParams) BindRequest ¶
func (o *CreateServiceRequestDocumentUploadParams) 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 NewCreateServiceRequestDocumentUploadParams() beforehand.
type CreateServiceRequestDocumentUploadURL ¶
type CreateServiceRequestDocumentUploadURL struct { MtoServiceItemID string // contains filtered or unexported fields }
CreateServiceRequestDocumentUploadURL generates an URL for the create service request document upload operation
func (*CreateServiceRequestDocumentUploadURL) Build ¶
func (o *CreateServiceRequestDocumentUploadURL) Build() (*url.URL, error)
Build a url path and query string
func (*CreateServiceRequestDocumentUploadURL) BuildFull ¶
func (o *CreateServiceRequestDocumentUploadURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*CreateServiceRequestDocumentUploadURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*CreateServiceRequestDocumentUploadURL) SetBasePath ¶
func (o *CreateServiceRequestDocumentUploadURL) 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 (*CreateServiceRequestDocumentUploadURL) String ¶
func (o *CreateServiceRequestDocumentUploadURL) String() string
String returns the string representation of the path with query string
func (*CreateServiceRequestDocumentUploadURL) StringFull ¶
func (o *CreateServiceRequestDocumentUploadURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*CreateServiceRequestDocumentUploadURL) WithBasePath ¶
func (o *CreateServiceRequestDocumentUploadURL) WithBasePath(bp string) *CreateServiceRequestDocumentUploadURL
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 CreateServiceRequestDocumentUploadUnauthorized ¶
type CreateServiceRequestDocumentUploadUnauthorized struct { primemessages.ClientError `json:"body,omitempty"` }Payload *
CreateServiceRequestDocumentUploadUnauthorized The request was denied.
swagger:response createServiceRequestDocumentUploadUnauthorized
func NewCreateServiceRequestDocumentUploadUnauthorized ¶
func NewCreateServiceRequestDocumentUploadUnauthorized() *CreateServiceRequestDocumentUploadUnauthorized
NewCreateServiceRequestDocumentUploadUnauthorized creates CreateServiceRequestDocumentUploadUnauthorized with default headers values
func (*CreateServiceRequestDocumentUploadUnauthorized) SetPayload ¶
func (o *CreateServiceRequestDocumentUploadUnauthorized) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the create service request document upload unauthorized response
func (*CreateServiceRequestDocumentUploadUnauthorized) WithPayload ¶
func (o *CreateServiceRequestDocumentUploadUnauthorized) WithPayload(payload *primemessages.ClientError) *CreateServiceRequestDocumentUploadUnauthorized
WithPayload adds the payload to the create service request document upload unauthorized response
func (*CreateServiceRequestDocumentUploadUnauthorized) WriteResponse ¶
func (o *CreateServiceRequestDocumentUploadUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceRequestDocumentUploadUnprocessableEntity ¶
type CreateServiceRequestDocumentUploadUnprocessableEntity struct { /* In: Body */ Payload *primemessages.ValidationError `json:"body,omitempty"` }
CreateServiceRequestDocumentUploadUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.
swagger:response createServiceRequestDocumentUploadUnprocessableEntity
func NewCreateServiceRequestDocumentUploadUnprocessableEntity ¶
func NewCreateServiceRequestDocumentUploadUnprocessableEntity() *CreateServiceRequestDocumentUploadUnprocessableEntity
NewCreateServiceRequestDocumentUploadUnprocessableEntity creates CreateServiceRequestDocumentUploadUnprocessableEntity with default headers values
func (*CreateServiceRequestDocumentUploadUnprocessableEntity) SetPayload ¶
func (o *CreateServiceRequestDocumentUploadUnprocessableEntity) SetPayload(payload *primemessages.ValidationError)
SetPayload sets the payload to the create service request document upload unprocessable entity response
func (*CreateServiceRequestDocumentUploadUnprocessableEntity) WithPayload ¶
func (o *CreateServiceRequestDocumentUploadUnprocessableEntity) WithPayload(payload *primemessages.ValidationError) *CreateServiceRequestDocumentUploadUnprocessableEntity
WithPayload adds the payload to the create service request document upload unprocessable entity response
func (*CreateServiceRequestDocumentUploadUnprocessableEntity) WriteResponse ¶
func (o *CreateServiceRequestDocumentUploadUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItem ¶
type UpdateMTOServiceItem struct { Context *middleware.Context Handler UpdateMTOServiceItemHandler }
UpdateMTOServiceItem swagger:route PATCH /mto-service-items/{mtoServiceItemID} mtoServiceItem updateMTOServiceItem
updateMTOServiceItem
Updates MTOServiceItems after creation. Not all service items or fields may be updated, please see details below.
This endpoint supports different body definitions. In the modelType field below, select the modelType corresponding
to the service item you wish to update and the documentation will update with the new definition.
* Addresses: To update a destination service item's SIT destination final address, update the shipment destination address. For approved shipments, please use [updateShipmentDestinationAddress](#mtoShipment/updateShipmentDestinationAddress). For shipments not yet approved, please use [updateMTOShipmentAddress](#mtoShipment/updateMTOShipmentAddress).
To create a service item, please use [createMTOServiceItem](#mtoServiceItem/createMTOServiceItem)) endpoint.
func NewUpdateMTOServiceItem ¶
func NewUpdateMTOServiceItem(ctx *middleware.Context, handler UpdateMTOServiceItemHandler) *UpdateMTOServiceItem
NewUpdateMTOServiceItem creates a new http.Handler for the update m t o service item operation
func (*UpdateMTOServiceItem) ServeHTTP ¶
func (o *UpdateMTOServiceItem) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type UpdateMTOServiceItemBadRequest ¶
type UpdateMTOServiceItemBadRequest struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
UpdateMTOServiceItemBadRequest The request payload is invalid.
swagger:response updateMTOServiceItemBadRequest
func NewUpdateMTOServiceItemBadRequest ¶
func NewUpdateMTOServiceItemBadRequest() *UpdateMTOServiceItemBadRequest
NewUpdateMTOServiceItemBadRequest creates UpdateMTOServiceItemBadRequest with default headers values
func (*UpdateMTOServiceItemBadRequest) SetPayload ¶
func (o *UpdateMTOServiceItemBadRequest) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the update m t o service item bad request response
func (*UpdateMTOServiceItemBadRequest) WithPayload ¶
func (o *UpdateMTOServiceItemBadRequest) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemBadRequest
WithPayload adds the payload to the update m t o service item bad request response
func (*UpdateMTOServiceItemBadRequest) WriteResponse ¶
func (o *UpdateMTOServiceItemBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemConflict ¶
type UpdateMTOServiceItemConflict struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
UpdateMTOServiceItemConflict The request could not be processed because of conflict in the current state of the resource.
swagger:response updateMTOServiceItemConflict
func NewUpdateMTOServiceItemConflict ¶
func NewUpdateMTOServiceItemConflict() *UpdateMTOServiceItemConflict
NewUpdateMTOServiceItemConflict creates UpdateMTOServiceItemConflict with default headers values
func (*UpdateMTOServiceItemConflict) SetPayload ¶
func (o *UpdateMTOServiceItemConflict) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the update m t o service item conflict response
func (*UpdateMTOServiceItemConflict) WithPayload ¶
func (o *UpdateMTOServiceItemConflict) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemConflict
WithPayload adds the payload to the update m t o service item conflict response
func (*UpdateMTOServiceItemConflict) WriteResponse ¶
func (o *UpdateMTOServiceItemConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemForbidden ¶
type UpdateMTOServiceItemForbidden struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
UpdateMTOServiceItemForbidden The request was denied.
swagger:response updateMTOServiceItemForbidden
func NewUpdateMTOServiceItemForbidden ¶
func NewUpdateMTOServiceItemForbidden() *UpdateMTOServiceItemForbidden
NewUpdateMTOServiceItemForbidden creates UpdateMTOServiceItemForbidden with default headers values
func (*UpdateMTOServiceItemForbidden) SetPayload ¶
func (o *UpdateMTOServiceItemForbidden) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the update m t o service item forbidden response
func (*UpdateMTOServiceItemForbidden) WithPayload ¶
func (o *UpdateMTOServiceItemForbidden) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemForbidden
WithPayload adds the payload to the update m t o service item forbidden response
func (*UpdateMTOServiceItemForbidden) WriteResponse ¶
func (o *UpdateMTOServiceItemForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemHandler ¶
type UpdateMTOServiceItemHandler interface {
Handle(UpdateMTOServiceItemParams) middleware.Responder
}
UpdateMTOServiceItemHandler interface for that can handle valid update m t o service item params
type UpdateMTOServiceItemHandlerFunc ¶
type UpdateMTOServiceItemHandlerFunc func(UpdateMTOServiceItemParams) middleware.Responder
UpdateMTOServiceItemHandlerFunc turns a function with the right signature into a update m t o service item handler
func (UpdateMTOServiceItemHandlerFunc) Handle ¶
func (fn UpdateMTOServiceItemHandlerFunc) Handle(params UpdateMTOServiceItemParams) middleware.Responder
Handle executing the request and returning a response
type UpdateMTOServiceItemInternalServerError ¶
type UpdateMTOServiceItemInternalServerError struct { /* In: Body */ Payload *primemessages.Error `json:"body,omitempty"` }
UpdateMTOServiceItemInternalServerError A server error occurred.
swagger:response updateMTOServiceItemInternalServerError
func NewUpdateMTOServiceItemInternalServerError ¶
func NewUpdateMTOServiceItemInternalServerError() *UpdateMTOServiceItemInternalServerError
NewUpdateMTOServiceItemInternalServerError creates UpdateMTOServiceItemInternalServerError with default headers values
func (*UpdateMTOServiceItemInternalServerError) SetPayload ¶
func (o *UpdateMTOServiceItemInternalServerError) SetPayload(payload *primemessages.Error)
SetPayload sets the payload to the update m t o service item internal server error response
func (*UpdateMTOServiceItemInternalServerError) WithPayload ¶
func (o *UpdateMTOServiceItemInternalServerError) WithPayload(payload *primemessages.Error) *UpdateMTOServiceItemInternalServerError
WithPayload adds the payload to the update m t o service item internal server error response
func (*UpdateMTOServiceItemInternalServerError) WriteResponse ¶
func (o *UpdateMTOServiceItemInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemNotFound ¶
type UpdateMTOServiceItemNotFound struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
UpdateMTOServiceItemNotFound The requested resource wasn't found.
swagger:response updateMTOServiceItemNotFound
func NewUpdateMTOServiceItemNotFound ¶
func NewUpdateMTOServiceItemNotFound() *UpdateMTOServiceItemNotFound
NewUpdateMTOServiceItemNotFound creates UpdateMTOServiceItemNotFound with default headers values
func (*UpdateMTOServiceItemNotFound) SetPayload ¶
func (o *UpdateMTOServiceItemNotFound) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the update m t o service item not found response
func (*UpdateMTOServiceItemNotFound) WithPayload ¶
func (o *UpdateMTOServiceItemNotFound) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemNotFound
WithPayload adds the payload to the update m t o service item not found response
func (*UpdateMTOServiceItemNotFound) WriteResponse ¶
func (o *UpdateMTOServiceItemNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemOK ¶
type UpdateMTOServiceItemOK struct { /* In: Body */ Payload primemessages.MTOServiceItem `json:"body,omitempty"` }
UpdateMTOServiceItemOK Successfully updated the MTO service item.
swagger:response updateMTOServiceItemOK
func NewUpdateMTOServiceItemOK ¶
func NewUpdateMTOServiceItemOK() *UpdateMTOServiceItemOK
NewUpdateMTOServiceItemOK creates UpdateMTOServiceItemOK with default headers values
func (*UpdateMTOServiceItemOK) SetPayload ¶
func (o *UpdateMTOServiceItemOK) SetPayload(payload primemessages.MTOServiceItem)
SetPayload sets the payload to the update m t o service item o k response
func (*UpdateMTOServiceItemOK) WithPayload ¶
func (o *UpdateMTOServiceItemOK) WithPayload(payload primemessages.MTOServiceItem) *UpdateMTOServiceItemOK
WithPayload adds the payload to the update m t o service item o k response
func (*UpdateMTOServiceItemOK) WriteResponse ¶
func (o *UpdateMTOServiceItemOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemParams ¶
type UpdateMTOServiceItemParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*Optimistic locking is implemented via the `If-Match` header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a `412 Precondition Failed` error. Required: true In: header */ IfMatch string /* Required: true In: body */ Body primemessages.UpdateMTOServiceItem /*UUID of service item to update. Required: true In: path */ MtoServiceItemID string }
UpdateMTOServiceItemParams contains all the bound params for the update m t o service item operation typically these are obtained from a http.Request
swagger:parameters updateMTOServiceItem
func NewUpdateMTOServiceItemParams ¶
func NewUpdateMTOServiceItemParams() UpdateMTOServiceItemParams
NewUpdateMTOServiceItemParams creates a new UpdateMTOServiceItemParams object
There are no default values defined in the spec.
func (*UpdateMTOServiceItemParams) BindRequest ¶
func (o *UpdateMTOServiceItemParams) 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 NewUpdateMTOServiceItemParams() beforehand.
type UpdateMTOServiceItemPreconditionFailed ¶
type UpdateMTOServiceItemPreconditionFailed struct { /* In: Body */ Payload *primemessages.ClientError `json:"body,omitempty"` }
UpdateMTOServiceItemPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.
swagger:response updateMTOServiceItemPreconditionFailed
func NewUpdateMTOServiceItemPreconditionFailed ¶
func NewUpdateMTOServiceItemPreconditionFailed() *UpdateMTOServiceItemPreconditionFailed
NewUpdateMTOServiceItemPreconditionFailed creates UpdateMTOServiceItemPreconditionFailed with default headers values
func (*UpdateMTOServiceItemPreconditionFailed) SetPayload ¶
func (o *UpdateMTOServiceItemPreconditionFailed) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the update m t o service item precondition failed response
func (*UpdateMTOServiceItemPreconditionFailed) WithPayload ¶
func (o *UpdateMTOServiceItemPreconditionFailed) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemPreconditionFailed
WithPayload adds the payload to the update m t o service item precondition failed response
func (*UpdateMTOServiceItemPreconditionFailed) WriteResponse ¶
func (o *UpdateMTOServiceItemPreconditionFailed) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemURL ¶
type UpdateMTOServiceItemURL struct { MtoServiceItemID string // contains filtered or unexported fields }
UpdateMTOServiceItemURL generates an URL for the update m t o service item operation
func (*UpdateMTOServiceItemURL) Build ¶
func (o *UpdateMTOServiceItemURL) Build() (*url.URL, error)
Build a url path and query string
func (*UpdateMTOServiceItemURL) BuildFull ¶
func (o *UpdateMTOServiceItemURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*UpdateMTOServiceItemURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*UpdateMTOServiceItemURL) SetBasePath ¶
func (o *UpdateMTOServiceItemURL) 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 (*UpdateMTOServiceItemURL) String ¶
func (o *UpdateMTOServiceItemURL) String() string
String returns the string representation of the path with query string
func (*UpdateMTOServiceItemURL) StringFull ¶
func (o *UpdateMTOServiceItemURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*UpdateMTOServiceItemURL) WithBasePath ¶
func (o *UpdateMTOServiceItemURL) WithBasePath(bp string) *UpdateMTOServiceItemURL
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 UpdateMTOServiceItemUnauthorized ¶
type UpdateMTOServiceItemUnauthorized struct { primemessages.ClientError `json:"body,omitempty"` }Payload *
UpdateMTOServiceItemUnauthorized The request was denied.
swagger:response updateMTOServiceItemUnauthorized
func NewUpdateMTOServiceItemUnauthorized ¶
func NewUpdateMTOServiceItemUnauthorized() *UpdateMTOServiceItemUnauthorized
NewUpdateMTOServiceItemUnauthorized creates UpdateMTOServiceItemUnauthorized with default headers values
func (*UpdateMTOServiceItemUnauthorized) SetPayload ¶
func (o *UpdateMTOServiceItemUnauthorized) SetPayload(payload *primemessages.ClientError)
SetPayload sets the payload to the update m t o service item unauthorized response
func (*UpdateMTOServiceItemUnauthorized) WithPayload ¶
func (o *UpdateMTOServiceItemUnauthorized) WithPayload(payload *primemessages.ClientError) *UpdateMTOServiceItemUnauthorized
WithPayload adds the payload to the update m t o service item unauthorized response
func (*UpdateMTOServiceItemUnauthorized) WriteResponse ¶
func (o *UpdateMTOServiceItemUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOServiceItemUnprocessableEntity ¶
type UpdateMTOServiceItemUnprocessableEntity struct { /* In: Body */ Payload *primemessages.ValidationError `json:"body,omitempty"` }
UpdateMTOServiceItemUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.
swagger:response updateMTOServiceItemUnprocessableEntity
func NewUpdateMTOServiceItemUnprocessableEntity ¶
func NewUpdateMTOServiceItemUnprocessableEntity() *UpdateMTOServiceItemUnprocessableEntity
NewUpdateMTOServiceItemUnprocessableEntity creates UpdateMTOServiceItemUnprocessableEntity with default headers values
func (*UpdateMTOServiceItemUnprocessableEntity) SetPayload ¶
func (o *UpdateMTOServiceItemUnprocessableEntity) SetPayload(payload *primemessages.ValidationError)
SetPayload sets the payload to the update m t o service item unprocessable entity response
func (*UpdateMTOServiceItemUnprocessableEntity) WithPayload ¶
func (o *UpdateMTOServiceItemUnprocessableEntity) WithPayload(payload *primemessages.ValidationError) *UpdateMTOServiceItemUnprocessableEntity
WithPayload adds the payload to the update m t o service item unprocessable entity response
func (*UpdateMTOServiceItemUnprocessableEntity) WriteResponse ¶
func (o *UpdateMTOServiceItemUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
Source Files ¶
- create_m_t_o_service_item.go
- create_m_t_o_service_item_parameters.go
- create_m_t_o_service_item_responses.go
- create_m_t_o_service_item_urlbuilder.go
- create_service_request_document_upload.go
- create_service_request_document_upload_parameters.go
- create_service_request_document_upload_responses.go
- create_service_request_document_upload_urlbuilder.go
- update_m_t_o_service_item.go
- update_m_t_o_service_item_parameters.go
- update_m_t_o_service_item_responses.go
- update_m_t_o_service_item_urlbuilder.go