package
2.85.0+incompatible
Repository: https://github.com/transcom/mymove.git
Documentation: pkg.go.dev
# Functions
NewGetLocationByZipCityState creates a new http.Handler for the get location by zip city state operation.
NewGetLocationByZipCityStateBadRequest creates GetLocationByZipCityStateBadRequest with default headers values.
NewGetLocationByZipCityStateForbidden creates GetLocationByZipCityStateForbidden with default headers values.
NewGetLocationByZipCityStateInternalServerError creates GetLocationByZipCityStateInternalServerError with default headers values.
NewGetLocationByZipCityStateNotFound creates GetLocationByZipCityStateNotFound with default headers values.
NewGetLocationByZipCityStateOK creates GetLocationByZipCityStateOK with default headers values.
NewGetLocationByZipCityStateParams creates a new GetLocationByZipCityStateParams object
There are no default values defined in the spec.
NewShowAddress creates a new http.Handler for the show address operation.
NewShowAddressBadRequest creates ShowAddressBadRequest with default headers values.
NewShowAddressForbidden creates ShowAddressForbidden with default headers values.
NewShowAddressInternalServerError creates ShowAddressInternalServerError with default headers values.
NewShowAddressNotFound creates ShowAddressNotFound with default headers values.
NewShowAddressOK creates ShowAddressOK with default headers values.
NewShowAddressParams creates a new ShowAddressParams object
There are no default values defined in the spec.
# Constants
GetLocationByZipCityStateBadRequestCode is the HTTP code returned for type GetLocationByZipCityStateBadRequest.
GetLocationByZipCityStateForbiddenCode is the HTTP code returned for type GetLocationByZipCityStateForbidden.
GetLocationByZipCityStateInternalServerErrorCode is the HTTP code returned for type GetLocationByZipCityStateInternalServerError.
GetLocationByZipCityStateNotFoundCode is the HTTP code returned for type GetLocationByZipCityStateNotFound.
GetLocationByZipCityStateOKCode is the HTTP code returned for type GetLocationByZipCityStateOK.
ShowAddressBadRequestCode is the HTTP code returned for type ShowAddressBadRequest.
ShowAddressForbiddenCode is the HTTP code returned for type ShowAddressForbidden.
ShowAddressInternalServerErrorCode is the HTTP code returned for type ShowAddressInternalServerError.
ShowAddressNotFoundCode is the HTTP code returned for type ShowAddressNotFound.
ShowAddressOKCode is the HTTP code returned for type ShowAddressOK.
# Structs
GetLocationByZipCityState swagger:route GET /addresses/zip-city-lookup/{search} addresses getLocationByZipCityState
Returns city, state, postal code, and county associated with the specified full/partial postal code or city state string
Find by API using full/partial postal code or city name that returns an us_post_region_cities json object containing city, state, county and postal code.
GetLocationByZipCityStateBadRequest The request payload is invalid.
GetLocationByZipCityStateForbidden The request was denied.
GetLocationByZipCityStateInternalServerError A server error occurred.
GetLocationByZipCityStateNotFound The requested resource wasn't found.
GetLocationByZipCityStateOK the requested list of city, state, county, and postal code matches
swagger:response getLocationByZipCityStateOK
*/.
GetLocationByZipCityStateParams contains all the bound params for the get location by zip city state operation typically these are obtained from a http.Request
swagger:parameters getLocationByZipCityState.
GetLocationByZipCityStateURL generates an URL for the get location by zip city state operation.
ShowAddress swagger:route GET /addresses/{addressId} addresses showAddress
# Returns an address
Find by API using address ID that returns an address json object containing address 1, address 2, address 3, city and postal code.
ShowAddressBadRequest invalid request
swagger:response showAddressBadRequest
*/.
ShowAddressForbidden not authorized
swagger:response showAddressForbidden
*/.
ShowAddressInternalServerError server error
swagger:response showAddressInternalServerError
*/.
ShowAddressNotFound not found
swagger:response showAddressNotFound
*/.
ShowAddressOK the requested address
swagger:response showAddressOK
*/.
ShowAddressParams contains all the bound params for the show address operation typically these are obtained from a http.Request
swagger:parameters showAddress.
ShowAddressURL generates an URL for the show address operation.
# Interfaces
GetLocationByZipCityStateHandler interface for that can handle valid get location by zip city state params.
ShowAddressHandler interface for that can handle valid show address params.
# Type aliases
GetLocationByZipCityStateHandlerFunc turns a function with the right signature into a get location by zip city state handler.
ShowAddressHandlerFunc turns a function with the right signature into a show address handler.